Mixins / foldkit-mixins-ui

FigureView

interface · packages/mixins-ui/src/figure.ts:17

interface FigureView<Message = never> {
  readonly content: Html
  readonly caption?: Html | string | undefined
  readonly style?: NamedStyle<typeof FigureSlots> | undefined
  readonly mixins?: MixinList<Message> | undefined
}

A figure in one call: what it shows (an Image.view, a chart, a code block) and its caption.

Members

FigureView.content

property · packages/mixins-ui/src/figure.ts:18

readonly content: Html

FigureView.caption

property · packages/mixins-ui/src/figure.ts:20

readonly caption?: Html | string | undefined

Words under the content; without one, the figure is the content alone.

FigureView.style

property · packages/mixins-ui/src/figure.ts:22

readonly style?: NamedStyle<typeof FigureSlots> | undefined

A style of FigureSlots, for the figure's look.

FigureView.mixins

property · packages/mixins-ui/src/figure.ts:24

readonly mixins?: MixinList<Message> | undefined

Mixins beside the style.