Skip to content

Latest commit

ย 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

README.md

@emoji-platform-data/macos

Static export of macOS emoji picker metadata for unicode emojis. ๐ŸŽ

๐Ÿ“ License: MIT ๐Ÿ“ฆ npm version ๐Ÿ’ช TypeScript: Strict

Usage

npm i @emoji-platform-data/macos
import { byEmoji, byTitle } from "@emoji-platform-data/macos";

console.log(byEmoji["๐Ÿ™"]);
/*
{
	appleName: "octopus",
	category: "Nature",
	emoji: "๐Ÿ™",
	isCommon: true,
	keywords: ["octopus", "tentacle", "octopi", "octopuses", "tentacles", ...],
	order: 540,
	speechName: "an octopus emoji",
	unicodeName: "OCTOPUS",
	voiceOverName: "an octopus",
}
*/
  • byEmoji takes a glyph as any platform writes it, with or without its U+FE0F: byEmoji["โš“๏ธ"] and byEmoji["โš“"] are the same entry.
  • byTitle takes a PascalCase Emojipedia title.

Each entry is a MacOSItem describing one emoji as macOS's own emoji picker knows it:

  • keywords are the terms the picker searches, ordered by how strongly macOS weights each one for the emoji.
  • order is the emoji's position in the picker, across all categories.

This package is only static JSON and types, with no runtime dependencies, and its data is also in the combined emoji-platform-data.

Where This Data Comes From

This is a snapshot of the emoji search index in macOS's private CoreEmoji.framework, and DEVELOPMENT.md explains how to refresh it.

The keywords, names, and categories are Apple's: this package's MIT license only covers the code that packages them, and this package includes no Apple emoji artwork.