Dashboard widget vocabulary

Widget types, widths, containers, column formats and the rules the manifest validator applies.

Two schema versions coexist. Schema 1 is the original widget set. Schema 2 adds containers, static widgets, action buttons, data sources and formatting. The vocabulary below is what the validator accepts; anything else is rejected at upload.

Widget types

Schema 1 and 2alert chart form list markdown progress_bar stat_card table text

Schema 2 onlyaction_button badge_list divider heading image key_value timeline user_list

Need datachart stat_card table need rpc_method, or in schema 2 a source.

Staticaction_button divider heading image take no data.

Layout

Width	Grid columns of 12
`quarter`	3
`third`	4
`half`	6
`two_thirds`	8
`full`	12

Containers (schema 2)section tabs One level only: a container cannot hold another container.

Densitiescompact, cozy

Chart heightslg, md, sm

Refreshrefresh_seconds between 5 and 3600.

Formatting

Table column formatsavatar badge code link number percent timestamp

Badge colourscyan gold gray green red

Action button stylesdanger default primary

Permission valuesmanager owner viewer Who can see a widget. Cosmetic filtering with visible_when is not access control.

Rules the validator applies

Every widget has an id and a valid width.
table needs columns. A column is a key, or an object with key, format and, for badges, format_options.colors mapping values to badge colours.
image takes a src that is a path inside your zip under dashboard/, up to 200 characters, no ...
heading takes text up to 200 characters and level 1, 2 or 3.
action_button uses action_rpc_method, a label up to 80 characters, an optional confirm up to 300 and success_message up to 200.
section containers take a heading up to 120 characters, a description up to 500, collapsible and a non-empty widgets list. tabs take a list of {id, title, widgets} with unique ids.
Schema 2 keys (source, height, format) are errors in a schema 1 manifest.
The optional rpc block declares {"method_name": {"writes": true}}. A method marked as writing needs the manager role and skips the cache. A declaration can only raise a method to writing, never lower it.
Theme accepts accent and accent_secondary as hex colours.

Manifest mode in the Dashboards guide

YourBot docs Reference tables are generated from the code that is running. Ask in Discord Suggest a correction