Documentation
Toggle

Toggle

Example

import { Toggle } from '@i4o/catalystui'
 
export default () => {
	const [pressed, setPressed] = useState(false)
 
	return (
		<Toggle ariaLabel='Star' pressed={pressed} onPressedChange={setPressed}>
			{pressed ? 'Starred' : 'Star'}
		</Toggle>
	)
}

Props

NameTypeDefaultDescription
ariaLabelstring''aria-label for the Toggle component
defaultPressedbooleanfalseIf the Toggle should be active by default. Use for uncontrolled operation.
pressedboolean-Pressed state of the Toggle. Use for controlled operation with onPressedChange.
onPressedChange(pressed: boolean) => void-Event handler called when the pressed state of the Toggle changes.