Pular para o conteúdo
Ações

Toggle

/componentes/toggle.mdmarkdown cru, para quem lê com agent em vez de olho

Modo de exibição

Importar
import { Toggle } from '@rivocode/ui'

Quando usar

Botão que fica apertado. Vive dentro de um ToggleGroup.

Quando não usar

Para uma escolha entre várias opções (alinhar à esquerda, ao centro, à direita), use ToggleGroup: ele coordena os irmãos e diz qual ficou apertado. Configuração que vale na hora e fica gravada (receber aviso por e-mail, modo escuro) é Switch, que se lê como liga e desliga, e não como botão.

O botão que só dispara uma ação, sem ficar apertado, é Button ou IconButton: um aria-pressed que não guarda estado nenhum confunde quem ouve a tela.

No React Native

Traduz: o @rivocode/ui-native exporta Toggle - pressed e onPressedChange. A API não é a mesma do web (no nativo tudo é controlado), e a tabela de paridade diz o que muda peça a peça.

API

PropTipoPadrão
defaultPressed0.4.0

Se o botão de alternância está pressionado agora.

booleanfalse
disabled0.4.0

Se a peça deve ignorar a interação do usuário.

booleanfalse
nativeButton0.4.0

Se a peça renderiza um `<button>` nativo quando é trocada pela prop `render`.

booleantrue
onPressedChange0.4.0

Chamado quando o estado pressionado muda.

((pressed: boolean, eventDetails: { reason: "none"; event: Event; cancel: () => void; allowPropagation: () => void; isCanceled: boolean; isPropagationAllowed: boolean; trigger: Element | undefined; }) => void)sem padrão
pressed0.4.0

Se o botão de alternância está pressionado agora.

booleansem padrão
render0.4.0

Troca o elemento HTML da peça por outra tag, ou a compõe com outro componente.

ComponentRenderFn<HTMLProps, ToggleState> | ReactElement<unknown, string | JSXElementConstructor<any>>sem padrão
value0.4.0

Texto único que identifica o botão de alternância dentro de um grupo.

stringsem padrão

Além destas, a peça aceita className, style, id e children, repassados ao elemento de baixo.

@rivocode/ui, 149 peças no catálogo. Esta página é gerada dos mesmos arquivos que alimentam o design system, então ela não envelhece sozinha.

Feito por RivoCode.