FrameView.title
property · packages/mixins-ui/src/frame.ts:31
readonly title?: string | undefinedMixins / foldkit-mixins-ui
interface · packages/mixins-ui/src/frame.ts:30
interface FrameView<Message = never> {
readonly title?: string | undefined
readonly headingLevel?: 2 | 3 | 4 | 5 | 6 | undefined
readonly description?: string | undefined
readonly action?: Html | undefined
readonly panels: ReadonlyArray<Html>
readonly footer?: Html | undefined
readonly style?: NamedStyle<typeof FrameSlots> | undefined
readonly mixins?: MixinList<Message> | undefined
}A frame in one call: the regions it has, the panels in it, a style for its slots, and mixins beside the style. No upstream component stands behind it.
FrameView.titleproperty · packages/mixins-ui/src/frame.ts:31
readonly title?: string | undefinedFrameView.headingLevelproperty · packages/mixins-ui/src/frame.ts:33
readonly headingLevel?: 2 | 3 | 4 | 5 | 6 | undefinedThe level of the heading that holds the title, for the page's outline. Default 3.
FrameView.descriptionproperty · packages/mixins-ui/src/frame.ts:34
readonly description?: string | undefinedFrameView.actionproperty · packages/mixins-ui/src/frame.ts:36
readonly action?: Html | undefinedControls at the end of the header.
FrameView.panelsproperty · packages/mixins-ui/src/frame.ts:38
readonly panels: ReadonlyArray<Html>What sits in the tray, each in a panel of its own.
FrameView.footerproperty · packages/mixins-ui/src/frame.ts:40
readonly footer?: Html | undefinedA note under the panels, drawn on the tray.
FrameView.styleproperty · packages/mixins-ui/src/frame.ts:42
readonly style?: NamedStyle<typeof FrameSlots> | undefinedA style of FrameSlots, for the frame's look.
FrameView.mixinsproperty · packages/mixins-ui/src/frame.ts:44
readonly mixins?: MixinList<Message> | undefinedMixins beside the style.