Themes
Fields/Components/es-radio-card-group
es-radio-card-group

A card based single select input.

Props

Name
Description
Type
Default
groupBy

Group the cards by a key.

string
or
undefined
icon

Icon to display when checked.

[namespace: string
or
symbol, name: string]
or
string
[ICON_NAMESPACE, check]
invalid

If the field is currently in an error state.

boolean
false
labelledby

The id of the component that labels this input. This input doesn't bring its own label, so must be labeled externally and referenced here.

string
messages

The validation messages of the field

ValidationMessages
or
undefined
name

The name of the field.

string
options

The options to be displayed and chosen from.

RadioCardGroupOption[]
renderCard

Overwrite the default card renderer

(h: typeof h, option: any, active: boolean) => string
or
VNode
or
VNode[]
or
null
RadioCardGroup.defaultRenderCard
value

The current value of the field.

null
or
string

ValidationMessages

Name
Description
Type
children
Record<number, Record<Severity, ValidationMessage[]>>
error
ValidationMessage[]
info
ValidationMessage[]
warning
ValidationMessage[]

RadioCardGroupOption

An option to be selected

Name
Description
Type
description

A longer description to be displayed.

string
disabled

If the option is disabled.

boolean
name

A name to display.

string
value

The string to be used as a value.

string

Events

Event
Detail
Description
fieldchange
FieldChange<string | null>

Emitted when the value of the field is changed.

Parts

Name
Description
group-title

The title of a card group.