Skip to content

useBooleanState ​

useBooleanState は、真偽値の状態管理を簡単にする React フックです。 状態を true にする関数、false にする関数、値を切り替える関数を提供します。

インターフェース ​

ts
function useBooleanState(
  initialValue: boolean | (() => boolean) = false
): readonly [
  state: boolean,
  setTrue: () => void,
  setFalse: () => void,
  toggle: () => void,
];

パラメータ ​

  • initialValueboolean | (() => boolean)

    状態の初期値です。デフォルトは false です。

戻り値 ​

  • readonly [state: boolean, setTrue: () => void, setFalse: () => void, toggle: () => void]

    以下を含むタプル。

    • stateboolean

      現在の状態の値。

    • setTrue() => void

      状態を true にする関数。

    • setFalse() => void

      状態を false にする関数。

    • toggle() => void

      状態を切り替える関数。

使用例 ​

tsx
const [open, openBottomSheet, closeBottomSheet, toggleBottomSheet] =
  useBooleanState(false);

MIT ライセンスの下で配布されています。