Banner
import { Banner, BannerAction } from '@hanzo/ui'
Default
A full-width strip with a message and no icon or close button.
A new version of the app is available.
export function Default() {
return <Banner>A new version of the app is available.</Banner>
}Dismissible
A leading icon indents the message, and `onClose` reports the press; the banner keeps no visibility state, so the caller unmounts it.
Scheduled maintenance runs tonight from 2am to 3am UTC.
export function Dismissible() {
const [open, setOpen] = useState(true)
return (
<YStack gap="$3" items="flex-start" width="100%">
{open ? (
<Banner variant="info" onClose={() => setOpen(false)}>
<svg viewBox="0 0 24 24" width={16} height={16} fill="none" stroke="currentColor" strokeWidth={2}>
<circle cx={12} cy={12} r={10} />
<path d="M12 16v-4M12 8h.01" strokeLinecap="round" strokeLinejoin="round" />
</svg>
Scheduled maintenance runs tonight from 2am to 3am UTC.
</Banner>
) : (
<Button variant="outline" onPress={() => setOpen(true)}>
Show the banner again
</Button>
)}
</YStack>
)
}Variants
`default`, `info`, `success`, `warning` and `error` each tint the border, background, icon and text.
Default banner.
Informational banner.
Your changes were saved.
Your trial ends in three days.
Payment failed — update your billing details.
export function Variants() {
return (
<YStack gap="$2">
<Banner>Default banner.</Banner>
<Banner variant="info">Informational banner.</Banner>
<Banner variant="success">Your changes were saved.</Banner>
<Banner variant="warning">Your trial ends in three days.</Banner>
<Banner variant="error">Payment failed — update your billing details.</Banner>
</YStack>
)
}Types
export type BannerVariant = 'default' | 'info' | 'success' | 'warning' | 'error'export type BannerProps = Omit<ComponentProps<typeof BannerFrame>, 'variant' | 'color'> & {
variant?: BannerVariant | null
onClose?: () => void
/** What the banner reports; picks its colour through the status map. */
status?: FeedbackStatus
/** The colour, when it is not the status's. */
color?: FeedbackColor
/** `solid` (the full-width default) or `soft`. */
emphasis?: 'solid' | 'soft'
/** `strip` (full width, the default), `inline` (inside content) or `compact` (sized to content). */
layout?: 'strip' | 'inline' | 'compact'
/** `inline`: drop the 16px below, for a banner that is the last thing in its box. */
embedded?: boolean
/** A trailing control — usually `<BannerAction>`. */
action?: ReactNode
/** The leading icon, for the record shape (inline defaults to Info). */
icon?: ReactNode
}Exports
Bannertype BannerPropstype BannerVariantBannerAction