Resumen
Banner organiza el contenido proporcionado por quien realiza la llamada, un nodo icon opcional y un nodo action opcional. status describe el significado de la retroalimentación: neutral, info, success, warning o error. variant selecciona la apariencia solid o soft. Un color explícito reemplaza la paleta del estado sin cambiar su significado.
Los valores predeterminados son status="info" y variant="solid". Las paletas de estado predeterminadas son gris, azul, verde, naranja y rojo, respectivamente.
”Uso”
Acciones y apariencia
Banner.Action proporciona un botón pequeño con contorno que hereda el color mostrado del banner, incluidas las anulaciones explícitas de la paleta y las apariencias sólidas. Admite interacciones de Button, enlaces, refs y renderizado personalizado. La ranura action también acepta controles arbitrarios.
El destino raíz es un div. Los atributos nativos, los controladores de eventos, className, style y ref se aplican a esa raíz. render acepta un elemento Base UI o una función de devolución de llamada; la función recibe props nativas y ref, además del estado resuelto de status, variant y color. Conserve las props y ref proporcionadas al componer otro elemento.
role, aria-live ni anuncios. Elíjalos en quien realiza la llamada cuando se deban anunciar las actualizaciones. Proporcione nombres accesibles para los controles y marque los nodos de iconos decorativos con aria-hidden. Quien realiza la llamada controla la visibilidad y el descarte.
Cierre
PasaonDismiss para mostrar un control de cierre transparente de 24 px al final lógico en línea. El control hereda el color del banner y tiene type="button". closeLabel tiene como valor predeterminado Close; proporciona texto localizado en tu aplicación. El espaciado en línea equilibrado mantiene el contenido centrado y las acciones despejados del control.
La persona que llama controla la visibilidad. Al activar el control de cierre, se llama a onDismiss y el banner permanece montado hasta que la persona que llama actualiza el estado. Las demás acciones permanecen en la ranura action.
Migración
Reemplacevariant="primary" por variant="solid" y variant="secondary" por variant="soft". Reemplace color="danger" por status="error", o por color="red" cuando solo deba cambiar la paleta. Los banners de información azules pueden usar status="info".
”Props”
ReactNode
Optional trailing ReactNode. Banner.Action supplies a small outline action that inherits the resolved banner color; arbitrary controls are also accepted.
ReactNode
Caller-provided content, including text, links and controls.
string
Class merged onto the root div or composed element.
string
predeterminado:"Close"
Accessible label for the close control. Defaults to Close; supply localized text when needed.
"blue" | "gray" | "green" | "orange" | "red"
predeterminado:"status palette"
Palette override: gray, blue, green, orange or red. When omitted, status selects the corresponding palette.
ReactNode
Optional leading ReactNode. The caller supplies decorative or accessible icon semantics.
(() => void)
Renders a 24px ghost close control and calls this callback when activated. The caller owns visibility.
Ref<HTMLDivElement>
Ref to the root div, or to the DOM element supplied through render.
ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, BannerState>
Base UI element or render callback. The callback receives native props/ref and resolved status, variant and color state.
"error" | "info" | "neutral" | "success" | "warning"
predeterminado:"info"
Feedback meaning: neutral, info, success, warning or error. Defaults to info. Does not assign a role or live region.
CSSProperties
Inline styles applied to the root div or composed element.
"soft" | "solid"
predeterminado:"solid"
Solid or soft appearance. Defaults to solid, independently of status.
Banner.Action
string | ((state: ButtonState) => string | undefined)
CSS class applied to the element, or a function that
returns a class based on the component’s state.
boolean
Adds a shadow and backdrop blur. Neutral outline buttons also use elevated surface colors.
ReactNode
Decorative content displayed after the label.
boolean
predeterminado:"false"
Whether the button should be focusable when disabled.
boolean
Expands the button to fill its container width.
string
Destination URL. Renders a native anchor when
render is omitted unless nativeButton is explicitly true. Custom renderers retain their own element contract.boolean
Shows a loading indicator and disables activation.
"center" | "end" | "start"
Where the loading indicator appears.
center hides the content while preserving its layout space; start and end keep children and the opposite icon visible and replace the corresponding icon with the spinner.boolean
predeterminado:"true"
Whether the rendered root is a native button. Defaults to true for custom renderers. The built-in
href anchor defaults to false; an explicit value takes precedence.ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ButtonState>
Caller-supplied root element or renderer. Native attributes, handlers, event details, and refs reach the rendered root. Use
nativeButton={false} and role="link" for a custom navigation anchor. Router integration belongs to the caller.AriaRole
Role of the root element. Use
link for custom navigation renderers.ShortcutDefinition
Flat key array for simultaneous keys, or nested key arrays for an ordered sequence. Displayed on non-mobile screens.
string
Localized text between sequence steps. Defaults to then.
ReactNode
Decorative content displayed before the label.
CSSProperties | ((state: ButtonState) => CSSProperties | undefined)
Style applied to the element, or a function that
returns a style object based on the component’s state.