Examples
Basic
| Prop | Default | Type | Description |
|---|---|---|---|
title | - | string | Title of the alert |
description | - | string | Description of the alert |
Alert
This documentation is still a work in progress. The package itself is not yet officially released and some sections of this documentation may be incomplete or missing entirely until the first release. We are working hard to complete the documentation as soon as possible.
Variant
| Prop | Default | Type | Description |
|---|---|---|---|
alert | text | {variant} | The variant of the alert. |
| Variant | Description |
|---|---|
text | The text variant. |
solid | The solid variant. |
outline | The outline variant. |
soft | The soft variant. |
border | The border variant. |
Solid primary
Lorem ipsum dolor sit amet consectetur adipisicing elit. aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Text primary
Lorem ipsum dolor sit amet consectetur adipisicing elit. aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Outline primary
Lorem ipsum dolor sit amet consectetur adipisicing elit. aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Soft primary
Lorem ipsum dolor sit amet consectetur adipisicing elit. aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Border primary
Lorem ipsum dolor sit amet consectetur adipisicing elit. aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Color
| Prop | Default | Type | Description |
|---|---|---|---|
alert | {variant}-gray | {variant}-{color} | The color of the alert. |
Text gray (default)
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Solid primary
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Solid white
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Solid black
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Text info
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Success color
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Warning color
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Error color
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Purple color
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Lime color
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Pink color
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Sky color
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Icon
| Prop | Default | Type | Description |
|---|---|---|---|
icon | - | string | Customize the icon of the alert. |
If you provide an icon type such as success, error, warning, or info, the alert will automatically use the corresponding color.
Customize icon
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Info icon
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Success icon
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Warning icon
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Error icon
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Read more in Icon component
Size
| Prop | Default | Type | Description |
|---|---|---|---|
size | sm | string | Allows you to change the size of the input. |
🚀 Adjust input size freely using any size, breakpoints (e.g.,
sm:sm, xs:lg), or states (e.g.,hover:lg, focus:3xl).
The padding, icons, and text-size of the input scale are dynamically adjusted based on the size property. To customize the text-size and padding simultaneously, you can use utility classes.
Attention needed
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Attention needed
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Attention needed
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Attention needed
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Closable
| Prop | Default | Type | Description |
|---|---|---|---|
closable | - | boolean | Add a close button to the alert. |
Closable alert 1
Closable alert 2
Lorem ipsum dolor sit amet consectetur adipisicing elit. aliquid pariatur, ipsum similique veniam quo totam eius aperiam dolorum.
Events
| Event Name | Description |
|---|---|
@close | emit an event when the close icon is clicked. Use in conjunction with closable. |
Slots
| Name | Props | Description |
|---|---|---|
default | - | Cover the title and description slots. |
title | - | The title of the alert. |
description | - | The description of the alert. |
icon | - | The icon of the alert. |
actions | - | The actions of the alert. |
close | - | The close icon of the alert. |
Example 1
The selected emails have been marked as spam.
Example 2
There were some errors with your submission
- The team name must be a string.
- The team name must be at least 1 character.
Example 3
Payment completed
Lorem ipsum dolor sit amet consectetur adipisicing elit. Aliquid pariatur, ipsum similique veniam.
Presets
shortcuts/alert.ts
Props
types/alert.ts