Overview
An icon sets the small square badge shown next to an entity such as an action or a trigger. It's a hash with up to three fields:
| Field | Required | Description |
|---|---|---|
type | no | Which glyph to show: one of the built-in keys below, or the literal remote for a custom image. |
background_color | no | The badge color behind the glyph. A color name, optionally with a shade (color:shade). |
url | only when type is remote | Full URL to a custom image. Ignored unless type is remote. |
1 2 3icon: type: bolt background_color: blue:600
The glyph itself is always drawn in white, so the badge color comes from background_color. Mid-to-dark shades read best.
Glyphs
Set type to one of these keys. Click any tile to copy its name. If type is missing or unrecognized, the badge falls back to bolt.
Colors
Set background_color to one of these names. A bad or missing color falls back to slate.
| 50 | 100 | 200 | 300 | 400 | 500 | 600* | 700 | 800 | 900 | 950 | |
|---|---|---|---|---|---|---|---|---|---|---|---|
| slate | |||||||||||
| stone | |||||||||||
| red | |||||||||||
| orange | |||||||||||
| yellow | |||||||||||
| lime | |||||||||||
| green | |||||||||||
| emerald | |||||||||||
| teal | |||||||||||
| cyan | |||||||||||
| sky | |||||||||||
| blue | |||||||||||
| indigo | |||||||||||
| violet | |||||||||||
| purple | |||||||||||
| fuchsia | |||||||||||
| pink | |||||||||||
| rose |
* Default shade when you write a bare color name (e.g. blue).
Shades
Add a shade with color:shade, for example blue:600 or slate:700. Lower numbers are lighter and higher numbers are darker. A bare color name uses shade 600.
1 2 3icon: type: shield-check background_color: emerald:700
Custom images
To use your own image instead of a built-in glyph, set type to remote and point url at a full image URL. The image is drawn on top of the colored badge.
1 2 3 4icon: type: remote url: https://cdn.example.com/icon.png background_color: slate:600
Defaults and fallbacks
| Situation | Result |
|---|---|
type omitted or unrecognized | bolt glyph |
background_color omitted | slate |
| Shade omitted (bare color name) | 600 |
| Unrecognized color name | slate |
type: remote with no url | Badge shows with no glyph |
