BuilderLike.name
property · packages/mixins-builder/src/index.ts:236
readonly name: stringComposition / foldkit-mixins-builder
interface · packages/mixins-builder/src/index.ts:235
interface BuilderLike {
readonly name: string
readonly catalog: Catalog
readonly renderer: Renderer<any, never>
readonly offered: ReadonlyArray<string>
readonly document: (model: Pick<Model, 'page'>) => Document
placeFor(
document: Document,
selected: Option.Option<NodeId>,
block: string,
): Option.Option<Position>
readonly patternAt: (
document: Document,
selected: Option.Option<NodeId>,
pattern: string,
) => Option.Option<Position>
readonly commands: ReadonlyArray<BuilderCommand>
readonly inspecting: (
model: Pick<Model, 'page' | 'selected' | 'inspector'>,
) => Option.Option<Inspecting>
readonly keyCommand: (
model: Pick<Model, 'page' | 'selected' | 'editing'>,
key: string,
modifiers: KeyboardModifiers,
) => Option.Option<Message>
readonly keyPressed: (
model: Pick<Model, 'editing'>,
key: string,
modifiers: KeyboardModifiers,
) => Option.Option<Message>
}What BuilderView.define needs of a Builder: what Builder.make returns has all of it.
BuilderLike.nameproperty · packages/mixins-builder/src/index.ts:236
readonly name: stringBuilderLike.catalogproperty · packages/mixins-builder/src/index.ts:237
readonly catalog: CatalogBuilderLike.rendererproperty · packages/mixins-builder/src/index.ts:239
readonly renderer: Renderer<any, never>BuilderLike.offeredproperty · packages/mixins-builder/src/index.ts:240
readonly offered: ReadonlyArray<string>BuilderLike.documentproperty · packages/mixins-builder/src/index.ts:241
readonly document: (model: Pick<Model, 'page'>) => DocumentBuilderLike.placeFormethod · packages/mixins-builder/src/index.ts:243
placeFor(
document: Document,
selected: Option.Option<NodeId>,
block: string,
): Option.Option<Position>BuilderLike.patternAtproperty · packages/mixins-builder/src/index.ts:249
readonly patternAt: (
document: Document,
selected: Option.Option<NodeId>,
pattern: string,
) => Option.Option<Position>Where a pattern goes, as placeFor places its root's Block.
BuilderLike.commandsproperty · packages/mixins-builder/src/index.ts:255
readonly commands: ReadonlyArray<BuilderCommand>What a key, a node's action and the toolbar run.
BuilderLike.inspectingproperty · packages/mixins-builder/src/index.ts:256
readonly inspecting: (
model: Pick<Model, 'page' | 'selected' | 'inspector'>,
) => Option.Option<Inspecting>BuilderLike.keyCommandproperty · packages/mixins-builder/src/index.ts:259
readonly keyCommand: (
model: Pick<Model, 'page' | 'selected' | 'editing'>,
key: string,
modifiers: KeyboardModifiers,
) => Option.Option<Message>BuilderLike.keyPressedproperty · packages/mixins-builder/src/index.ts:264
readonly keyPressed: (
model: Pick<Model, 'editing'>,
key: string,
modifiers: KeyboardModifiers,
) => Option.Option<Message>