Toggle
Modo de exibição
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
| Prop | Tipo | Padrão |
|---|---|---|
defaultPressed0.4.0Se o botão de alternância está pressionado agora. | boolean | false |
disabled0.4.0Se a peça deve ignorar a interação do usuário. | boolean | false |
nativeButton0.4.0Se a peça renderiza um `<button>` nativo quando é trocada pela prop `render`. | boolean | true |
onPressedChange0.4.0Chamado 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.0Se o botão de alternância está pressionado agora. | boolean | sem padrão |
render0.4.0Troca 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.0Texto único que identifica o botão de alternância dentro de um grupo. | string | sem padrão |
Além destas, a peça aceita className, style, id e children, repassados ao elemento de baixo.