{"id":16922166,"url":"https://github.com/julien-marcou/unicode-emoji","last_synced_at":"2025-04-06T15:12:27.882Z","repository":{"id":37576068,"uuid":"261765814","full_name":"Julien-Marcou/Unicode-Emoji","owner":"Julien-Marcou","description":"Raw data for Unicode Emoji 🙂","archived":false,"fork":false,"pushed_at":"2024-11-21T13:39:45.000Z","size":1861,"stargazers_count":35,"open_issues_count":0,"forks_count":13,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-30T14:11:15.737Z","etag":null,"topics":["csv","dataset","emoji","emoticon","json","smiley","unicode"],"latest_commit_sha":null,"homepage":"https://emoji.julien-marcou.fr","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Julien-Marcou.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-06T13:24:10.000Z","updated_at":"2025-02-19T10:40:54.000Z","dependencies_parsed_at":"2023-12-09T18:26:14.965Z","dependency_job_id":"7da89e10-7e87-48c9-952f-96e868102f45","html_url":"https://github.com/Julien-Marcou/Unicode-Emoji","commit_stats":{"total_commits":41,"total_committers":1,"mean_commits":41.0,"dds":0.0,"last_synced_commit":"c2a46ff9bdb008f8e9c927db4e7fc9968cf29505"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Julien-Marcou%2FUnicode-Emoji","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Julien-Marcou%2FUnicode-Emoji/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Julien-Marcou%2FUnicode-Emoji/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Julien-Marcou%2FUnicode-Emoji/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Julien-Marcou","download_url":"https://codeload.github.com/Julien-Marcou/Unicode-Emoji/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247500468,"owners_count":20948880,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["csv","dataset","emoji","emoticon","json","smiley","unicode"],"created_at":"2024-10-13T19:54:25.148Z","updated_at":"2025-04-06T15:12:27.864Z","avatar_url":"https://github.com/Julien-Marcou.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Unicode Emoji\n\n[![NPM Package](https://img.shields.io/npm/v/unicode-emoji?label=release\u0026color=%23cd2620\u0026logo=npm)](https://www.npmjs.com/package/unicode-emoji)\n[![Unicode Emoji v16](https://img.shields.io/badge/emoji-v16-yellow?logo=unicode\u0026logoColor=yellow)](https://unicode.org/Public/emoji/16.0/)\n[![GitHub Repository](https://img.shields.io/github/stars/Julien-Marcou/Unicode-Emoji?color=%23f5f5f5\u0026logo=github)](https://github.com/Julien-Marcou/Unicode-Emoji)\n\n![Downloads per Month](https://img.shields.io/npm/dm/unicode-emoji)\n![Repository Size](https://img.shields.io/github/repo-size/Julien-Marcou/Unicode-Emoji?color=%23063a8d)\n![Gzip Size](https://img.shields.io/bundlephobia/minzip/unicode-emoji?label=gzip%20size)\n![No Dependency](https://img.shields.io/badge/dependencies-none-%23872a84)\n![MIT License](https://img.shields.io/npm/l/unicode-emoji)\n\nRaw data for Unicode Emoji 🙂\n\nThe data are generated using the `Unicode Emoji, Version 16.0` from [Unicode](https://home.unicode.org/emoji/about-emoji/).\n\nYou can learn more about emojis at [Emojipedia](https://emojipedia.org/) or find some implementation details and trivia on the [Wiki](https://github.com/Julien-Marcou/Unicode-Emoji/wiki).\n\n\n## 👉 Demo\n\nCheck the generated [CSV file](https://github.com/Julien-Marcou/Unicode-Emoji/blob/master/unicode-emoji.csv).\n\nOr just [take a look](https://emoji.julien-marcou.fr/) at what you can achieve using this package.\n\n\n## 🔌 Installation\n\n```shell\nnpm install unicode-emoji\n```\n\n\n## 🧰 Usage\n\nThis NPM package uses the ECMAScript Modules system, so the easiest way to use it, is with a Bundler (like WebPack), so you don't have to worry about how to make it available and import it.\n\n### With a Bundler\n\nYou can simply import it wherever you need it :\n\n```javascript\nimport * as unicodeEmoji from 'unicode-emoji';\n```\n\n### With Node.js\n\nES Modules are only supported since Node.js v14.\n\n#### Targeting CommonJS\n\nWhen targeting CommonJS, you don't have access to static import, so you'll have to use dynamic import :\n\n```javascript\nconst unicodeEmoji = await import('unicode-emoji');\n```\n\nAlso, you'll need to import it inside an async function, as top-level await is not supported for CommonJS.\n\n#### Targeting ES Module\n\nWhen setting `\"type\": \"module\"` inside your `package.json` or when importing it from a `.mjs` file, you can simply use the ES6 import syntax :\n\n```javascript\nimport * as unicodeEmoji from 'unicode-emoji';\n```\n\n### From a web browser\n\nIf you are not using a bundler, you'll have to expose the `unicode-emoji/index.js` file so it is accessible from the web.\n\n#### Using the full path\n\n```html\n\u003cscript type=\"module\"\u003e\n  import * as unicodeEmoji from '/node_modules/unicode-emoji/index.js';\n\u003c/script\u003e\n```\n#### Using Import Maps\n\n[Import Maps](https://wicg.github.io/import-maps/) can be very useful when you have several dependencies between different modules, as it allows you to import modules using their names instead of their full path.\n\nBut they are not implemented in any browser yet, so you'll have to use a polyfill :\n\n```html\n\u003cscript async src=\"https://unpkg.com/es-module-shims@0.12.1/dist/es-module-shims.js\"\u003e\u003c/script\u003e\n\u003cscript type=\"importmap-shim\"\u003e\n  {\n    \"imports\": {\n      \"unicode-emoji\": \"/node_modules/unicode-emoji/index.js\"\n    }\n  }\n\u003c/script\u003e\n\u003cscript type=\"module-shim\"\u003e\n  import * as unicodeEmoji from 'unicode-emoji';\n\u003c/script\u003e\n```\n\n\n## 📚 Documentation\n\n### Retrieve emojis\n\n```javascript\nunicodeEmoji.getEmojis();\n```\n\n```javascript\n[\n  {\n    \"emoji\": \"😀\", // Emoji without skin tone variation\n    \"description\": \"grinning face\",\n    \"version\": \"1.0\",\n    \"keywords\": [\"face\", \"grin\", \"grinning face\"],\n    \"category\": \"face-emotion\",\n    \"group\": \"smileys-emotion\",\n    \"subgroup\": \"face-smiling\"\n  },\n  {\n    \"emoji\": \"👋\", // Emoji with skin tone variations\n    \"description\": \"waving hand\",\n    \"version\": \"0.6\",\n    \"keywords\": [\"hand\", \"wave\", \"waving\"],\n    \"category\": \"face-emotion\",\n    \"group\": \"people-body\",\n    \"subgroup\": \"hand-fingers-open\",\n    \"variations\": [\n      {\n        \"emoji\": \"👋🏻\",\n        \"description\": \"waving hand: light skin tone\",\n        \"version\": \"1.0\"\n      },\n      {\n        \"emoji\": \"👋🏼\",\n        \"description\": \"waving hand: medium-light skin tone\",\n        \"version\": \"1.0\"\n      },\n      // ...\n    ]\n  },\n  // ...\n]\n```\n\n### Retrieve components\n\n```javascript\nunicodeEmoji.getComponents();\n```\n\n```javascript\n{\n  \"skin-tone\": [\n    {\n      \"emoji\": \"🏻\",\n      \"description\": \"light skin tone\",\n      \"version\": \"1.0\"\n    },\n    {\n      \"emoji\": \"🏼\",\n      \"description\": \"medium-light skin tone\",\n      \"version\": \"1.0\"\n    },\n    // ...\n  ],\n  \"hair-style\": [\n    {\n      \"emoji\": \"🦰\",\n      \"description\": \"red hair\",\n      \"version\": \"11.0\"\n    },\n    {\n      \"emoji\": \"🦱\",\n      \"description\": \"curly hair\",\n      \"version\": \"11.0\"\n    },\n    // ...\n  ]\n}\n```\n\n### Grouping \u0026 filtering\n\nYou can group \u0026 filter emojis by category, group, subgroup or version\n\nHere is an example :\n - grouped by category\n - without emojis from the flags category\n - without emojis from the 0.6 \u0026 0.7 versions\n - without emojis from all versions above version 12.0 (does not exclude emojis from the version 12.0)\n\n```javascript\nconst groupBy = 'category';\nconst omitWhere = { versionAbove: '12.0', category: ['flags'], version: ['0.6', '0.7'] };\n\n// Only omitting\nunicodeEmoji.getEmojis(omitWhere);\n\n// Only grouping\nunicodeEmoji.getEmojisGroupedBy(groupBy);\n\n// Grouping and omitting\nunicodeEmoji.getEmojisGroupedBy(groupBy, omitWhere);\n```\n\nKeep in mind that :\n\n```javascript\nconst omitWhere = { versionAbove: '13.0' };\n```\n\nIs equivalent to :\n\n```javascript\nconst omitWhere = { version: ['13.1', '14.0', '15.0', '15.1', '16.0'] };\n```\n\nBut you should always use the first one, as it will be future-proof for when new versions of `unicode-emoji` are released.\n\nSo that updating your dependencies will not opt you into newer emojis that are not yet supported on every platforms.\n\n\n## 📋 Details\n\nWhile complete data are available on GitHub :\n - `unicode-emoji.csv` provides complete flat data\n - `unicode-emoji.json` provides complete hierarchical data\n\nOnly the stripped-down `unicode-emoji.js` file is bundled within the NPM package to greatly reduce its size\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjulien-marcou%2Funicode-emoji","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjulien-marcou%2Funicode-emoji","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjulien-marcou%2Funicode-emoji/lists"}