devlato / react-easter Goto Github PK

if possible, please add a new declaration (.d.ts) file containing declare module 'react-easter';

Should work with React version > 15 <= 17.x ideally

It would be terrific to have a callback in order to customize the container easlier.

use case:
I want to hide the content of a page, replacing it with a pong board when the user inputs the correct code. Right now I can only pass the component to render so I could use a fullscreen modal to cover the content of the page but it would be even better to just set a state taht'd hide my components content while the egg is active.

It could be something like:

const EasterEgg = require('react-easter');

// ...

render() {
  return (
    <EasterEgg
        keys={/* Array of keys to type to trigger the easter egg */}
        simultaneous={/* Add this prop if keys should be pressed all together */}
        timeout={/* Duration to show your easter egg, easter egg is displayed forever if prop is not set */}
        onsuccess={/* Callback to call when the code is correctly inserted*/}
        ontimeout={/* Callback to call when the timer runs out*/}>
      {/* Your easter egg JSX goes here */}
    </EasterEgg>
  );
}
`