Skip to content

Report a problem:

Problems can be reported via Microsoft Teams in your team channel within the "IT - Codey" team.

Please include the following information:

Report type:
Docs problem report a bug instead β†’
Path:
/latest/docs/components/form-controls/option-control.html
Message:

DESCRIBE THE PROBLEM BEFORE SUBMITTING TO CODEY

Option Control ​

The XerOptionControl helps to create a form layout for option input components like XerCheckbox and XerRadioButton. It facilitates the layout of the label and subcontent.

Usage ​

It has a default slot where the form component can be placed and used directly as child component. And it has the prop container to change the look and feel of the option input.

The Option Control expect the needed props and slots for the other components (label, caption and error).

js
import { XerOptionControl } from "@xerius/codey-components";

Showcases ​

With Radio Button ​

With Checkbox ​

With Info Tooltip ​

Props ​

NameTypeDefaultRequiredDescription
input-idStringtrueThe ID Value
dataAutomationIdString() => input-idfalseThe data automation id value
labelStringfalseThe label value.
captionStringfalseThe caption value.
containerBooleanfalsefalseIf set to true, it displays the child component in a container
tooltipStringfalseThe tooltip value.

Slots ​

The slots are provided to give you an alternative option to set the content of the component.

NamePurpose
defaultShowing the form component content
labelShowing the label content
subcontentShowing the subcontent

Automation Ids ​

A data-automation-id needs to be provided to the component as Prime Vue based components do not have a default data-automation-id.

Report a problem:

Problems can be reported via Microsoft Teams in your team channel within the "IT - Codey" team.

Please include the following information:

Report type:
Docs problem report a bug instead β†’
Path:
/latest/docs/components/form-controls/option-control.html
Message:

DESCRIBE THE PROBLEM BEFORE SUBMITTING TO CODEY

Last updated: