Files
Jonathan Summers-Muir ec760d4e97 add Admonition to Design System (#26710)
* add Admonition to Design System

* added notices about FormLabel

* Update label.mdx
2024-05-24 09:21:41 +00:00

46 lines
876 B
Plaintext

---
title: Admonition
description: Displays a callout for user attention.
fragment: true
links:
doc: https://www.radix-ui.com/docs/primitives/components/alert
api: https://www.radix-ui.com/docs/primitives/components/alert#api-reference
---
<ComponentPreview
name="admonition-demo"
className="[&_.preview>[data-orientation=vertical]]:sm:max-w-[70%]"
peekCode
wide
/>
## Usage
```tsx
import { Admonition } from 'ui-patterns/admonition'
```
```tsx
<Admonition
type="default"
title="Is it accessible?"
description="Yes. It adheres to the WAI-ARIA design pattern."
/>
```
## Examples
### Warning
<ComponentPreview
name="admonition-warning"
className="[&_.preview>[data-orientation=vertical]]:sm:max-w-[70%]"
/>
### Destructive
<ComponentPreview
name="admonition-destructive"
className="[&_.preview>[data-orientation=vertical]]:sm:max-w-[70%]"
/>