RadioButtonGroup
RadioButtonsGroup são radio buttons customizados para facilitar a seleção e feedback.
Quando usar:
- As opções que o componente busca prover são mutuamente exclusivas.
- For necessário utilizar um
<input type="radio"
/>.
Quando não usar:
- Duas ou mais opções puderem ser selecionadas ao mesmo tempo.
- Houver 4 ou mais opções. Prefira Dropdowns nesses casos.
Obs.:
- Você pode desabilitar cada um dos radio buttons passando a propriedade
disable: true
, no respectivo objeto no array de opções. Caso você queira desabilitar todo o grupo, você pode setar a propdisabled
como true no componente.
Uso
js
<CdsRadioButtonGroup
:options="options"
:value="value"
/>
Preview
Opção habilitada 1
Opção habilitada 2
Mostrar log
⚡Nenhum evento foi disparado
Props
Nome | Tipo | Default | Opções | Descrição |
---|---|---|---|---|
label | string | 'Label' | -- | Especifica o título do grupo de radio buttons |
required | boolean | false | -- | Especifica se o grupo de radio buttons é obrigatório |
* options (required) | array | [] | -- | Define a quantidade de radio buttons a serem renderizados no grupo. Espera um array de objetos contendo, no mínimo, as propriedades `text` e `value`. Agora, a propriedade `label` também é suportada e pode ser usada no lugar de `text`. Na versão 4, apenas `label` e `value` serão aceitos. |
disabled | boolean | false | -- | Controla o status do grupo de radio buttons |
inline | boolean | false | -- | Quando verdadeira, faz com que os radio buttons sejam renderizados um ao lado do outro |
allowsExpand Deprecated | boolean | false | -- | Essa prop vai ser substituída pela prop `fluid` na v4. Quando verdadeiro, faz com que o button se adapte a expansão, podendo agora, adicionar uma descrição |
fluid | boolean | false | -- | Quando verdadeiro, faz com que o button se adapte a expansão, podendo agora, adicionar uma descrição |
state | string | 'default' | default valid loading invalid | Especifica o estado do RadioButtonGroup. As opções são 'default', 'valid', 'loading' e 'invalid'. |
errorMessage | string | 'Valor inválido' | -- | Especifica a mensagem de erro, que será exibida caso o estado seja inválido |
variant | string | 'blue' | green teal blue indigo violet pink red orange amber dark | A variante de cor. São 10 variantes: |
tooltip | string | null | -- | Define exibição e texto do tooltip do DynamicInputList. |
tooltipIcon | string | 'info-outline' | -- | Especifica ícone do tooltip do DynamicInputList. |
supportLink | string | null | -- | Controla a exibição e o conteúdo do link de suporte exibido ao lado da label. |
supportLinkUrl | string|null | null | -- | Define a url a ser acessada no clique do link de suporte. |