What does the component do?
The Radio-Button-Panel has the same function as the Radio-Button. In addition to the normal Radio-Button, the Radio-Button-Panel offers the option of displaying subtexts, Card-Badges or Icons.
When should the component be used?
- When users should make a selection from a limited number of options.
- When only one option may be selected from several possible options.
- If the Radio-Button-Panel fits better into the layout than the normal Radio-Button.
- If further content (such as icons, texts, card badges) is required or the options of the normal checkbox are not enough to optimally describe the selection.
- If content of your choice is to be displayed below the Checkbox-Panel. For technical implementation, see "Selection-Expansion-Panel".
Rules
- Radio-Button-Panels should be used in groups (radio-button-group) to provide a clear choice.
- Each option within a radio-button-group should be clearly labelled and easy to understand.
- Avoid placing too many options in a radio button group to ensure clarity and to make selection easier.
- Avoid too much content in the Radio-Button-Panel to ensure readability and clarity.
| Number | Type | Description | Optional | Info |
|---|---|---|---|---|
| 1 | Text | Label | No | |
| 2 | Text | Subtext | Yes | |
| 3 | Slot | Suffix | Yes | |
| 3a | Component | sbb-icon | Yes | |
| 3b | Text | Yes | ||
| 4 | Component | sbb-card-badge | Yes |
Playground
The sbb-radio-button-panel component provides the same functionality as a native <input type="radio"/> enhanced with the selection panel design and functionalities.
Radio-buttons should typically be placed inside a sbb-radio-button-group component
in order to display a radio input within a group. Individual radio-buttons inside a radio-group will inherit the name of the group.
<sbb-radio-button-group name="radio-group" value="Value one" aria-label="Radio group label">
<sbb-radio-button-panel value="Value one">Option one</sbb-radio-button-panel>
<sbb-radio-button-panel value="Value two">Option two</sbb-radio-button-panel>
</sbb-radio-button-group>
In cases where that's not possible, you can define a group of radios using the same name property
<sbb-radio-button-panel name="radio-group" value="Value one">Option one</sbb-radio-button-panel>
<sbb-radio-button-panel name="radio-group" value="Value two">Option two</sbb-radio-button-panel>
Slots
It is possible to provide a label via an unnamed slot;
additionally the slots named subtext can be used to provide a subtext and
the slot named suffix can be used to provide suffix items.
If you use a badge is automatically assigned.
<sbb-radio-button-panel>
<sbb-card-badge>%</sbb-card-badge>
Label
<span slot="subtext">Subtext</span>
<span slot="suffix">Suffix</span>
</sbb-radio-button-panel>
States
It is possible to display the component in disabled or checked state by using the self-named properties.
The allowEmptySelection property allows user to deselect the component.
<sbb-radio-button-panel value="One" checked>Option one</sbb-radio-button-panel>
<sbb-radio-button-panel value="Two" disabled>Option two</sbb-radio-button-panel>
<sbb-radio-button-panel value="Three" allowEmptySelection>Option three</sbb-radio-button-panel>
Style
The component has three different sizes, which can be changed using the size property (m, which is the default and s).
If used inside a sbb-radio-button-group, the size will be inherited from it.
<sbb-radio-button-panel size="s">Size</sbb-radio-button-panel>
The component's label can be displayed in bold using the sbb-text--bold class on a wrapper tag:
<sbb-radio-button-panel value="bold">
<span class="sbb-text--bold">Bold label</span>
</sbb-radio-button-panel>
Complex Values
This component supports any types of values, including complex objects.
The type can be specified using the generic type parameter T of SbbRadioButtonPanel<T>.
<sbb-radio-button-panel .value=${{value: 'value', name: 'name'}} name="name">Option</sbb-radio-button-panel>
Properties
| Name | Attribute | Privacy | Type | Default | Description |
|---|---|---|---|---|---|
allowEmptySelection | allow-empty-selection | public | boolean | false | Whether the radio can be deselected. |
borderless | borderless | public | boolean | false | Whether the unselected panel has a border. |
checked | checked | public | boolean | false | Whether the radio button is checked. |
color | color | public | 'white' | 'milk' | 'white' | The background color of the panel. |
disabled | disabled | public | boolean | false | Whether the component is disabled. |
form | - | public | HTMLFormElement | null | Returns the form owner of this element. | |
group | - | public | SbbRadioButtonGroupElement | null | null | Reference to the connected radio button group. |
name | name | public | string | Name of the form element. Will be read from name attribute. | |
required | required | public | boolean | false | Whether the component is required. |
size | size | public | SbbCheckboxSize | SbbRadioButtonSize | 'm' / 'xs' (lean) | Size variant, either xs, s or m. |
type | - | public | string | 'radio' | Form type of element. |
validationMessage | - | public | string | Returns the current error message, if available, which corresponds to the current validation state. Please note that only one message is returned at a time (e.g. if multiple validity states are invalid, only the chronologically first one is returned until it is fixed, at which point the next message might be returned, if it is still applicable). Also, a custom validity message (see below) has precedence over native validation messages. | |
validity | - | public | ValidityState | Returns the ValidityState object for this element. | |
value | value | public | (T = string) | null | null | The value of the form element |
willValidate | - | public | boolean | Returns true if this element will be validated when the form is submitted; false otherwise. |
Methods
| Name | Privacy | Description | Parameters | Return | Inherited From |
|---|---|---|---|---|---|
checkValidity | public | Returns true if this element has no validity problems; false otherwise. Fires an invalid event at the element in the latter case. | boolean | SbbFormAssociatedMixin | |
reportValidity | public | Returns true if this element has no validity problems; otherwise, returns false, fires an invalid event at the element, and (if the event isn't canceled) reports the problem to the user. | boolean | SbbFormAssociatedMixin | |
select | public | Set the radio-button as 'checked'; if 'allowEmptySelection', toggle the checked property. In both cases it emits the change events. | void | SbbRadioButtonCommonElementMixin | |
setCustomValidity | public | Sets the custom validity message for this element. Use the empty string to indicate that the element does not have a custom validity error. | message: string | void | SbbFormAssociatedMixin |
Events
| Name | Type | Description | Inherited From |
|---|---|---|---|
change | Event | The change event is fired when the user modifies the element's value. Unlike the input event, the change event is not necessarily fired for each alteration to an element's value. | SbbFormAssociatedRadioButtonMixin |
input | InputEvent | The input event fires when the value has been changed as a direct result of a user action. | SbbFormAssociatedRadioButtonMixin |
Slots
| Name | Description |
|---|---|
| Use the unnamed slot to add content to the radio label. | |
badge | Use this slot to provide a sbb-card-badge (optional). |
subtext | Slot used to render a subtext under the label. |
suffix | Slot used to render additional content after the label. |