Mixins / foldkit-mixins-ui

BannerView

interface · packages/mixins-ui/src/banner.ts:33

interface BannerView<Message> {
  readonly label: string
  readonly message: string
  readonly icon?: Html | undefined
  readonly action?: BannerAction<NoInfer<Message>> | undefined
  readonly onDismiss?: NoInfer<Message> | undefined
  readonly dismissLabel?: string | undefined
  readonly style?: NamedStyle<typeof BannerSlots> | undefined
  readonly mixins?: MixinList<Message> | undefined
}

Members

BannerView.label

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

readonly label: string

The region's name, such as "Announcement" or "Maintenance notice".

BannerView.message

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

readonly message: string

BannerView.icon

property · packages/mixins-ui/src/banner.ts:37

readonly icon?: Html | undefined

BannerView.action

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

readonly action?: BannerAction<NoInfer<Message>> | undefined

BannerView.onDismiss

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

readonly onDismiss?: NoInfer<Message> | undefined

Draws a dismiss button that sends this.

BannerView.dismissLabel

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

readonly dismissLabel?: string | undefined

The dismiss button's name; default Dismiss <label>.

BannerView.style

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

readonly style?: NamedStyle<typeof BannerSlots> | undefined

A style of BannerSlots, for the banner's look.

BannerView.mixins

property · packages/mixins-ui/src/banner.ts:46

readonly mixins?: MixinList<Message> | undefined

Mixins beside the style.