use-toggle.md

useToggle

useToggle is a React hook for managing Toggle's state.

Table of Contents

• Props
  • defaultChecked
  • onChange
• State
  • checked
  • handleChange
• Examples

Props

defaultChecked

Type: boolean optional

The default value of Toggle's checked prop

onChange

Type: (checked: boolean) => void

onChange is an event listener that fires whenever the customer changes the checked state. It is passed the current checked state.

State

checked

Type: boolean

Toggle's checked prop

handleChange

Type: NonCancelableEventHandler<ToggleProps.ChangeDetail>

Toggle's onChange prop

Examples

import Toggle from '@awsui/components-react/toggle';
import { useToggle } from 'use-awsui';

export default function MyToggle() {
  const { checked, handleChange } = useToggle({
    defaultChecked: true,
  });

  return <Toggle checked={checked} onChange={handleChange} />;
}