Skip to content

UI tags ​

Every ui:* tag the parser knows and every attribute it reads — read from the UI parser's code, so an attribute that is not here is not read. The Guide shows them at work: Building a UI.

Layout attributes ​

Every tag below that says so also takes these (UI-2 for the responsive ones):

AttributeTypeRequiredDefaultValues
gapstring
paddingstring
marginstring
alignstring
justifystring
widthstring
heightstring
backgroundstring
colorstring
borderstring
idstring
classstring
visiblestring
growstring
stack-belowstringsm, md, lg
hide-belowstringsm, md, lg
hide-abovestringsm, md, lg

Core

Drawn with the same meaning by the browser, the console and the desktop (UI-7).

ui:window ​

AttributeTypeRequiredDefaultValues
titlestring

Also takes the layout attributes, child elements.

Specified by: UI-4 · UI-7

ui:hbox ​

Takes the layout attributes, child elements.

Specified by: UI-2 · UI-7

ui:vbox ​

Takes the layout attributes, child elements.

Specified by: UI-7

ui:panel ​

AttributeTypeRequiredDefaultValues
titlestring
collapsiblebooleanfalse

Also takes the layout attributes, child elements.

Specified by: UI-7

ui:tabpanel ​

Takes the layout attributes, child elements.

Specified by: UI-7

ui:tab ​

AttributeTypeRequiredDefaultValues
titlestring

Also takes the layout attributes, child elements.

Specified by: UI-7

ui:grid ​

AttributeTypeRequiredDefaultValues
columnsstring

Also takes the layout attributes, child elements.

Specified by: UI-2 · UI-7

ui:section ​

AttributeTypeRequiredDefaultValues
titlestring
expandedbooleanfalse

Also takes the layout attributes, child elements.

Specified by: UI-7

ui:form ​

AttributeTypeRequiredDefaultValues
on-submitstring
withstring
rulesstringon, off
valuesstring
submitstring
validationstringboth
error-displaystringinline
novalidatebooleanfalse

Also takes the layout attributes, child elements, ui:validator children.

Specified by: UI-1 · UI-7 · UI-9 · UI-10 · UI-12 · UI-14

ui:formitem ​

AttributeTypeRequiredDefaultValues
labelstring

Also takes the layout attributes, child elements.

Specified by: UI-7

ui:spacer ​

AttributeTypeRequiredDefaultValues
sizestring

Also takes the layout attributes.

Specified by: UI-7

ui:scrollbox ​

Takes the layout attributes, child elements.

Specified by: UI-7

ui:text ​

AttributeTypeRequiredDefaultValues
sizestring
weightstring

Also takes the layout attributes, its text.

Specified by: UI-7

ui:button ​

AttributeTypeRequiredDefaultValues
on-clickstring
withstring
variantstring
disabledbooleanfalse

Also takes the layout attributes, its text.

Specified by: UI-1 · UI-5 · UI-7

ui:input ​

AttributeTypeRequiredDefaultValues
bindstring
valuestring
searchstring
delaynumber
placeholderstring
typestringtext
rowsnumber
acceptstring
on-changestring
on-submitstring
minstring
maxstring
patternstring
error-messagestring
minlengthnumber
maxlengthnumber
validatorsstring
requiredbooleanfalse

Also takes the layout attributes.

Specified by: UI-1 · UI-6 · UI-7 · UI-12 · UI-14

ui:checkbox ​

AttributeTypeRequiredDefaultValues
bindstring
checkedstring
labelstring

Also takes the layout attributes.

Specified by: UI-6 · UI-7

ui:radio ​

AttributeTypeRequiredDefaultValues
bindstring
valuestring
optionsstring

Also takes the layout attributes.

Specified by: UI-6 · UI-7 · UI-9

ui:switch ​

AttributeTypeRequiredDefaultValues
bindstring
checkedstring
labelstring

Also takes the layout attributes.

Specified by: UI-6 · UI-7

ui:select ​

AttributeTypeRequiredDefaultValues
bindstring
valuestring
optionsstring
sourcestring

Also takes the layout attributes, child elements.

Specified by: UI-6 · UI-7 · UI-9

ui:table ​

AttributeTypeRequiredDefaultValues
sourcestring
asstring
editstring
datasourcestring
sortbooleanfalse

Also takes the layout attributes, child elements.

Specified by: DEV-3 · LOOP-6 · UI-5 · UI-7 · UI-13

ui:column ​

AttributeTypeRequiredDefaultValues
keystring
labelstring
widthstring
alignstring
editbooleantrue

Also takes child elements.

Specified by: DEV-3 · UI-5 · UI-7

ui:pager ​

AttributeTypeRequiredDefaultValues
forstringyes
windownumber2
paramstringpage

Also takes the layout attributes.

Specified by: UI-7 · UI-11

ui:history ​

AttributeTypeRequiredDefaultValues
tablestringyes
keystringyes
datasourcestringyes
limitnumber50

Also takes the layout attributes.

Specified by: DB-11 · UI-7

ui:stream ​

AttributeTypeRequiredDefaultValues
forstringyes

Also takes the layout attributes.

Specified by: IA-7 · UI-7

ui:list ​

AttributeTypeRequiredDefaultValues
sourcestring
asstring

Also takes the layout attributes, child elements.

Specified by: DEV-3 · UI-5 · UI-7

ui:item ​

Takes the layout attributes, child elements.

Specified by: UI-7

ui:image ​

AttributeTypeRequiredDefaultValues
srcstring
altstring

Also takes the layout attributes.

Specified by: UI-7

AttributeTypeRequiredDefaultValues
tostring
externalbooleanfalse

Also takes the layout attributes, its text.

Specified by: UI-7

ui:progress ​

AttributeTypeRequiredDefaultValues
valuestring
maxstring

Also takes the layout attributes.

Specified by: UI-7

ui:option ​

AttributeTypeRequiredDefaultValues
valuestring
on-clickstring
labelstring

Also takes its text.

Specified by: UI-7

ui:header ​

AttributeTypeRequiredDefaultValues
titlestring

Also takes the layout attributes, its text, child elements.

Specified by: UI-7

Takes the layout attributes, its text, child elements.

Specified by: UI-7

ui:rule ​

No attributes, no content.

Specified by: UI-7

ui:badge ​

AttributeTypeRequiredDefaultValues
variantstring
colorstring

Also takes the layout attributes, its text.

Specified by: UI-7

ui:card ​

AttributeTypeRequiredDefaultValues
titlestring
subtitlestring
imagestring
variantstring

Also takes the layout attributes, child elements.

Specified by: UI-7

ui:card-header ​

Takes the layout attributes, child elements.

Specified by: UI-1 · UI-7

ui:card-body ​

Takes the layout attributes, child elements.

Specified by: UI-7

Takes the layout attributes, child elements.

Specified by: UI-7

ui:alert ​

AttributeTypeRequiredDefaultValues
titlestring
variantstringinfo
iconstring
dismissiblebooleanfalse

Also takes the layout attributes, its text, child elements.

Specified by: UI-7

Experimental

Browser only, with no stability promise: the console says it does not draw them (UI-7).

ui:accordion ​

Takes the layout attributes, child elements.

ui:dividedbox ​

AttributeTypeRequiredDefaultValues
directionstringhorizontal

Also takes the layout attributes, child elements.

ui:tree ​

AttributeTypeRequiredDefaultValues
sourcestring
on-selectstring

Also takes the layout attributes.

ui:menu ​

Takes the layout attributes, child elements.

ui:log ​

AttributeTypeRequiredDefaultValues
auto-scrollbooleantrue
max-linesnumber

Also takes the layout attributes.

ui:markdown ​

Takes the layout attributes, its text.

ui:loading ​

AttributeTypeRequiredDefaultValues
textstring

Also takes the layout attributes.

ui:validator ​

Inside: ui:form

AttributeTypeRequiredDefaultValues
namestring
fieldstring
typestring
patternstring
matchstring
minstring
maxstring
expressionstring
server-expressionstring
minlengthnumber
maxlengthnumber
messagestring
triggerstringsubmit

ui:animate ​

AttributeTypeRequiredDefaultValues
animatestring
transitionstring
typestring
durationstring
delaystring
easingstring
repeatstring
triggerstring
directionstring

Also takes the layout attributes, child elements.

ui:modal ​

AttributeTypeRequiredDefaultValues
titlestring
sizestring
modal-idstring
idstring
openbooleanfalse
closablebooleantrue

Also takes the layout attributes, child elements.

ui:chart ​

AttributeTypeRequiredDefaultValues
typestringbar
sourcestring
labelsstring
valuesstring
titlestring
colorsstring

Also takes the layout attributes.

ui:avatar ​

AttributeTypeRequiredDefaultValues
srcstring
namestring
sizestring
shapestringcircle
statusstring

Also takes the layout attributes.

ui:tooltip ​

AttributeTypeRequiredDefaultValues
positionstringtop
contentstring

Also takes the layout attributes, its text, child elements.

ui:dropdown ​

AttributeTypeRequiredDefaultValues
labelstring
triggerstringclick
alignstringleft

Also takes the layout attributes, child elements.

ui:breadcrumb ​

AttributeTypeRequiredDefaultValues
separatorstring/

Also takes the layout attributes, child elements.

ui:breadcrumb-item ​

AttributeTypeRequiredDefaultValues
tostring
iconstring
labelstring

Also takes its text.

ui:pagination ​

AttributeTypeRequiredDefaultValues
totalstring
page-sizestring10
currentstring1
bindstring
on-changestring
show-totalbooleanfalse
show-jumpbooleanfalse

Also takes the layout attributes.

ui:skeleton ​

AttributeTypeRequiredDefaultValues
variantstringtext
linesnumber1
animatedbooleantrue

Also takes the layout attributes.

ui:toast ​

AttributeTypeRequiredDefaultValues
variantstringinfo
positionstringtop-right
iconstring
titlestring
showstring
on-closestring
durationnumber3000
dismissiblebooleantrue
messagestring

Also takes the layout attributes, its text.

ui:toast-container ​

AttributeTypeRequiredDefaultValues
positionstringtop-right
max-toastsnumber5

Also takes the layout attributes.

AttributeTypeRequiredDefaultValues
animationstringslide
bindstring
on-changestring
auto-playbooleanfalse
intervalnumber5000
show-indicatorsbooleantrue
show-arrowsbooleantrue
loopbooleantrue
currentnumber0

Also takes the layout attributes, child elements.

ui:slide ​

Takes the layout attributes, child elements.

ui:stepper ​

AttributeTypeRequiredDefaultValues
orientationstringhorizontal
bindstring
on-changestring
on-completestring
currentnumber0
linearbooleantrue
show-labelsbooleantrue
clickablebooleanfalse

Also takes the layout attributes, child elements.

ui:step ​

AttributeTypeRequiredDefaultValues
titlestring
descriptionstring
iconstring
completedstring
errorstring
optionalbooleanfalse

Also takes the layout attributes, child elements.

ui:calendar ​

AttributeTypeRequiredDefaultValues
modestringsingle
valuestring
bindstring
min-datestring
max-datestring
disabled-datesstring
disabled-daysstring
localestringen
on-changestring
on-month-changestring
show-week-numbersbooleanfalse
first-day-of-weeknumber0
inlinebooleantrue

Also takes the layout attributes.

ui:date-picker ​

AttributeTypeRequiredDefaultValues
valuestring
bindstring
placeholderstringSelect date
formatstringYYYY-MM-DD
min-datestring
max-datestring
on-changestring
clearablebooleantrue
disabledbooleanfalse
requiredbooleanfalse

Also takes the layout attributes.

ui:theme ​

AttributeTypeRequiredDefaultValues
namestring
presetstringlight
auto-switchbooleanfalse

Also takes ui:color children.

ui:color ​

Inside: ui:theme

AttributeTypeRequiredDefaultValues
namestring
valuestring

MIT Licensed · Built with VitePress