Alert

Status message with a built-in icon.

A status message. Alert.Indicator resolves both the icon and its colour from the alert's variant, so it follows the active theme without you passing either.

Installation

Alert ships with the library — no separate install.

import { Alert } from 'panelui-native';

Usage

<Alert variant="success">
  <Alert.Indicator />
  <Alert.Content>
    <Alert.Title>Payment received</Alert.Title>
    <Alert.Description>Your invoice has been paid.</Alert.Description>
  </Alert.Content>
</Alert>

Composition

<Alert>
  <Alert.Indicator />
  <Alert.Content>
    <Alert.Title>…</Alert.Title>
    <Alert.Description>…</Alert.Description>
  </Alert.Content>
</Alert>
  • Alert.Indicator — Leading status icon, picked from the variant. Pass children to override it.
  • Alert.Content — Flex-1 wrapper for the title and description.
  • Alert.Title — Heading, coloured by the variant.
  • Alert.Description — Body text, always muted.

Variants

variant

  • default (default)
  • info
  • success
  • warning
  • destructive

API Reference

Alert

PropTypeDefaultDescription
classNamestring
iconReactNodeLeading element rendered before the content. Deprecated. Prefer <Alert.Indicator>, which picks a status icon for you. Still honoured so v0.2 call sites keep rendering.

Alert.Indicator

PropTypeDefaultDescription
classNamestring
iconProps{ size?: number; color?: string }Overrides the size/colour of the default status icon.

Every part also accepts the underlying React Native props (ViewProps or TextProps) and a className for Tailwind utilities.

Notes

Omit Alert.Indicator for a text-only alert. The legacy icon prop still renders, but prefer the indicator.

On this page