Skip to main content

useSwitch

This hook allows creating custom Switch and SwitchList elements with the Accessibility checks needed.

Usage​

import { useSwitch } from 'react-native-ama';

const switchProps = useSwitch(props);
  • props: The ViewProps

Accessibility checks​

The hook automatically:

  • Sets accessibilityRole to switch

  • Handles the accessibilityState for checked

  • At runtime, the hook:

  • Forces the use of accessibilityLabel DEV only check

  • Enforces the minimum size DEV only check

accessibilityLabel​

The accessibilityLabel property is the first thing announced by the screen reader when the elements gain the focus; then, it announces its role. If the property is omitted, the user might have little to no clue what could happen if the element is triggered.

Check here for more info

Minimum size​

The component uses the onLayout prop to perform the minium size check.

Example​

import { useSwitch } from 'react-native-ama';

const switchProps = useSwitch(rest);

export const SwitchListItem = () => {
  const { style: switchStyle, ...otherSwitchProps } = useSwitch(rest);

  return (
    <TouchableWithoutFeedback {...otherSwitchProps}>
      <View style={[switchStyle || {}, style.switch]}>{children}</View>
    </TouchableWithoutFeedback>
  );
};