Alert

Inline status message for success, warning, danger, and info states.

Preview

A live, theme-aware example rendered with the published component.

Loading preview…

Import

Import from the focused entry point below, or use the same named export from @tavojs/ui. Both are public APIs; measure the built application when comparing their bundle cost.

TSX

tsximport { Alert } from "@tavojs/ui/alert";

The component import loads compiled component CSS. Enable tavoUi() for your project theme variables, or import @tavojs/ui/theme.css once for the package default theme. The equivalent CSS-safe component alias is @tavojs/ui/css/alert.

When to use

Use it when

Use `Alert` for inline feedback that belongs inside page flow

Choose something else when

Avoid Alert when using feedback components as primary page layout.

Examples

These examples include imports and local state where interaction requires it. Render the exported component in a page after completing UI installation. Demo state stays in the mounted component; connect file handling, persistence, and data loading to your application as needed.

Alert example

TSXCreate: src/components/examples/AlertExample1.tsx

tsximport { Alert } from "@tavojs/ui/alert";

export function AlertExample1() {
  return (
    <>
      <Alert title="Saved" tone="success">
        Your changes were stored locally.
      </Alert>
    </>
  );
}

Common props and defaults

A curated starting point. The complete TypeScript API below includes additional props and compound member contracts.

Prop	Type	Default	Description
`className`	`string`	—	Optional class hook applied to the public root element owned by the component.
`as`	`string \| Component<Record<string, unknown>>`	—	Changes the rendered root element or component while preserving Tavo.js UI styling and public props.
`title`	`Child`	—	Configures title for this component.
`tone`	`"info" \| "success" \| "warning" \| "danger"`	—	Configures tone for this component.

Complete TypeScript API

Import from @tavojs/ui/alert. Published exports: Alert, AlertProps, AlertTone.

`AlertProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by Alert.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by Alert.
`id`	`string`	No	Inherited id attribute accepted by Alert.
`role`	`string`	No	Inherited role attribute accepted by Alert.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by Alert.
`title`	`string & Child`	No	Configures title for this component.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by Alert.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by Alert.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by Alert.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by Alert.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by Alert.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by Alert.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by Alert.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by Alert.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by Alert.
`as`	`PolymorphicAs`	No	Changes the rendered root element or component while preserving Tavo.js UI styling and public props.
`tone`	`AlertTone`	No	Configures tone for this component.

State ownership and DOM target

Concern	Contract
State	No component state contract is exposed; the application owns the rendered content and surrounding behavior.
DOM target	The public root follows the as/component prop. Root attributes, className, style, and supported events are forwarded there.

Anatomy and related components

This component exposes one public component root rather than a compound member API.

Limitations

Avoid Alert when using feedback components as primary page layout.

Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.

Accessibility

Uses `role="status"` by default.

Uses `role="status"` by default.

Component status

Contract	Current value
Maturity	stable
Category	feedback
Component import	`@tavojs/ui/alert`
Explicit CSS import	`@tavojs/ui/css/alert`
Preview	Interactive preview available on this page