Mixins / foldkit-mixins-ui

FrameView

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.

Members

FrameView.title

property · packages/mixins-ui/src/frame.ts:31

readonly title?: string | undefined

FrameView.headingLevel

property · packages/mixins-ui/src/frame.ts:33

readonly headingLevel?: 2 | 3 | 4 | 5 | 6 | undefined

The level of the heading that holds the title, for the page's outline. Default 3.

FrameView.description

property · packages/mixins-ui/src/frame.ts:34

readonly description?: string | undefined

FrameView.action

property · packages/mixins-ui/src/frame.ts:36

readonly action?: Html | undefined

Controls at the end of the header.

FrameView.panels

property · packages/mixins-ui/src/frame.ts:38

readonly panels: ReadonlyArray<Html>

What sits in the tray, each in a panel of its own.

property · packages/mixins-ui/src/frame.ts:40

readonly footer?: Html | undefined

A note under the panels, drawn on the tray.

FrameView.style

property · packages/mixins-ui/src/frame.ts:42

readonly style?: NamedStyle<typeof FrameSlots> | undefined

A style of FrameSlots, for the frame's look.

FrameView.mixins

property · packages/mixins-ui/src/frame.ts:44

readonly mixins?: MixinList<Message> | undefined

Mixins beside the style.