Pular para o conteúdo principal

Switch

switch renderiza um switch do MUI para um valor booleano do formulário. Ele é útil para configurações que são ativadas ou desativadas.

{name: 'notifications', label: 'Ativar notificações', type: 'switch'}

Valor e default​

Um switch sempre usa um boolean. Quando nenhum valor inicial ou defaultValue é fornecido, seu valor padrão é false.

{
  name: 'notifications',
  label: 'Ativar notificações',
  type: 'switch',
  defaultValue: true,
}

onSubmit recebe o mesmo valor booleano:

{notifications: true}

Estado e ajuda​

disabled: true impede a interação. readOnly: true mantém o valor atual visível, mas impede alterações. Use helperText para explicar a configuração.

{
  name: 'managed',
  label: 'Gerenciado pela sua organização',
  type: 'switch',
  disabled: true,
  helperText: 'Esta configuração é controlada por uma política.',
}

Condições e grid​

Switches usam as mesmas condições declarativas e grid responsivo dos demais fields de dados.

{
  name: 'auditLog',
  label: 'Ativar registro de auditoria',
  type: 'switch',
  visibleWhen: {field: 'advanced', operator: 'equals', value: true},
  grid: {xs: 12, md: 6},
}

Consulte Fields para o contrato compartilhado de fields.

Testar Switch no Lab