The alert component
A visually distinctive message or notification.
Top-level parameters
name | required | type | description |
---|---|---|---|
title | REQUIRED | TEXT |
Title of the alert message. |
class | TEXT |
class attribute added to the container in HTML. It can be used to apply custom styling to this item through css. Added in v0.18.0. | |
color | The color theme for the alert message. | ||
description | TEXT |
Detailed description or content of the alert message. | |
description_md | TEXT |
Detailed description or content of the alert message, in Markdown format, allowing you to use rich text formatting, including **bold** and *italic* text. | |
dismissible | BOOLEAN |
Whether the user can close the alert message. | |
icon | TEXT |
Icon name (from tabler-icons.io) to display next to the alert message. | |
id | TEXT |
id attribute added to the container in HTML. It can be used to target this item through css or for scrolling to this item through links (use "#id" in link url). | |
important | BOOLEAN |
Set this to TRUE to make the alert message more prominent. | |
link | URL |
A URL to link to from the alert message. | |
link_text | TEXT |
Customize the text of the link in the alert message. The default is "Ok". |
Row-level parameters
name | required | type | description |
---|---|---|---|
color | Customize the color of the link. | ||
link | URL |
A URL to link to from the alert message. | |
title | TEXT |
Customize the text of the link in the alert message. The default is "Ok". |
Example 1
A basic alert message
select
'alert' as component,
'Attention' as title,
'This is an important message.' as description;
Result
Attention
This is an important message.
Example 2
A list of notifications
select
'alert' as component,
'Success' as title,
'Item successfully added to your cart.' as description,
'check' as icon,
'green' as color;
select
'alert' as component,
'Warning' as title,
'Your cart is almost full.' as description,
'alert-triangle' as icon,
'yellow' as color;
select
'alert' as component,
'Error' as title,
'Your cart is full.' as description,
'alert-circle' as icon,
'red' as color;
Result
Success
Item successfully added to your cart.
Warning
Your cart is almost full.
Error
Your cart is full.
Example 3
A full-featured notification message with multiple links
select
'alert' as component,
'Your dashboard is ready!' as title,
'analyze' as icon,
'teal' as color,
TRUE as dismissible,
'Your public web dashboard was successfully created.' as description;
select
'dashboard.sql' as link,
'View your dashboard' as title;
select
'index.sql' as link,
'Back to home' as title,
'secondary' as color;
Result
Your dashboard is ready!
Your public web dashboard was successfully created.
View your dashboard
Back to home
Example 4
An important danger alert message with an icon and color
select
'alert' as component,
'Alert' as title,
'alert-circle' as icon,
'red' as color,
TRUE as important,
TRUE as dismissible,
'SQLPage is entirely free and open source.' as description,
'https://github.com/sqlpage/SQLPage' as link,
'See source code' as link_text;
Result
Example 5
An alert message with a Markdown-formatted description
select
'alert' as component,
'Free and open source' as title,
'free-rights' as icon,
'info' as color,
'*SQLPage* is entirely free and open source. You can **contribute** to it on [GitHub](https://github.com/sqlpage/SQLPage).' as description_md;
Result
Free and open source
SQLPage is entirely free and open source. You can contribute to it on GitHub.