Mixins / foldkit-mixins-ui

BannerAlert

interface · packages/mixins-ui/src/alert.ts:67

interface BannerAlert<Message> extends AlertContent<Message> {
  readonly layout: 'banner'
  readonly label: string
}

A full-width strip across a page or a section, there when it loads: a region landmark (a section named by label), not a live region, which would say nothing on load. The landmark lets a screen reader find it, and its dismiss button, from anywhere.

Members

BannerAlert.layout

property · packages/mixins-ui/src/alert.ts:68

readonly layout: 'banner'

BannerAlert.label

property · packages/mixins-ui/src/alert.ts:70

readonly label: string

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