name *

string

• —

O atributo name do radio. Obrigatório nesse componente para que o agrupamento dos componentes Radio sejam feitos de forma adequada.

label

string

• —

A label à qual se refere o radio button. O clique nessa label ativa o radio button.

value *

any

• —

O valor do radio, para que o agrupamento tenha sempre um valor selecionado.

checked

boolean

• false, true

Se o radio está marcado (selecionado) ou não. Esse valor deve ser usado quando se deseja utilizar o componente de forma controlada.

Quando essa propriedade seja definida (i.e., seja false ou true), a propriedade onChange deve ser definida para o componente ser mutável. Caso contrário, é exibido um `console.error`.

defaultChecked

boolean

• false

• true

Se o radio está inicialmente marcado ou não. Esse valor deve ser usado quando se deseja utilizar o component de forma não-controlada.

error

boolean

• false (default)

• true

Se há um erro no campo radio. Deve ser usado em conjunto com validações de formulário. Não é possível marcar um radio com erro. Quando true, o radio ficará obrigatoriamente desmarcado.

disabled

boolean

• false (default)

• true

Se o radio está habilitado ou não. Quando true, o componente torna-se não-interativo.

customProps

{ input?: ComponentPropsWithRef<'input'>; label?: ComponentPropsWithRef<typeof Typography>; }

• -

Propriedades customizadas para o input e para o componente label.

onChange

function

Função chamada quando o componente tem seu valor modificado.

event é o objeto de evento de change.