KPI (small)
Displays a small KPI (Key Performance Indicator)
Demo
API
Tag
| Name | Description |
|---|---|
<aui-kpi-small>
|
Custom Element for displaying KPI information |
Slots
| Name | Required | Description |
|---|---|---|
label
|
|
A descriptive label for the KPI value |
Attributes
| Name | Value | Required | Description |
|---|---|---|---|
status |
error | warning | success | neutral | other | empty |
Sets the status color scheme for the icon container. Default:
|
|
iconname |
string |
|
Name of the s-icon to display. Must be a valid |
value |
string | number |
The primary value or metric to display |
Properties
| Name | Value | Required | Description |
|---|---|---|---|
status |
error | warning | success | neutral | other |
Sets the status color scheme for the icon container. Default: |
|
iconName |
string |
|
Name of the s-icon to display. Must be a valid |
value |
string | number |
The primary value or metric to display |
Demo
API
Tag
| Name | Description |
|---|---|
<AuiKpiSmall>
|
Custom Element for displaying KPI information |
Slots
| Name | Required | Description |
|---|---|---|
label
|
|
A descriptive label for the KPI value |
Props
| Name | Value | Required | Description |
|---|---|---|---|
status |
error | warning | success | neutral | other | empty |
Sets the status color scheme for the icon container. Default: |
|
iconName |
string |
|
Name of the s-icon to display. Must be a valid |
value |
string | number |
The primary value or metric to display |
Skylab React links
Guidelines
Best Practices
- Use appropriate status values that match the semantic meaning of your KPI (e.g.,
successfor positive metrics,errorfor problematic metrics) - Choose icons that clearly represent the type of data being displayed
- Keep value text concise and readable
- Use descriptive labels that provide context for the values
Design
Design resources can be found on the Skylab design documentation site: skylab.avalara.com