├── .gitignore ├── README.md ├── package.json ├── public ├── favicon.ico ├── index.html ├── logo192.png ├── logo512.png ├── manifest.json └── robots.txt ├── src ├── App.js ├── index.js ├── serviceWorker.js ├── setupTests.js ├── useKonamiCode.js └── useKonamiCode.test.js └── yarn.lock /.gitignore: -------------------------------------------------------------------------------- 1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. 2 | 3 | # dependencies 4 | /node_modules 5 | /.pnp 6 | .pnp.js 7 | 8 | # testing 9 | /coverage 10 | 11 | # production 12 | /build 13 | 14 | # misc 15 | .DS_Store 16 | .env.local 17 | .env.development.local 18 | .env.test.local 19 | .env.production.local 20 | 21 | npm-debug.log* 22 | yarn-debug.log* 23 | yarn-error.log* 24 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # useKonamiCode 2 | 3 | > A simple custom react hook to verify a sequence of typed keys from the user. 4 | 5 | ## Video 6 | 7 | [Video explaining how this hook was created - PtBr](https://youtu.be/EvR4RPBsHfE) 8 | 9 | ## How to use 10 | 11 | ```jsx 12 | // without defined code and callback 13 | const { sequence, rightSequence } = useKonamiCode(); 14 | 15 | const code = ["ArrowDown", "ArrowUp"]; 16 | const callback = () => console.log("Yeeeey"); 17 | 18 | // passing code and callback 19 | const { sequence, rightSequence } = useKonamiCode(code, callback); 20 | ``` 21 | 22 | ## Types 23 | 24 | ### Parameters 25 | 26 | - `code`: _(Array)_ - a sequence of keys that should be verified. (default: `["ArrowUp", "ArrowUp", "ArrowDown", "ArrowDown", "ArrowLeft", "ArrowRight", "ArrowLeft", "ArrowRight", "b", "a"]`) 27 | - `callback`: _(Function)_ - a function to run if the correct sequence is provided. (default: `() => {}`) 28 | 29 | ### Returns 30 | 31 | - `sequence` _(Array)_: sequence of keys from the user. 32 | - `rightSequence` _(Boolean)_: a boolean to indicate if the user typed the right sequence or not. 33 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "use-konami-code", 3 | "version": "0.1.0", 4 | "private": true, 5 | "dependencies": { 6 | "@testing-library/jest-dom": "^4.2.4", 7 | "@testing-library/react": "^9.3.2", 8 | "@testing-library/react-hooks": "^3.2.1", 9 | "@testing-library/user-event": "^7.1.2", 10 | "react": "^16.13.1", 11 | "react-dom": "^16.13.1", 12 | "react-scripts": "3.4.1", 13 | "react-test-renderer": "^16.13.1" 14 | }, 15 | "scripts": { 16 | "start": "react-scripts start", 17 | "build": "react-scripts build", 18 | "test": "react-scripts test", 19 | "eject": "react-scripts eject" 20 | }, 21 | "eslintConfig": { 22 | "extends": "react-app" 23 | }, 24 | "browserslist": { 25 | "production": [ 26 | ">0.2%", 27 | "not dead", 28 | "not op_mini all" 29 | ], 30 | "development": [ 31 | "last 1 chrome version", 32 | "last 1 firefox version", 33 | "last 1 safari version" 34 | ] 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/willianjusten/use-konami-code/1d9ff42aab01710c7604ed2329d472d715278915/public/favicon.ico -------------------------------------------------------------------------------- /public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 12 | 13 | 17 | 18 | 27 | React App 28 | 29 | 30 | 31 |

32 | 42 | 43 | 44 | -------------------------------------------------------------------------------- /public/logo192.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/willianjusten/use-konami-code/1d9ff42aab01710c7604ed2329d472d715278915/public/logo192.png -------------------------------------------------------------------------------- /public/logo512.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/willianjusten/use-konami-code/1d9ff42aab01710c7604ed2329d472d715278915/public/logo512.png -------------------------------------------------------------------------------- /public/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "short_name": "React App", 3 | "name": "Create React App Sample", 4 | "icons": [ 5 | { 6 | "src": "favicon.ico", 7 | "sizes": "64x64 32x32 24x24 16x16", 8 | "type": "image/x-icon" 9 | }, 10 | { 11 | "src": "logo192.png", 12 | "type": "image/png", 13 | "sizes": "192x192" 14 | }, 15 | { 16 | "src": "logo512.png", 17 | "type": "image/png", 18 | "sizes": "512x512" 19 | } 20 | ], 21 | "start_url": ".", 22 | "display": "standalone", 23 | "theme_color": "#000000", 24 | "background_color": "#ffffff" 25 | } 26 | -------------------------------------------------------------------------------- /public/robots.txt: -------------------------------------------------------------------------------- 1 | # https://www.robotstxt.org/robotstxt.html 2 | User-agent: * 3 | Disallow: 4 | -------------------------------------------------------------------------------- /src/App.js: -------------------------------------------------------------------------------- 1 | import React from "react"; 2 | import useKonamiCode from "./useKonamiCode"; 3 | 4 | function App() { 5 | const callback = () => console.log("YEEEEEY"); 6 | const newSequence = ["w", "j"]; 7 | const { sequence, rightSequence } = useKonamiCode(newSequence, callback); 8 | 9 | return ( 10 |

11 |

Konami code!

12 | 13 | konami code: cima cima baixo baixo esquerda direita esquerda direita b a

17 | 18 |

19 | {sequence.map((key, i) => ( 20 | {key} 21 | ))} 22 |

23 | 24 | {rightSequence &&

YEEEEEY!!

} 25 |

26 | ); 27 | } 28 | 29 | export default App; 30 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | import React from "react"; 2 | import ReactDOM from "react-dom"; 3 | import App from "./App"; 4 | import * as serviceWorker from "./serviceWorker"; 5 | 6 | ReactDOM.render( 7 | 8 | 9 | , 10 | document.getElementById("root") 11 | ); 12 | 13 | // If you want your app to work offline and load faster, you can change 14 | // unregister() to register() below. Note this comes with some pitfalls. 15 | // Learn more about service workers: https://bit.ly/CRA-PWA 16 | serviceWorker.unregister(); 17 | -------------------------------------------------------------------------------- /src/serviceWorker.js: -------------------------------------------------------------------------------- 1 | // This optional code is used to register a service worker. 2 | // register() is not called by default. 3 | 4 | // This lets the app load faster on subsequent visits in production, and gives 5 | // it offline capabilities. However, it also means that developers (and users) 6 | // will only see deployed updates on subsequent visits to a page, after all the 7 | // existing tabs open on the page have been closed, since previously cached 8 | // resources are updated in the background. 9 | 10 | // To learn more about the benefits of this model and instructions on how to 11 | // opt-in, read https://bit.ly/CRA-PWA 12 | 13 | const isLocalhost = Boolean( 14 | window.location.hostname === 'localhost' || 15 | // [::1] is the IPv6 localhost address. 16 | window.location.hostname === '[::1]' || 17 | // 127.0.0.0/8 are considered localhost for IPv4. 18 | window.location.hostname.match( 19 | /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/ 20 | ) 21 | ); 22 | 23 | export function register(config) { 24 | if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) { 25 | // The URL constructor is available in all browsers that support SW. 26 | const publicUrl = new URL(process.env.PUBLIC_URL, window.location.href); 27 | if (publicUrl.origin !== window.location.origin) { 28 | // Our service worker won't work if PUBLIC_URL is on a different origin 29 | // from what our page is served on. This might happen if a CDN is used to 30 | // serve assets; see https://github.com/facebook/create-react-app/issues/2374 31 | return; 32 | } 33 | 34 | window.addEventListener('load', () => { 35 | const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`; 36 | 37 | if (isLocalhost) { 38 | // This is running on localhost. Let's check if a service worker still exists or not. 39 | checkValidServiceWorker(swUrl, config); 40 | 41 | // Add some additional logging to localhost, pointing developers to the 42 | // service worker/PWA documentation. 43 | navigator.serviceWorker.ready.then(() => { 44 | console.log( 45 | 'This web app is being served cache-first by a service ' + 46 | 'worker. To learn more, visit https://bit.ly/CRA-PWA' 47 | ); 48 | }); 49 | } else { 50 | // Is not localhost. Just register service worker 51 | registerValidSW(swUrl, config); 52 | } 53 | }); 54 | } 55 | } 56 | 57 | function registerValidSW(swUrl, config) { 58 | navigator.serviceWorker 59 | .register(swUrl) 60 | .then(registration => { 61 | registration.onupdatefound = () => { 62 | const installingWorker = registration.installing; 63 | if (installingWorker == null) { 64 | return; 65 | } 66 | installingWorker.onstatechange = () => { 67 | if (installingWorker.state === 'installed') { 68 | if (navigator.serviceWorker.controller) { 69 | // At this point, the updated precached content has been fetched, 70 | // but the previous service worker will still serve the older 71 | // content until all client tabs are closed. 72 | console.log( 73 | 'New content is available and will be used when all ' + 74 | 'tabs for this page are closed. See https://bit.ly/CRA-PWA.' 75 | ); 76 | 77 | // Execute callback 78 | if (config && config.onUpdate) { 79 | config.onUpdate(registration); 80 | } 81 | } else { 82 | // At this point, everything has been precached. 83 | // It's the perfect time to display a 84 | // "Content is cached for offline use." message. 85 | console.log('Content is cached for offline use.'); 86 | 87 | // Execute callback 88 | if (config && config.onSuccess) { 89 | config.onSuccess(registration); 90 | } 91 | } 92 | } 93 | }; 94 | }; 95 | }) 96 | .catch(error => { 97 | console.error('Error during service worker registration:', error); 98 | }); 99 | } 100 | 101 | function checkValidServiceWorker(swUrl, config) { 102 | // Check if the service worker can be found. If it can't reload the page. 103 | fetch(swUrl, { 104 | headers: { 'Service-Worker': 'script' }, 105 | }) 106 | .then(response => { 107 | // Ensure service worker exists, and that we really are getting a JS file. 108 | const contentType = response.headers.get('content-type'); 109 | if ( 110 | response.status === 404 || 111 | (contentType != null && contentType.indexOf('javascript') === -1) 112 | ) { 113 | // No service worker found. Probably a different app. Reload the page. 114 | navigator.serviceWorker.ready.then(registration => { 115 | registration.unregister().then(() => { 116 | window.location.reload(); 117 | }); 118 | }); 119 | } else { 120 | // Service worker found. Proceed as normal. 121 | registerValidSW(swUrl, config); 122 | } 123 | }) 124 | .catch(() => { 125 | console.log( 126 | 'No internet connection found. App is running in offline mode.' 127 | ); 128 | }); 129 | } 130 | 131 | export function unregister() { 132 | if ('serviceWorker' in navigator) { 133 | navigator.serviceWorker.ready 134 | .then(registration => { 135 | registration.unregister(); 136 | }) 137 | .catch(error => { 138 | console.error(error.message); 139 | }); 140 | } 141 | } 142 | -------------------------------------------------------------------------------- /src/setupTests.js: -------------------------------------------------------------------------------- 1 | // jest-dom adds custom jest matchers for asserting on DOM nodes. 2 | // allows you to do things like: 3 | // expect(element).toHaveTextContent(/react/i) 4 | // learn more: https://github.com/testing-library/jest-dom 5 | import '@testing-library/jest-dom/extend-expect'; 6 | -------------------------------------------------------------------------------- /src/useKonamiCode.js: -------------------------------------------------------------------------------- 1 | /* eslint-disable react-hooks/exhaustive-deps */ 2 | import { useState, useEffect } from "react"; 3 | 4 | export const konamiSequence = [ 5 | "ArrowUp", 6 | "ArrowUp", 7 | "ArrowDown", 8 | "ArrowDown", 9 | "ArrowLeft", 10 | "ArrowRight", 11 | "ArrowLeft", 12 | "ArrowRight", 13 | "b", 14 | "a", 15 | ]; 16 | 17 | export default function useKonamiCode( 18 | codeSequence = konamiSequence, 19 | callback = () => {} 20 | ) { 21 | const [rightSequence, setRightSequence] = useState(false); 22 | const [sequence, setSequence] = useState([]); 23 | 24 | const onKeyDown = (event) => setSequence((prev) => [...prev, event.key]); 25 | 26 | useEffect(() => { 27 | sequence.forEach((key, i) => { 28 | if (key !== codeSequence[i]) { 29 | setSequence([]); 30 | } 31 | }); 32 | 33 | if (sequence.toString() === codeSequence.toString()) { 34 | setRightSequence(true); 35 | callback(); 36 | } 37 | }, [sequence]); 38 | 39 | useEffect(() => { 40 | window.addEventListener("keydown", onKeyDown); 41 | return () => window.removeEventListener("keydown", onKeyDown); 42 | }); 43 | 44 | return { sequence, rightSequence }; 45 | } 46 | -------------------------------------------------------------------------------- /src/useKonamiCode.test.js: -------------------------------------------------------------------------------- 1 | import { renderHook, act } from "@testing-library/react-hooks"; 2 | 3 | import useKonamiCode, { konamiSequence } from "./useKonamiCode"; 4 | 5 | describe("useKonamiCode", () => { 6 | it("should return the user sequence", () => { 7 | const { result } = renderHook(() => useKonamiCode()); 8 | 9 | act(() => { 10 | window.dispatchEvent(new KeyboardEvent("keydown", { key: "ArrowUp" })); 11 | }); 12 | 13 | expect(result.current.sequence).toEqual(["ArrowUp"]); 14 | }); 15 | 16 | it("should reset the sequence if the user types a wrong sequence", () => { 17 | const { result } = renderHook(() => useKonamiCode()); 18 | 19 | act(() => { 20 | window.dispatchEvent(new KeyboardEvent("keydown", { key: "ArrowUp" })); 21 | window.dispatchEvent(new KeyboardEvent("keydown", { key: "k" })); 22 | }); 23 | 24 | expect(result.current.sequence).toEqual([]); 25 | }); 26 | 27 | it("should return true when user types a right sequence", () => { 28 | const { result } = renderHook(() => useKonamiCode()); 29 | 30 | konamiSequence.forEach((key) => { 31 | act(() => { 32 | window.dispatchEvent(new KeyboardEvent("keydown", { key })); 33 | }); 34 | }); 35 | 36 | expect(result.current.rightSequence).toBe(true); 37 | }); 38 | 39 | it("should return false when user types a wrong sequence", () => { 40 | const { result } = renderHook(() => useKonamiCode()); 41 | 42 | act(() => { 43 | window.dispatchEvent(new KeyboardEvent("keydown", { key: "k" })); 44 | }); 45 | 46 | expect(result.current.rightSequence).toBe(false); 47 | }); 48 | 49 | it("should allow different sequence and return true if user types this sequence", () => { 50 | const newSequence = ["w", "j"]; 51 | const { result } = renderHook(() => useKonamiCode(newSequence)); 52 | 53 | newSequence.forEach((key) => { 54 | act(() => { 55 | window.dispatchEvent(new KeyboardEvent("keydown", { key })); 56 | }); 57 | }); 58 | 59 | expect(result.current.rightSequence).toBe(true); 60 | }); 61 | 62 | it("should run a callback fn if right sequence if typed", () => { 63 | const newSequence = ["w", "j"]; 64 | const callback = jest.fn(); 65 | renderHook(() => useKonamiCode(newSequence, callback)); 66 | 67 | newSequence.forEach((key) => { 68 | act(() => { 69 | window.dispatchEvent(new KeyboardEvent("keydown", { key })); 70 | }); 71 | }); 72 | 73 | expect(callback).toHaveBeenCalled(); 74 | }); 75 | }); 76 | --------------------------------------------------------------------------------