Skip to content

Commit

Permalink
feat: add support for the new emoji included in Emoji 15.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Yizack committed Apr 2, 2024
1 parent 581a0ff commit 69e51cf
Show file tree
Hide file tree
Showing 6 changed files with 2,454 additions and 676 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Twemoji module for Nuxt. Render emojis as SVG elements or PNG images

## Features
- Nuxt 3 ready
- Emoji 15.0 support
- Emoji 15.1 support
- Render emoji by character
- Render emoji by codepoint
- Render emoji by definition object
Expand Down Expand Up @@ -86,7 +86,7 @@ You can make use of any of these available components according to your Nuxt app

## Usage (`Twemoji`)

1. Find emojis from the recommended unicode emoji list: https://unicode.org/emoji/charts-15.0/full-emoji-list.html
1. Find emojis from the recommended unicode emoji list: https://unicode.org/emoji/charts-15.1/full-emoji-list.html

2. In the project, use the component `<Twemoji emoji="" />`, where `emoji` is the emoji character or codepoint.
3. If you employ SSR (Server Side Rendering) in your Nuxt application, this module will inject the emoji `<svg>` or `<img>` element into the output code during your project's build/generate process. Alternatively, if SSR is not used, the emojis will dynamically render during client runtime.
Expand Down Expand Up @@ -136,7 +136,7 @@ import { twSmilingFaceWithSmilingEyes } from 'nuxt-twemoji/emojis'
</template>
```

The emojis file has been generated using the self made [`generateEmojis.js`](https://github.com/Yizack/nuxt-twemoji/blob/main/scripts/generateEmojis.js) script, which fetches emojis data from the [Unicode](https://home.unicode.org/) public Emoji 15.0 file available at https://unicode.org/Public/emoji/15.0/emoji-test.txt
The emojis file has been generated using the self made [`generateEmojis.js`](https://github.com/Yizack/nuxt-twemoji/blob/main/scripts/generateEmojis.js) script, which fetches emojis data from the [Unicode](https://home.unicode.org/) public Emoji 15.1 file available at https://unicode.org/Public/emoji/15.1/emoji-test.txt

### Definitions
The `EmojiDefinition` type represents objects that have these specific three string properties:
Expand Down Expand Up @@ -268,7 +268,7 @@ img.twemojiParse {

- Twitter Emoji assets from [jdecked/twemoji](https://github.com/jdecked/twemoji)
- Default CDN [jsDelivr](https://www.jsdelivr.com/)
- [Unicode](https://home.unicode.org/) public [Emoji 15.0](https://unicode.org/Public/emoji/15.0/) file
- [Unicode](https://home.unicode.org/) public [Emoji 15.1](https://unicode.org/Public/emoji/15.1/) file
- [Nuxt](https://github.com/nuxt/nuxt), the JavaScript framework for creating SSR Vue applications and its [Module Author Guide](https://nuxt.com/docs/guide/going-further/modules)

## Development
Expand Down
16 changes: 8 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,20 +54,20 @@
"emojis": "node ./scripts/generateEmojis.js"
},
"dependencies": {
"@nuxt/kit": "^3.10.3",
"@twemoji/api": "^15.0.3"
"@nuxt/kit": "^3.11.1",
"@twemoji/api": "^15.1.0"
},
"devDependencies": {
"@nuxt/devtools": "^1.0.8",
"@nuxt/devtools": "^1.1.5",
"@nuxt/eslint-config": "^0.2.0",
"@nuxt/module-builder": "^0.5.5",
"@nuxt/schema": "^3.10.3",
"@nuxt/test-utils": "^3.11.0",
"@types/node": "^20.11.26",
"@nuxt/schema": "^3.11.1",
"@nuxt/test-utils": "^3.12.0",
"@types/node": "^20.12.2",
"changelogen": "^0.5.5",
"eslint": "^8.57.0",
"nuxt": "^3.10.3",
"vitest": "^1.3.1"
"nuxt": "^3.11.1",
"vitest": "^1.4.0"
},
"changelog": {
"repo": {
Expand Down
Loading

0 comments on commit 69e51cf

Please sign in to comment.