Catalogue examples
Start with a working example, then check the generated contract for every setting, event, and child rule.
The catalogue
Every element an app may draw, with its settings and what each takes. A screen draws these and nothing else: there is no HTML, no styling and no colour of your own — Brydio draws them in its own theme, light and dark, so an app looks like the rest of the product without trying to.
This page is generated from the catalogue itself by bun run docs:elements. Adding an element or a setting and not running it fails packages/cli/test/elements-doc.test.ts, so the reference cannot fall behind the code. Do not edit it by hand.
A setting the element does not declare is refused, as is a value outside what it takes; brydio validate catches both before you publish, with the codes in the publish checklist.
A toast is not an element: it is said, not placed. A screen shows one with toast(text, tone) from @brydio/app, which Brydio draws in its own toaster; see the bridge.
There are 104 elements.
bry-stackbry-headingbry-textbry-buttonbry-cardbry-inputbry-textareabry-selectbry-labelbry-gridbry-badgebry-avatarbry-list-rowbry-empty-statebry-skeletonbry-tablebry-virtual-listbry-dialogbry-menubry-datebry-splitbry-checkboxbry-switchbry-boardbry-board-columnbry-markdownbry-diffbry-file-gridbry-button-groupbry-calendarbry-comboboxbry-commandbry-context-menubry-data-tablebry-fieldbry-input-groupbry-input-otpbry-menubarbry-native-selectbry-section-menubry-paginationbry-questionnairebry-radio-groupbry-sliderbry-togglebry-toggle-groupbry-accordionbry-alertbry-alert-dialogbry-aspect-ratiobry-attachmentbry-breadcrumbbry-bubblebry-carouselbry-chartbry-collapsiblebry-directionbry-drawerbry-hover-cardbry-itembry-kbdbry-markerbry-messagebry-message-scrollerbry-popoverbry-progressbry-scroll-areabry-separatorbry-sheetbry-spinnerbry-tabsbry-tooltipbry-glyphbry-propertybry-quick-addbry-work-cardbry-page-headerbry-entity-rowbry-filter-menubry-ganttbry-timelinebry-timeline-itembry-commentbry-page-treebry-comment-marginbry-historybry-reactionsbry-peekbry-spreadsheetbry-datagridbry-spreadsheet-rowbry-spreadsheet-groupbry-rich-textbry-whiteboardbry-board-previewbry-approvalbry-board-lanebry-property-listbry-property-rowbry-keysbry-filter-chipbry-calendar-viewbry-boxbry-canvas
bry-stack
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
direction | row, column | no |
gap | 1, 2, 3, 4, 5, 6, 7, 8 | no |
align | start, center, end, stretch | no |
justify | start, center, end, between | no |
wrap | true or false | no |
variant | default, page, toolbar, scroll, section, section-header, filter-bar, page-body, action-bar, inset, narrow, group, group-header | no |
Tells the app nothing.
bry-heading
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
level | a whole number from 1 to 4 | no |
text | text, at most 200 characters | yes |
variant | title, heading, subheading, label | no |
Tells the app nothing.
bry-text
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
text | text, at most 4,000 characters | yes |
tone | default, muted, neutral, brand, success, warn, danger | no |
variant | body, ui, caption, label | no |
size | sm, md | no |
Tells the app nothing.
bry-button
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
label | text, at most 200 characters | yes |
variant | primary, secondary, ghost, danger | no |
size | sm, md | no |
disabled | true or false | no |
working | true or false | no |
icon | add, archive, calendar, check, copy, dismiss, docs, info, mail, members, notes, pin, rename, retry, search, settings, tasks, trash, account, activity, attach, bell, boardLayout, box, branch, calendarRange, channel, chart, cycle, download, externalLink, flag, ganttLayout, history, home, inbox, layers, link, listLayout, lock, maximise, panelRight, pause, play, progress, project, relation, sliders, tableLayout, tag, target, temporary, userAdd, status, filter, stateReview, swimlaneLayout, more, close, arrowRight, chevronRight, chevronDown, chevronUp | no |
hideLabel | true or false | no |
Tells the app: press.
bry-card
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
title | text, at most 200 characters | no |
padding | 2, 3, 4, 5, 6 | no |
pressable | true or false | no |
loading | true or false | no |
Tells the app: press.
bry-input
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
value | text, at most 1,000 characters | no |
placeholder | text, at most 200 characters | no |
label | text, at most 200 characters | no |
kind | text, email, url, search | no |
maxLength | a whole number from 1 to 1000 | no |
required | true or false | no |
disabled | true or false | no |
error | text, at most 200 characters | no |
variant | default, bare | no |
autofocus | true or false | no |
size | sm, md, lg | no |
fit | full, compact | no |
Tells the app: change, submit, blur, cancel.
bry-textarea
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
value | text, at most 4,000 characters | no |
placeholder | text, at most 200 characters | no |
label | text, at most 200 characters | no |
maxLength | a whole number from 1 to 4000 | no |
required | true or false | no |
disabled | true or false | no |
error | text, at most 200 characters | no |
variant | default, bare | no |
Tells the app: change, submit.
bry-select
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
value | text, at most 200 characters | no |
multiple | true or false | no |
values | a list of at most 100: text, at most 200 characters | no |
options | at most 100 { value, label } choices | yes |
placeholder | text, at most 200 characters | no |
label | text, at most 200 characters | no |
size | sm, md | no |
disabled | true or false | no |
error | text, at most 200 characters | no |
Tells the app: change.
bry-label
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
text | text, at most 200 characters | yes |
required | true or false | no |
Tells the app nothing.
bry-grid
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
columns | 1, 2, 3, 4, 5, 6 | no |
gap | 1, 2, 3, 4, 5, 6, 7, 8 | no |
align | start, center, end, stretch | no |
Tells the app nothing.
bry-badge
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
text | text, at most 200 characters | yes |
tone | neutral, brand, success, warn, danger | no |
hue | gray, red, orange, yellow, green, teal, blue, indigo, purple, pink | no |
variant | default, count | no |
Tells the app nothing.
bry-avatar
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
name | text, at most 200 characters | yes |
memberId | text, at most 128 characters | no |
size | sm, md, lg | no |
Tells the app nothing.
bry-list-row
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
title | text, at most 200 characters | no |
description | text, at most 200 characters | no |
meta | text, at most 200 characters | no |
pressable | true or false | no |
selected | true or false | no |
loading | true or false | no |
variant | default, work, stacked | no |
identifier | text, at most 200 characters | no |
selectable | true or false | no |
checked | true or false | no |
density | default, compact | no |
menu | a list of at most 60: a record of id, label, icon, tone, separator, disabled, checked, parent (needs id, label) | no |
removable | true or false | no |
muted | true or false | no |
lead | true or false | no |
Tells the app: press, toggle, select, remove.
bry-empty-state
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
title | text, at most 200 characters | yes |
text | text, at most 4,000 characters | no |
action | text, at most 200 characters | no |
variant | default, plain | no |
icon | add, archive, calendar, check, copy, dismiss, docs, info, mail, members, notes, pin, rename, retry, search, settings, tasks, trash, account, activity, attach, bell, boardLayout, box, branch, calendarRange, channel, chart, cycle, download, externalLink, flag, ganttLayout, history, home, inbox, layers, link, listLayout, lock, maximise, panelRight, pause, play, progress, project, relation, sliders, tableLayout, tag, target, temporary, userAdd, status, filter, stateReview, swimlaneLayout, more, close, arrowRight, chevronRight, chevronDown, chevronUp | no |
Tells the app: action.
bry-skeleton
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
shape | line, block, row | no |
count | a whole number from 1 to 12 | no |
Tells the app nothing.
bry-table
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
columns | a list of at most 12: a record of key, heading, align, sortable (needs key, heading) | yes |
rows | a list of at most 500: a record of id, cells (needs id, cells) | no |
sort | a record of key, direction (needs key, direction) | no |
label | text, at most 200 characters | no |
selectable | true or false | no |
selected | text, at most 128 characters | no |
loading | true or false | no |
empty | text, at most 200 characters | no |
Tells the app: sort, select.
bry-virtual-list
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
count | a whole number from 0 to 1000000 | yes |
start | a whole number from 0 to 1000000 | no |
rowSize | sm, md, lg | no |
label | text, at most 200 characters | no |
selectable | true or false | no |
selected | a whole number from 0 to 1000000 | no |
loading | true or false | no |
empty | text, at most 200 characters | no |
Tells the app: range, select.
bry-dialog
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
open | true or false | no |
title | text, at most 200 characters | yes |
description | text, at most 4,000 characters | no |
actions | a list of at most 3: a record of id, label, tone, disabled (needs id, label) | no |
cancel | text, at most 200 characters | no |
variant | default, compose | no |
crumbs | a list of at most 3: text, at most 200 characters | no |
expanded | true or false | no |
toggle | text, at most 200 characters | no |
toggled | true or false | no |
Tells the app: action, close, expand, toggle.
bry-menu
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
items | a list of at most 60: a record of id, label, icon, tone, separator, disabled, checked, parent (needs id, label) | yes |
heading | text, at most 200 characters | no |
Tells the app: select.
bry-date
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
value | text, at most 10 characters | no |
min | text, at most 10 characters | no |
max | text, at most 10 characters | no |
label | text, at most 200 characters | no |
placeholder | text, at most 200 characters | no |
disabled | true or false | no |
error | text, at most 200 characters | no |
Tells the app: change.
bry-split
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
ratio | a whole number from 20 to 80 | no |
label | text, at most 200 characters | no |
side | sidebar | no |
Tells the app: resize.
bry-checkbox
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
checked | true or false | no |
label | text, at most 200 characters | yes |
disabled | true or false | no |
error | text, at most 200 characters | no |
Tells the app: change.
bry-switch
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
checked | true or false | no |
label | text, at most 200 characters | yes |
disabled | true or false | no |
error | text, at most 200 characters | no |
Tells the app: change.
bry-board
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
label | text, at most 200 characters | no |
cardSize | sm, md, lg | no |
layout | columns, list, lanes | no |
laneColumns | a whole number from 1 to 12 | no |
variant | default, plan, panel | no |
settled | text, at most 128 characters | no |
loading | true or false | no |
empty | text, at most 200 characters | no |
Tells the app: move.
bry-board-column
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
title | text, at most 200 characters | yes |
count | a whole number from 0 to 100000 | no |
limit | a whole number from 1 to 100000 | no |
start | a whole number from 0 to 100000 | no |
loading | true or false | no |
empty | text, at most 200 characters | no |
glyph | backlog, unstarted, started, completed, cancelled | no |
tone | neutral, brand, success, warn, danger | no |
hue | gray, red, orange, yellow, green, teal, blue, indigo, purple, pink | no |
collapsible | true or false | no |
collapsed | true or false | no |
addable | true or false | no |
addLabel | text, at most 200 characters | no |
adding | true or false | no |
busy | true or false | no |
checkable | true or false | no |
checked | true or false | no |
mixed | true or false | no |
menu | a list of at most 60: a record of id, label, icon, tone, separator, disabled, checked, parent (needs id, label) | no |
Tells the app: range, toggle, add, submit, cancel, select, check.
bry-markdown
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
text | text, at most 50,000 characters | yes |
expanded | true or false | no |
quote | text, at most 200 characters | no |
references | a list of at most 500: a record of text, route (needs text, route) | no |
find | text, at most 200 characters | no |
findIndex | a whole number from 0 to 100000 | no |
Tells the app: quote, open, find.
bry-diff
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
files | a list of at most 300: a record of path, previous, status, patch (needs path) | yes |
label | text, at most 200 characters | no |
loading | true or false | no |
empty | text, at most 200 characters | no |
Tells the app: expand, select.
bry-file-grid
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
label | text, at most 200 characters | no |
count | a whole number from 0 to 100000 | yes |
start | a whole number from 0 to 100000 | no |
files | a list of at most 200: a record of id, name, kind, preview, size, modified (needs id, name, kind) | no |
tileSize | sm, md, lg | no |
selectable | true or false | no |
selected | a list of at most 200: text, at most 128 characters | no |
menu | a list of at most 12: a record of id, label, icon, tone (needs id, label) | no |
loading | true or false | no |
empty | text, at most 200 characters | no |
Tells the app: open, select, menu, range.
bry-button-group
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
label | text, at most 200 characters | yes |
orientation | horizontal, vertical | no |
Tells the app nothing.
bry-calendar
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
mode | single, multiple, range | no |
values | a list of at most 366: text, at most 10 characters | no |
month | text, at most 10 characters | no |
min | text, at most 10 characters | no |
max | text, at most 10 characters | no |
label | text, at most 200 characters | no |
disabled | true or false | no |
error | text, at most 200 characters | no |
Tells the app: change.
bry-combobox
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
value | text, at most 200 characters | no |
multiple | true or false | no |
values | a list of at most 500: text, at most 200 characters | no |
options | at most 500 { value, label } choices | yes |
placeholder | text, at most 200 characters | no |
search | text, at most 200 characters | no |
empty | text, at most 200 characters | no |
label | text, at most 200 characters | no |
size | sm, md | no |
disabled | true or false | no |
error | text, at most 200 characters | no |
Tells the app: change.
bry-command
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
items | a list of at most 200: a record of id, label, group, icon, hint, disabled (needs id, label) | yes |
placeholder | text, at most 200 characters | no |
label | text, at most 200 characters | no |
loading | true or false | no |
empty | text, at most 200 characters | no |
Tells the app: select, change.
bry-context-menu
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
items | a list of at most 60: a record of id, label, icon, tone, separator, disabled, checked, parent (needs id, label) | yes |
Tells the app: select.
bry-data-table
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
columns | a list of at most 12: a record of key, heading, align, sortable, hideable (needs key, heading) | yes |
rows | a list of at most 500: a record of id, cells (needs id, cells) | no |
sort | a record of key, direction (needs key, direction) | no |
filter | text, at most 200 characters | no |
placeholder | text, at most 200 characters | no |
page | a whole number from 1 to 500 | no |
perPage | a whole number from 1 to 100 | no |
hidden | a list of at most 12: text, at most 128 characters | no |
selectable | true or false | no |
selected | a list of at most 500: text, at most 128 characters | no |
label | text, at most 200 characters | no |
loading | true or false | no |
empty | text, at most 200 characters | no |
Tells the app: sort, filter, page, columns, select.
bry-field
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
label | text, at most 200 characters | yes |
description | text, at most 4,000 characters | no |
error | text, at most 200 characters | no |
required | true or false | no |
orientation | vertical, horizontal | no |
Tells the app nothing.
bry-input-group
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
value | text, at most 1,000 characters | no |
placeholder | text, at most 200 characters | no |
label | text, at most 200 characters | no |
kind | text, email, url, search | no |
icon | add, archive, calendar, check, copy, dismiss, docs, info, mail, members, notes, pin, rename, retry, search, settings, tasks, trash, account, activity, attach, bell, boardLayout, box, branch, calendarRange, channel, chart, cycle, download, externalLink, flag, ganttLayout, history, home, inbox, layers, link, listLayout, lock, maximise, panelRight, pause, play, progress, project, relation, sliders, tableLayout, tag, target, temporary, userAdd, status, filter, stateReview, swimlaneLayout | no |
prefix | text, at most 24 characters | no |
suffix | text, at most 24 characters | no |
action | text, at most 200 characters | no |
actionIcon | add, archive, calendar, check, copy, dismiss, docs, info, mail, members, notes, pin, rename, retry, search, settings, tasks, trash, account, activity, attach, bell, boardLayout, box, branch, calendarRange, channel, chart, cycle, download, externalLink, flag, ganttLayout, history, home, inbox, layers, link, listLayout, lock, maximise, panelRight, pause, play, progress, project, relation, sliders, tableLayout, tag, target, temporary, userAdd, status, filter, stateReview, swimlaneLayout | no |
maxLength | a whole number from 1 to 1000 | no |
disabled | true or false | no |
error | text, at most 200 characters | no |
Tells the app: change, submit, action.
bry-input-otp
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
value | text, at most 8 characters | no |
length | a whole number from 4 to 8 | no |
pattern | digits, alphanumeric | no |
label | text, at most 200 characters | yes |
disabled | true or false | no |
error | text, at most 200 characters | no |
Tells the app: change, complete.
bry-menubar
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
menus | a list of at most 8: a record of id, label, items (needs id, label, items) | yes |
label | text, at most 200 characters | yes |
Tells the app: select.
bry-native-select
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
value | text, at most 200 characters | no |
options | at most 100 { value, label } choices | yes |
placeholder | text, at most 200 characters | no |
label | text, at most 200 characters | no |
size | sm, md | no |
disabled | true or false | no |
error | text, at most 200 characters | no |
Tells the app: change.
bry-section-menu
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
sections | a list of at most 8: a record of id, label, entries, disabled (needs id, label) | yes |
current | text, at most 128 characters | no |
label | text, at most 200 characters | yes |
Tells the app: select.
bry-pagination
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
page | a whole number from 1 to 100000 | yes |
count | a whole number from 1 to 100000 | yes |
label | text, at most 200 characters | no |
disabled | true or false | no |
Tells the app: page.
bry-questionnaire
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
title | text, at most 200 characters | no |
questions | a list of at most 50: a record of id, kind, prompt, description, choices, required, scale, placeholder (needs id, kind, prompt) | yes |
action | text, at most 200 characters | no |
working | true or false | no |
error | text, at most 200 characters | no |
Tells the app: answer, step, submit.
bry-radio-group
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
value | text, at most 200 characters | no |
options | at most 20 { value, label } choices | yes |
label | text, at most 200 characters | yes |
orientation | vertical, horizontal | no |
variant | default, swatches | no |
disabled | true or false | no |
error | text, at most 200 characters | no |
Tells the app: change.
bry-slider
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
value | a whole number from -1000000 to 1000000 | no |
min | a whole number from -1000000 to 1000000 | no |
max | a whole number from -1000000 to 1000000 | no |
step | a whole number from 1 to 1000000 | no |
label | text, at most 200 characters | yes |
disabled | true or false | no |
error | text, at most 200 characters | no |
Tells the app: change, commit.
bry-toggle
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
pressed | true or false | no |
label | text, at most 200 characters | yes |
icon | add, archive, calendar, check, copy, dismiss, docs, info, mail, members, notes, pin, rename, retry, search, settings, tasks, trash, account, activity, attach, bell, boardLayout, box, branch, calendarRange, channel, chart, cycle, download, externalLink, flag, ganttLayout, history, home, inbox, layers, link, listLayout, lock, maximise, panelRight, pause, play, progress, project, relation, sliders, tableLayout, tag, target, temporary, userAdd, status, filter, stateReview, swimlaneLayout, more, close, arrowRight, chevronRight, chevronDown, chevronUp | no |
hideLabel | true or false | no |
variant | default, outline | no |
size | sm, md | no |
disabled | true or false | no |
Tells the app: change.
bry-toggle-group
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
type | single, multiple | no |
items | a list of at most 12: a record of value, label, icon, hideLabel, disabled (needs value, label) | yes |
values | a list of at most 12: text, at most 128 characters | no |
label | text, at most 200 characters | yes |
variant | default, outline, chips | no |
size | sm, md | no |
disabled | true or false | no |
Tells the app: change.
bry-accordion
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
sections | a list of at most 20: a record of id, title, disabled (needs id, title) | yes |
expanded | a list of at most 20: text, at most 128 characters | no |
multiple | true or false | no |
Tells the app: change.
bry-alert
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
title | text, at most 200 characters | yes |
description | text, at most 4,000 characters | no |
tone | neutral, brand, success, warn, danger | no |
Tells the app nothing.
bry-alert-dialog
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
open | true or false | no |
title | text, at most 200 characters | yes |
description | text, at most 4,000 characters | no |
action | text, at most 200 characters | yes |
tone | default, danger | no |
cancel | text, at most 200 characters | no |
Tells the app: action, close.
bry-aspect-ratio
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
ratio | 21:9, 16:9, 3:2, 4:3, 1:1, 3:4, 2:3, 9:16 | no |
Tells the app nothing.
bry-attachment
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
name | text, at most 200 characters | yes |
kind | document, spreadsheet, presentation, pdf, image, video, audio, code, archive, folder, other | no |
bytes | a whole number from 0 to 2000000000 | no |
pressable | true or false | no |
removable | true or false | no |
Tells the app: open, remove.
bry-breadcrumb
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
items | a list of at most 8: a record of id, label (needs id, label) | yes |
Tells the app: select.
bry-bubble
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
text | text, at most 4,000 characters | no |
from | self, other | no |
Tells the app nothing.
bry-carousel
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
label | text, at most 200 characters | yes |
index | a whole number from 0 to 49 | no |
Tells the app: change.
bry-chart
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
kind | bar, line, area, pie | yes |
label | text, at most 200 characters | yes |
categories | a list of at most 60: text, at most 200 characters | yes |
series | a list of at most 6: a record of name, values (needs name, values) | yes |
decimals | a whole number from 0 to 4 | no |
stacked | true or false | no |
loading | true or false | no |
empty | text, at most 200 characters | no |
Tells the app nothing.
bry-collapsible
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
title | text, at most 200 characters | yes |
open | true or false | no |
Tells the app: change.
bry-direction
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
dir | ltr, rtl | yes |
Tells the app nothing.
bry-drawer
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
open | true or false | no |
title | text, at most 200 characters | yes |
description | text, at most 4,000 characters | no |
Tells the app: close.
bry-hover-card
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
side | top, bottom | no |
Tells the app: open, close.
bry-item
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
title | text, at most 200 characters | no |
description | text, at most 200 characters | no |
icon | add, archive, calendar, check, copy, dismiss, docs, info, mail, members, notes, pin, rename, retry, search, settings, tasks, trash, account, activity, attach, bell, boardLayout, box, branch, calendarRange, channel, chart, cycle, download, externalLink, flag, ganttLayout, history, home, inbox, layers, link, listLayout, lock, maximise, panelRight, pause, play, progress, project, relation, sliders, tableLayout, tag, target, temporary, userAdd, status, filter, stateReview, swimlaneLayout | no |
variant | default, outline, muted | no |
size | sm, md | no |
pressable | true or false | no |
loading | true or false | no |
Tells the app: press.
bry-kbd
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
text | text, at most 40 characters | yes |
Tells the app nothing.
bry-marker
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
text | text, at most 200 characters | yes |
tone | neutral, brand, success, warn, danger | no |
Tells the app nothing.
bry-message
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
name | text, at most 200 characters | yes |
meta | text, at most 200 characters | no |
from | self, other | no |
status | sent, sending, failed | no |
Tells the app: retry.
bry-message-scroller
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
label | text, at most 200 characters | yes |
more | true or false | no |
loading | true or false | no |
empty | text, at most 200 characters | no |
Tells the app: more.
bry-popover
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
open | true or false | no |
title | text, at most 200 characters | no |
side | top, bottom | no |
align | start, center, end | no |
Tells the app: open, close.
bry-progress
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
value | a whole number from 0 to 100 | no |
label | text, at most 200 characters | yes |
Tells the app nothing.
bry-scroll-area
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
label | text, at most 200 characters | yes |
size | sm, md, lg | no |
Tells the app nothing.
bry-separator
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
orientation | horizontal, vertical | no |
Tells the app nothing.
bry-sheet
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
open | true or false | no |
title | text, at most 200 characters | yes |
description | text, at most 4,000 characters | no |
side | start, end | no |
Tells the app: close.
bry-spinner
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
label | text, at most 200 characters | no |
size | sm, md, lg | no |
Tells the app nothing.
bry-tabs
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
tabs | a list of at most 12: a record of id, label, disabled (needs id, label) | yes |
value | text, at most 128 characters | no |
label | text, at most 200 characters | no |
variant | segmented, line | no |
Tells the app: change.
bry-tooltip
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
text | text, at most 200 characters | yes |
side | top, bottom | no |
Tells the app nothing.
bry-glyph
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
kind | state, priority, progress, dot | yes |
value | a whole number from 0 to 100 | no |
group | backlog, unstarted, started, completed, cancelled | no |
priority | urgent, high, medium, low, none | no |
tone | neutral, brand, success, warn, danger | no |
hue | gray, red, orange, yellow, green, teal, blue, indigo, purple, pink | no |
size | sm, md | no |
label | text, at most 200 characters | no |
Tells the app nothing.
bry-property
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
kind | state, priority, members, labels, date, choice | yes |
display | badge, icon, dot, pill, button | no |
label | text, at most 200 characters | yes |
value | text, at most 128 characters | no |
values | a list of at most 200: text, at most 128 characters | no |
options | a list of at most 200: a record of value, label, tone, hue, group, mark (needs value, label) | no |
placeholder | text, at most 200 characters | no |
max | a whole number from 1 to 5 | no |
clearable | true or false | no |
due | true or false | no |
disabled | true or false | no |
more | a list of at most 3: a record of id, label (needs id, label) | no |
Tells the app: change, more.
bry-quick-add
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
trigger | text, at most 200 characters | yes |
placeholder | text, at most 200 characters | no |
hint | text, at most 200 characters | no |
open | true or false | no |
busy | true or false | no |
value | text, at most 200 characters | no |
variant | row, card, link | no |
Tells the app: open, submit, cancel.
bry-work-card
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
title | text, at most 200 characters | yes |
identifier | text, at most 200 characters | no |
priority | urgent, high, medium, low, none | no |
description | text, at most 200 characters | no |
project | text, at most 200 characters | no |
labels | a list of at most 12: a record of label, tone, hue (needs label) | no |
assignees | a list of at most 20: a record of id, name (needs id, name) | no |
due | text, at most 10 characters | no |
updated | text, at most 40 characters | no |
progress | a record of done, total (needs done, total) | no |
lead | true or false | no |
menu | a list of at most 60: a record of id, label, icon, tone, separator, disabled, checked, parent (needs id, label) | no |
loading | true or false | no |
Tells the app: press, select.
bry-page-header
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
title | text, at most 200 characters | yes |
icon | add, archive, calendar, check, copy, dismiss, docs, info, mail, members, notes, pin, rename, retry, search, settings, tasks, trash, account, activity, attach, bell, boardLayout, box, branch, calendarRange, channel, chart, cycle, download, externalLink, flag, ganttLayout, history, home, inbox, layers, link, listLayout, lock, maximise, panelRight, pause, play, progress, project, relation, sliders, tableLayout, tag, target, temporary, userAdd, status, filter, stateReview, swimlaneLayout, more, close, arrowRight, chevronRight, chevronDown, chevronUp | no |
subtitle | text, at most 200 characters | no |
back | true or false | no |
count | a whole number from 0 to 1000000 | no |
crumbs | a list of at most 4: a record of id, label, icon, initial (needs id, label) | no |
badges | a list of at most 3: a record of text, tone (needs text) | no |
tabs | a list of at most 12: a record of id, label, icon, count (needs id, label) | no |
tab | text, at most 128 characters | no |
size | sm, md | no |
Tells the app: back, crumb, tab.
bry-entity-row
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
title | text, at most 200 characters | yes |
description | text, at most 200 characters | no |
meta | text, at most 200 characters | no |
dateRange | text, at most 200 characters | no |
leading | status, ring, tile, none | no |
status | draft, upcoming, active, completed, cancelled, backlog, planned, started, paused, pending, accepted, declined, snoozed, duplicate | no |
statusLabel | text, at most 200 characters | no |
tone | neutral, brand, success, warn, danger | no |
icon | add, archive, calendar, check, copy, dismiss, docs, info, mail, members, notes, pin, rename, retry, search, settings, tasks, trash, account, activity, attach, bell, boardLayout, box, branch, calendarRange, channel, chart, cycle, download, externalLink, flag, ganttLayout, history, home, inbox, layers, link, listLayout, lock, maximise, panelRight, pause, play, progress, project, relation, sliders, tableLayout, tag, target, temporary, userAdd, status, filter, stateReview, swimlaneLayout, more, close, arrowRight, chevronRight, chevronDown, chevronUp | no |
ring | a whole number from 0 to 100 | no |
metrics | a list of at most 4: a record of label, value, ring (needs label, value) | no |
menu | a list of at most 60: a record of id, label, icon, tone, separator, disabled, checked, parent (needs id, label) | no |
rail | a record of month, day, active | no |
highlighted | true or false | no |
selected | true or false | no |
pressable | true or false | no |
expandable | true or false | no |
expanded | true or false | no |
loading | true or false | no |
Tells the app: press, select, toggle.
bry-filter-menu
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
label | text, at most 200 characters | no |
facets | a list of at most 8: a record of id, label, icon, kind, search, options (needs id, label) | yes |
values | a list of at most 8: a record of facet, values (needs facet) | no |
Tells the app: change, reset.
bry-gantt
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
start | text, at most 10 characters | no |
zoom | day, week, month, quarter | no |
rows | a list of at most 500: a record of id, title, identifier, mark, tone, priority, assignee, start, end, group, progress (needs id, title) | no |
showCompleted | true or false | no |
empty | text, at most 200 characters | no |
loading | true or false | no |
zooms | a list of at most 4: day, week, month, quarter | no |
editable | true or false | no |
paneLabel | text, at most 200 characters | no |
completedLabel | text, at most 200 characters | no |
Tells the app: press, navigate, zoom, completed, reschedule.
bry-timeline
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
collapsedLabel | text, at most 200 characters | no |
folded | true or false | no |
empty | text, at most 200 characters | no |
loading | true or false | no |
Tells the app: expand.
bry-timeline-item
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
actor | text, at most 200 characters | no |
actorId | text, at most 128 characters | no |
text | text, at most 200 characters | yes |
mark | status, priority, assignee, date, title, description, duplicate, created, comment | no |
tone | neutral, brand, success, warn, danger | no |
time | text, at most 40 characters | no |
count | a whole number from 1 to 9999 | no |
Tells the app nothing.
bry-comment
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
author | text, at most 200 characters | no |
authorId | text, at most 128 characters | no |
time | text, at most 40 characters | no |
edited | true or false | no |
deleted | true or false | no |
resolved | true or false | no |
resolution | true or false | no |
depth | a whole number from 0 to 1 | no |
collapsed | true or false | no |
replies | a whole number from 0 to 9999 | no |
repliers | a list of at most 12: a record of id, name (needs id, name) | no |
actions | a list of at most 8: reply, quote, edit, resolve, copy, copyLink, subIssue, delete | no |
highlighted | true or false | no |
loading | true or false | no |
anchor | text, at most 128 characters | no |
quote | text, at most 4,000 characters | no |
orphaned | true or false | no |
Tells the app: action, toggle.
bry-page-tree
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
label | text, at most 200 characters | no |
items | a list of at most 2,000: a record of id, parent, label, emoji, hasChildren, muted (needs id, label) | no |
selected | text, at most 128 characters | no |
keep | text, at most 128 characters | no |
draggable | true or false | no |
actions | a list of at most 8: open, newChild, rename, duplicate, move, copyLink, export, delete | no |
addable | true or false | no |
settled | text, at most 128 characters | no |
loading | true or false | no |
empty | text, at most 200 characters | no |
Tells the app: select, expand, move, action, add.
bry-comment-margin
Holds other elements or text.
No settings.
Tells the app nothing.
bry-history
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
bind | a record of collection, id (needs collection, id) | yes |
field | text, at most 40 characters | no |
label | text, at most 200 characters | no |
forkable | true or false | no |
Tells the app: restored, fork.
bry-reactions
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
items | a list of at most 24: a record of emoji, count, mine (needs emoji) | no |
choices | a list of at most 48: text, at most 16 characters | no |
disabled | true or false | no |
Tells the app: toggle.
bry-peek
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
open | true or false | no |
label | text, at most 200 characters | yes |
position | text, at most 200 characters | no |
previous | true or false | no |
next | true or false | no |
Tells the app: previous, next, expand, close.
bry-spreadsheet
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
label | text, at most 200 characters | no |
columns | a list of at most 16: a record of key, heading, width, pinned, sortable, hideable, movable, resizable (needs key, heading) | yes |
sort | a record of key, direction (needs key, direction) | no |
selectable | true or false | no |
selected | a whole number from 0 to 100000 | no |
total | a whole number from 0 to 100000 | no |
loading | true or false | no |
empty | text, at most 200 characters | no |
Tells the app: sort, hide, all, reorder.
bry-datagrid
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
label | text, at most 200 characters | no |
columns | a list of at most 200: a record of key, heading, type, width, readOnly, primary, precision, symbol, max, choices, statistic, description (needs key, heading, type) | yes |
rows | a list of at most 500: a record of id, cells (needs id, cells) | no |
offset | a whole number from 0 to 50000 | no |
total | a whole number from 0 to 50000 | no |
groups | a list of at most 500: a record of at, label, count, depth (needs at, label) | no |
frozen | a whole number from 0 to 10 | no |
lines | one, two, three, four | no |
editable | true or false | no |
addable | true or false | no |
selectable | true or false | no |
selected | a list of at most 500: text, at most 128 characters | no |
sort | a record of key, direction (needs key, direction) | no |
search | text, at most 200 characters | no |
loading | true or false | no |
empty | text, at most 200 characters | no |
Tells the app: edit, add, open, expand, select, column, sort, reorder, delete, range.
bry-spreadsheet-row
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
label | text, at most 200 characters | no |
checked | true or false | no |
depth | a whole number from 0 to 4 | no |
expandable | true or false | no |
expanded | true or false | no |
loading | true or false | no |
Tells the app: toggle, expand.
bry-spreadsheet-group
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
label | text, at most 200 characters | yes |
mark | backlog, unstarted, started, completed, cancelled, review, blocked, urgent, high, medium, low, none, person, dot | no |
tone | neutral, brand, success, warn, danger | no |
count | a whole number from 0 to 100000 | no |
collapsed | true or false | no |
Tells the app: toggle.
bry-rich-text
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
value | text, at most 50,000 characters | no |
placeholder | text, at most 200 characters | no |
label | text, at most 200 characters | no |
variant | document, comment, bare | no |
mentions | a list of at most 200: a record of value, label (needs value, label) | no |
disabled | true or false | no |
autofocus | true or false | no |
error | text, at most 200 characters | no |
attachments | true or false | no |
mentionAll | true or false | no |
places | true or false | no |
references | a list of at most 500: a record of value, label, create (needs value, label) | no |
bind | a record of collection, id, field (needs collection, id, field) | no |
hide | a list of at most 13: headings, lists, tasks, quote, code, table, maths, callout, toggle, divider, highlight, scripts, align | no |
comments | true or false | no |
activeComment | text, at most 128 characters | no |
resolvedComments | a list of at most 1,000: text, at most 128 characters | no |
removedComments | a list of at most 1,000: text, at most 128 characters | no |
Tells the app: change, blur, submit, comment, focuscomment, anchors, createreference.
bry-whiteboard
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
bind | a record of collection, id, field (needs collection, id, field) | yes |
size | sm, md, lg | no |
fill | true or false | no |
readonly | true or false | no |
label | text, at most 200 characters | no |
mode | board, diagram | no |
ops | a list of at most 50: a record of id, kind, source, x, y (needs id, kind, source) | no |
cards | a list of at most 200: a record of card, ref, title, meta, status (needs card, ref, title) | no |
library | text, at most 100,000 characters | no |
hidden | true or false | no |
voting | true or false | no |
marks | a list of at most 500: a record of element, label (needs element, label) | no |
summon | a whole number from 0 to 9007199254740991 | no |
commenting | true or false | no |
pins | a list of at most 500: a record of id, x, y, element, label, active, resolved (needs id, x, y) | no |
exportId | text, at most 128 characters | no |
Tells the app: change, applied, select, librarychange, vote, pin, focuspin, orphans, opencard, export, error.
bry-board-preview
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
bind | a record of collection, id, field (needs collection, id, field) | yes |
label | text, at most 200 characters | no |
Tells the app nothing.
bry-approval
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
request | text, at most 128 characters | yes |
compact | true or false | no |
Tells the app: decided.
bry-board-lane
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
title | text, at most 200 characters | yes |
mark | backlog, unstarted, started, completed, cancelled, review, blocked, urgent, high, medium, low, none, person, dot | no |
tone | neutral, brand, success, warn, danger | no |
count | a whole number from 0 to 100000 | no |
collapsible | true or false | no |
collapsed | true or false | no |
openable | true or false | no |
openLabel | text, at most 200 characters | no |
Tells the app: toggle, open.
bry-property-list
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
title | text, at most 200 characters | no |
collapsible | true or false | no |
collapsed | true or false | no |
Tells the app: toggle.
bry-property-row
Holds other elements or text.
| Setting | Takes | Needed |
|---|---|---|
label | text, at most 200 characters | yes |
icon | add, archive, calendar, check, copy, dismiss, docs, info, mail, members, notes, pin, rename, retry, search, settings, tasks, trash, account, activity, attach, bell, boardLayout, box, branch, calendarRange, channel, chart, cycle, download, externalLink, flag, ganttLayout, history, home, inbox, layers, link, listLayout, lock, maximise, panelRight, pause, play, progress, project, relation, sliders, tableLayout, tag, target, temporary, userAdd, status, filter, stateReview, swimlaneLayout, more, close, arrowRight, chevronRight, chevronDown, chevronUp | no |
readonly | true or false | no |
Tells the app nothing.
bry-keys
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
bindings | a list of at most 20: a record of key, label (needs key, label) | yes |
Tells the app: press.
bry-filter-chip
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
label | text, at most 200 characters | yes |
icon | add, archive, calendar, check, copy, dismiss, docs, info, mail, members, notes, pin, rename, retry, search, settings, tasks, trash, account, activity, attach, bell, boardLayout, box, branch, calendarRange, channel, chart, cycle, download, externalLink, flag, ganttLayout, history, home, inbox, layers, link, listLayout, lock, maximise, panelRight, pause, play, progress, project, relation, sliders, tableLayout, tag, target, temporary, userAdd, status, filter, stateReview, swimlaneLayout, more, close, arrowRight, chevronRight, chevronDown, chevronUp | no |
text | text, at most 200 characters | no |
marks | a list of at most 4: a record of mark, tone, hue, name (needs mark) | no |
Tells the app: press, remove.
bry-calendar-view
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
view | day, week, month, agenda | no |
date | text, at most 10 characters | no |
zone | text, at most 64 characters | no |
secondzone | text, at most 64 characters | no |
events | a list of at most 2,000: a record of id, title, start, end, allday, hue, editable, busy, tentative, cancelled, meta (needs id, start, end) | no |
shaded | a list of at most 500: a record of start, end, label, hue (needs start, end) | no |
workday | a record of days, start, end (needs start, end) | no |
creatable | true or false | no |
slotminutes | a whole number from 5 to 60 | no |
settled | text, at most 128 characters | no |
loading | true or false | no |
empty | text, at most 200 characters | no |
Tells the app: select, create, move, resize, navigate, pick.
bry-box
Holds other elements or text.
No settings.
Tells the app nothing.
bry-canvas
Holds nothing: it is drawn from its settings alone.
| Setting | Takes | Needed |
|---|---|---|
label | text, at most 200 characters | yes |
view | a record of w, h (needs w, h) | yes |
focusable | true or false | no |
ops | a list of at most 2,000: a record of kind, x, y, w, h, x2, y2, r, round, d, text, fill, stroke, line, points, weight, align, opacity (needs kind) | no |
Tells the app: pointer, key.