@twocatmoon/react-use-konami-code

useKonamiCode

• useKonamiCode(callbackFn: () => void, options?: UseKonamiCodeOptions): void

• Calls a function when a sequence of key presses is detected.

  example

  export default function () {
      const [ state, setState ] = useState('foo')
  
      const options = {
          sequence: [ 'x', 'y', 'a', 'b' ],
          requireReturn: true     
      }
      useKonamiCode(() => setState('bar'), options)
    
      return (<div>{state}</div>)
  })
  

  Parameters

  • callbackFn: () => void

    Function to be called when a sequence is detected

    • • (): void

      • Returns void

  • Optional options: UseKonamiCodeOptions

  Returns void