Elements¶
Basic building blocks used throughout the interface.
Action Elements¶
Button¶
Interactive elements for triggering actions.
Parameters for
button
| Parameter | Type | Description |
|---|---|---|
content |
any | Button label |
href |
str | URL to navigate to when the button is clicked. If not specified, button will not be a link. |
type |
str | Button type, either "button", "submit" or "reset" |
style |
str | Visual style of the button, either "primary", "secondary", "success", "danger", "warning", or "info" |
icon |
str | Name of the icon to show in the button (search, home, trash, etc.) |
Link¶
Standard hyperlinks for navigation.
Parameters for
link
| Parameter | Type | Description |
|---|---|---|
content |
any | Link label |
href |
str | URL to navigate to when the link is clicked. |
blank |
bool | Whether to open the link in a new tab |
Content Indicators¶
Badge¶
Small indicators for counts or status.
Parameters for
badge
| Parameter | Type | Description |
|---|---|---|
content |
any | Content of the badge |
style |
str | Visual style of the badge, either "primary", "secondary", "success", "danger", "warning", or "info" |
Tag¶
Labels for categorizing content.
Parameters for
tag
| Parameter | Type | Description |
|---|---|---|
content |
any | Tag label |
href |
str | URL to navigate to when the tag is clicked. |
Visual Media¶
Icon¶
Graphical symbols representing actions or concepts.
Parameters for
icon
| Parameter | Type | Description |
|---|---|---|
name |
str | Name of the icon to show (search, home, trash, etc.). Themes usually provide a mapping from FontAwesome names to name os the used icon collection. |
Image¶
Displaying images with proper attributes.
Parameters for
image
| Parameter | Type | Description |
|---|---|---|
src |
str | URL of the image to show |
alt |
str | Alternative text for the image, shown if the image cannot be loaded |
Video¶
Video player component.
Parameters for
video
| Parameter | Type | Description |
|---|---|---|
src |
any | URL of the video to show |
controls |
bool | Whether to show video controls (play, pause, etc.) |
autoplay |
bool | Whether to autoplay the video when the page loads |
Utilities¶
Datetime¶
Formatted and localized date and time display.
Parameters for
datetime
| Parameter | Type | Description |
|---|---|---|
content |
str|datetime | Date and time value in ISO 8601 format or datetime object |
date_format |
str | Format string for the date part of the output, using Python's strftime format codes. |
with_hours |
bool | Whether to include the time part in the output |
empty |
str | Text to show if the value is empty or invalid |
relative |
bool | Whether to show the date as a relative time (e.g. "3 days ago") instead of an absolute date |
Empty¶
A component shown when there is no content to display.
Parameters for
empty
| Parameter | Type | Description |
|---|---|---|
content |
any | Message shown when there is no content to display |