Mixins / foldkit-mixins-ui

EmptyView

interface · packages/mixins-ui/src/empty.ts:25

interface EmptyView<Message = never> {
  readonly title: string
  readonly description?: string | undefined
  readonly icon?: Html | undefined
  readonly action?: Html | undefined
  readonly style?: NamedStyle<typeof EmptySlots> | undefined
  readonly mixins?: MixinList<Message> | undefined
}

An empty state in one call: the title it always has, the regions it earns, a style for its slots, and mixins beside the style. No upstream component stands behind it.

Members

EmptyView.title

property · packages/mixins-ui/src/empty.ts:26

readonly title: string

EmptyView.description

property · packages/mixins-ui/src/empty.ts:27

readonly description?: string | undefined

EmptyView.icon

property · packages/mixins-ui/src/empty.ts:29

readonly icon?: Html | undefined

An icon, or a larger illustration, above the title; hidden from a screen reader.

EmptyView.action

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

readonly action?: Html | undefined

The way forward: a button or two, a link, a search field.

EmptyView.style

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

readonly style?: NamedStyle<typeof EmptySlots> | undefined

A style of EmptySlots, for the empty state's look.

EmptyView.mixins

property · packages/mixins-ui/src/empty.ts:35

readonly mixins?: MixinList<Message> | undefined

Mixins beside the style.