Composition / foldkit-mixins-builder

BuilderViewInputs

interface · packages/mixins-builder/src/index.ts:470

interface BuilderViewInputs {
  readonly platform?: Platform | undefined
  readonly data?: Readonly<Record<string, unknown>> | undefined
  readonly options?:
    Readonly<Record<string, ReadonlyArray<BuilderOption>>> | undefined
  readonly words?: Partial<BuilderWords> | undefined
}

What the drawn Builder is given beside its Model, by the page's parent: the application's, never the Builder's to keep.

Members

BuilderViewInputs.platform

property · packages/mixins-builder/src/index.ts:472

readonly platform?: Platform | undefined

The platform the author is on, so keys are named as theirs are (⌘ on a Mac). Default: other.

BuilderViewInputs.data

property · packages/mixins-builder/src/index.ts:477

readonly data?: Readonly<Record<string, unknown>> | undefined

Each node's read, by node id, as a published page is drawn with it: the page's Query and Surface Blocks' values, so the canvas shows their rows.

BuilderViewInputs.options

property · packages/mixins-builder/src/index.ts:482

readonly options?:
  Readonly<Record<string, ReadonlyArray<BuilderOption>>> | undefined

The choices of a relation prop's picker, keyed 'Block.prop': the rows the application loaded for it, as a form's options are.

BuilderViewInputs.words

property · packages/mixins-builder/src/index.ts:484

readonly words?: Partial<BuilderWords> | undefined

The editor's words, over the English ones (builderWords).