An open source design system that's fully customizable and agent ready
TypeScript
// Copyright (c) Meta Platforms, Inc. and affiliates.
'use client';
/**
* @file index.ts
* @input Imports Banner component and types from Banner.tsx
* @output Exports Banner, BannerProps, BannerStatus, BannerContainer
* @position Component entry point; re-exported by /packages/core/src/index.ts
*
* SYNC: When modified, update this header and /packages/core/src/Banner/Banner.doc.mjs
*/
/**
* Extensible container map for Banner.
*
* Theme packages can add custom container types via TypeScript module augmentation:
* @example
* ```
* declare module '@astryxdesign/core/Banner' {
* interface BannerContainerMap {
* 'floating': true;
* }
* }
* ```
*/
export interface BannerContainerMap {
card: true;
section: true;
}
/**
* Extensible status map for Banner.
*
* Theme packages can add custom statuses via TypeScript module augmentation.
* A status the library does not know falls through to the base visual treatment:
* no status fill and no default glyph. Status never chooses a live-region role.
* Announce a status change with `useAnnounce`. Pass `role="alert"` through
* BaseProps only for an urgent message; Banner puts it on the title and
* description.
* @example
* ```
* declare module '@astryxdesign/core/Banner' {
* interface BannerStatusMap {
* 'neutral': true;
* }
* }
* ```
*/
export interface BannerStatusMap {
info: true;
warning: true;
error: true;
success: true;
}
export {Banner} from './Banner';
export type {BannerProps, BannerStatus, BannerContainer} from './Banner';