Skip to content

mastry/use-key-toggle

Repository files navigation

use-key-toggle

A simple React hook to toggle a boolean flag with a key press.

Installation

npm i @mastry/use-key-toggle

Usage

import React from 'react'
import useKeyToggle from 'use-key-toggle'

const MyComponent: React.FC = () => {
    const [isOpen] = useKeyToggle('KeyK', false);

    return <>Press CTRL+K to change state. The current state is {isOpen}</>
}

About

Toggle state in React with a key press

Resources

Stars

Watchers

Forks

Packages

No packages published