https://github.com/joshuakgoldberg/konamimojisplosion

Connects konami-code-js to emojisplosion for a glorious easter egg. 🎉 ✨ 🎆
https://github.com/joshuakgoldberg/konamimojisplosion

easter-egg emojis emojisplosion javascript konami-code react

Last synced: 5 months ago
JSON representation

Connects konami-code-js to emojisplosion for a glorious easter egg. 🎉 ✨ 🎆

• Host: GitHub
• URL: https://github.com/joshuakgoldberg/konamimojisplosion
• Owner: JoshuaKGoldberg
• License: mit
• Created: 2021-11-11T21:24:49.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-12-15T20:35:18.000Z (over 1 year ago)
• Last Synced: 2024-12-13T15:23:15.735Z (5 months ago)
• Topics: easter-egg, emojis, emojisplosion, javascript, konami-code, react
• Language: TypeScript
• Homepage:
• Size: 372 KB
• Stars: 13
• Watchers: 17
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Konamimojisplosion

[![Code Style: Prettier](https://img.shields.io/badge/code_style-prettier-brightgreen.svg)](https://prettier.io)

![TypeScript: Strict](https://img.shields.io/badge/typescript-strict-brightgreen.svg)

[![NPM version](https://badge.fury.io/js/konamimojisplosion.svg)](http://badge.fury.io/js/konamimojisplosion)

> ⬆ ⬆ ⬇ ⬇ ⬅ ➡ ⬅ ➡ 🅱 🅰

>

> 🎉 ✨ 🎆

Hooks [konami-code-js](https://github.com/Haeresis/konami-code-js) to trigger [emojisplosion](https://github.com/JoshuaKGoldberg/emojisplosion).

If a user types in the Konami Code on their keyboard or taps it on their mobile phone, emojisplosions will start firing on the page.

Triggering the Konami Code again will stop the emojisplosions.

> Check it out on [Codecademy Docs!](https://codecademy.com/resources/docs)

## Usage

### Quick Mode

Plop this 👇 at the end of your ``:

```html

```

Alternately, you can import and use this as a standalone function, a React hook, or a React class component.

### Standalone Function

```tsx

import { initializeKonamimojisplosion } from "konamimojisplosion";

initializeKonamimojisplosion();

```

### React Hook

```tsx

import { useKonamimojisplosion } from "konamimojisplosion";

function MyComponent() {

  useKonamimojisplosion();

  return Hello, world!;

}

```

### React Class Component

> Tip: the class component just calls the hook internally.

```tsx

import { Konamimojisplosion } from "konamimojisplosion";

class MyComponent {

  render() {

    return (

      

        

        Hello, world!

      

    );

  }

}

```

## Development

Requires:

- [Node.js](https://nodejs.org) >14

- [Yarn](https://yarnpkg.com/en)

After [forking the repo from GitHub](https://help.github.com/articles/fork-a-repo):

```shell

git clone https://github.com//konamimojisplosion

cd konamimojisplosion

yarn

```

### Contribution Guidelines

We'd love to have you contribute!

Check the [issue tracker](https://github.com/Codecademy/konamimojisplosion/issues) for issues labeled [`accepting prs`](https://github.com/Codecademy/konamimojisplosion/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22accepting+prs%22) to find bug fixes and feature requests the community can work on.

If this is your first time working with this code, the [`good first issue`](https://github.com/Codecademy/konamimojisplosion/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+) label indicates good introductory issues.

Please note that this project is released with a [Contributor Covenant](https://www.contributor-covenant.org).

By participating in this project you agree to abide by its terms.

See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).