Skip to content

The open alternative to Salesforce, designed for AI.

1.7 KB
Raw Blame
import { type ComponentProps } from 'react';
import { type InlineBanner } from '../src/components/feedback/InlineBanner/InlineBanner';

export const INLINE_BANNER_PROP_DESCRIPTIONS = {
  children:
    'Caller-provided content. Standard plain strings truncate with a focusable tooltip; rich nodes render directly. Compact content wraps.',
  status:
    'Feedback meaning: neutral, info, success, warning or error. Defaults to info. Roles and announcements remain caller-owned.',
  variant:
    'Solid or soft appearance, independently of status and layout. Defaults to soft.',
  color:
    'Gray, blue, green, orange or red palette override. An omitted color follows status.',
  layout:
    'Standard full-width layout or compact wrapping layout with a 512px maximum content width. Defaults to standard.',
  fullWidth:
    "Fills the available parent width, including padding and borders, and removes the compact layout's 512px maximum. Defaults to false; standard layout already fills its parent.",
  embedded:
    'Removes the standard bottom margin. Compact layouts have no bottom margin.',
  icon: 'Leading ReactNode. Defaults to a decorative information icon. Pass null to omit it.',
  action:
    'Optional trailing ReactNode. InlineBanner.Action supplies the shared banner action preset and inherits the resolved banner color; arbitrary controls are also accepted.',
  className: 'Class merged onto the root div or composed element.',
  style: 'Inline styles applied to the root div or composed element.',
  ref: 'Ref to the root div, or to the DOM element supplied through render.',
  render:
    'Base UI root element or render callback, receiving native props/ref and resolved Banner state.',
} satisfies Partial<Record<keyof ComponentProps<typeof InlineBanner>, string>>;