@spaced-out/ui-design-system/lib/hooks/useToggle/useToggle.js.flow

Sense UI components library

// @flow strict

import {useCallback, useState} from 'react';


export function useToggle(
  initialState: boolean = false,
): [boolean, (newValue: boolean) => void] {
  // Initialize the state
  const [stateValue, setStateValue] = useState(initialState);

  // Define and memorize toggle function in case we pass down the component,
  // This function change the boolean value to it's opposite value
  const toggle = useCallback(() => setStateValue((state) => !state), []);

  return [stateValue, toggle];
}