A card based single select field.
Props
cardParts
Parts in the card, to be exported on the top level.
string[]
[]
checkIcon
Icon to display when checked.
[namespace: stringor
symbol, name: string]or
string
[ICON_NAMESPACE, check]
disabled
If the field is disabled.
booleanor
undefined
documentation
Inline documentation text.
stringor
undefined
documentationLink
Inline documentation link.
stringor
undefined
documentationLinkText
Inline documentation link text.
stringor
undefined
groupBy
Group the cards by a key.
stringor
undefined
invalid
If the field is currently invalid.
booleanor
undefined
label
The label of the field.
string
messages
The messages to display under the field.
ValidationMessagesor
undefined
name
The name of the input.
string
options
The options to be displayed and chosen from.
RadioCardOption[]
placeholder
The placeholder to show if there are no options.
stringor
undefined
renderCard
Overwrite the default card renderer
((h: typeof h, option: any, active: boolean) => stringor
VNodeor
VNode[]or
null)or
undefined
templated
If the field is templated.
no-editor
booleanor
undefined
value
The current value of the input.
nullor
string
ValidationMessages
RadioCardOption
An option to be selected
A longer description to be displayed.
If the option is disabled.
A name to display.
The string to be used as a value.
Events
fieldchange
FieldChange<string, string>
Emitted when the value of the field is changed.
requestEdit
string
Emitted when the user requests to edit.
Parts
The title of a card group.