ngx-odinvt-emoji-mart

v0.0.5

Published

2 years ago

Customizable Slack-like emoji picker for Angular (Fork)

Downloads

0High
0Medium
0Low

odinvt

angular emoji picker

DEMO: https://typectrl.github.io/ngx-emoji-mart/

This project is a port of emoji-mart by missive

Installation

npm install ngx-odinvt-emoji-mart

Components

Picker

Import Module in ngModule

import { PickerModule } from 'ngx-odinvt-emoji-mart'

Import styles in styles.scss if using SASS

@import "~ngx-odinvt-emoji-mart/picker";

Or angular-cli can also include it via angular-cli.json

"styles": [
  "styles.scss",
  "../node_modules/ngx-odinvt-emoji-mart/picker.css"
]

use component

<emoji-mart title="Pick your emoji…" emoji="point_up"></emoji-mart>
<emoji-mart set="emojione"></emoji-mart>
<emoji-mart (emojiClick)="addEmoji($event)"></emoji-mart>
<emoji-mart [style]="{ position: 'absolute', bottom: '20px', right: '20px' }"></emoji-mart>
<emoji-mart [i18n]="{ search: 'Recherche', categories: { search: 'Résultats de recherche', recent: 'Récents' } }"></emoji-mart>

| Prop | ---------------------- | autoFocus | color | emoji | include | exclude | custom | recent | emojiSize | (emojiClick) | (emojiSelect) | perLine | i18n | native | set | sheetSize | backgroundImageFn | emojisToShowFilter | showPreview | emojiTooltip | skin | style | title | hideObsolete | Required | Default | Description | | :------: | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | false | Auto focus the search input when mounted | | | #ae65c5 | The top bar anchors select and hover color | | | department_store | emoji shown when no emojis are hovered, set to an empty string to show nothing | | | [] | Only load included categories. Accepts I18n categories keys. Order will be respected, except for the recent category which will always be the first. | | | [] | Don't load excluded categories. Accepts I18n categories keys. | | | [] | Custom emojis | | | | Pass your own frequently used emojis as array of string IDs | | | 24 | The emoji width and height | | | | not triggered on return key in search bar. Params: { emoji, $event } | | | | whenever an emoji is selected. returns { emoji, $event } | | | 9 | Number of emojis per line. While there’s no minimum or maximum, this will affect the picker’s width. This will set Frequently Used length as well (perLine * 4) | | | {…} | An object containing localized strings | | | false | Renders the native unicode emoji | | | apple | The emoji set: 'apple', 'google', 'twitter', 'emojione', 'messenger', 'facebook' | | | 64 | The emoji sheet size: 16, 20, 32, 64 | | | ((set, sheetSize) => …) | A Fn that returns that image sheet to use for emojis. Useful for avoiding a request if you have the sheet locally. | | | ((emoji) => true) | A Fn to choose whether an emoji should be displayed or not | | | true | Display preview section | | | false | Show emojis short name when hovering (title) | | | 1 | Default skin color: 1, 2, 3, 4, 5, 6 | | | | Inline styles applied to the root element. Useful for positioning | | | Emoji Mart™ | The title shown when no emojis are hovered | | | true | Hides ex: "cop" emoji in favor of female and male emoji |

I18n

search: 'Search',
notfound: 'No Emoji Found',
categories: {
  search: 'Search Results',
  recent: 'Frequently Used',
  people: 'Smileys & People',
  nature: 'Animals & Nature',
  foods: 'Food & Drink',
  activity: 'Activity',
  places: 'Travel & Places',
  objects: 'Objects',
  symbols: 'Symbols',
  flags: 'Flags',
  custom: 'Custom',
}

Sheet sizes

Sheets are served from unpkg, a global CDN that serves files published to npm.

| Set | sheetSize | Size | | --------- | --------- | ------- | | apple | 16 | 334 KB | | apple | 20 | 459 KB | | apple | 32 | 1.08 MB | | apple | 64 | 2.94 MB | | emojione | 16 | 315 KB | | emojione | 20 | 435 KB | | emojione | 32 | 1020 KB | | emojione | 64 | 2.33 MB | | facebook | 16 | 322 KB | | facebook | 20 | 439 KB | | facebook | 32 | 1020 KB | | facebook | 64 | 2.5 MB | | google | 16 | 301 KB | | google | 20 | 409 KB | | google | 32 | 907 KB | | google | 64 | 2.17 MB | | messenger | 16 | 325 KB | | messenger | 20 | 449 MB | | messenger | 32 | 1.05 MB | | messenger | 64 | 2.69 MB | | twitter | 16 | 288 KB | | twitter | 20 | 389 KB | | twitter | 32 | 839 KB | | twitter | 64 | 1.82 MB |

Examples of `emoji` object:

{
  id: 'smiley',
  name: 'Smiling Face with Open Mouth',
  colons: ':smiley:',
  text: ':)',
  emoticons: [
    '=)',
    '=-)'
  ],
  skin: null,
  native: '😃'
}

{
  id: 'santa',
  name: 'Father Christmas',
  colons: ':santa::skin-tone-3:',
  text: '',
  emoticons: [],
  skin: 3,
  native: '🎅🏼'
}

{
  id: 'octocat',
  name: 'Octocat',
  colons: ':octocat',
  text: '',
  emoticons: [],
  custom: true,
  imageUrl: 'https://assets-cdn.github.com/images/icons/emoji/octocat.png?v7'
}

Emoji

import { EmojiModule } from 'ngx-odinvt-emoji-mart/ngx-emoji/emoji.module'

<ngx-emoji [emoji]="{ id: 'santa', skin: 3 }" size="16"></ngx-emoji>
<ngx-emoji emoji=':santa::skin-tone-3:' size="16"></ngx-emoji>
<ngx-emoji emoji='santa' set='emojione' size="16"></ngx-emoji>

| Prop | Required | Default | Description | | ----------------------------------------------- | :------: | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | | emoji | ✓ | | Either a string or an emoji object | | size | ✓ | | The emoji width and height. | | native | | false | Renders the native unicode emoji | | (emojiClick) | | | Params: { emoji, $event } | | (emojiLeave) | | | Params: { emoji, $event } | | (emojiOver) | | | Params: { emoji, $event } | | fallback | | | Params: (emoji) => {} | | set | | apple | The emoji set: 'apple', 'google', 'twitter', 'emojione' | | sheetSize | | 64 | The emoji sheet size: 16, 20, 32, 64 | | backgroundImageFn | | ((set, sheetSize) => `https://unpkg.com/[email protected]/sheet_${set}_${sheetSize}.png`) | A Fn that returns that image sheet to use for emojis. Useful for avoiding a request if you have the sheet locally. | | skin | | 1 | Skin color: 1, 2, 3, 4, 5, 6 | | tooltip | | false | Show emoji short name when hovering (title) | | | hideObsolete | | false | Hides ex: "cop" emoji in favor of female and male emoji | |

Unsupported emojis fallback

Certain sets don’t support all emojis (i.e. Messenger & Facebook don’t support :shrug:). By default the Emoji component will not render anything so that the emojis’ don’t take space in the picker when not available. When using the standalone Emoji component, you can however render anything you want by providing the fallback props.

To have the component render :shrug: you would need to:

emojiFallback = emoji => `:${emoji.short_names[0]}:`

<ngx-emoji
  set="messenger"
  emoji="shrug"
  size="24"
  [fallback]="emojiFallback"
></ngx-emoji>

Custom emojis

You can provide custom emojis which will show up in their own category.

const customEmojis = [
  {
    name: 'Octocat',
    short_names: ['octocat'],
    text: '',
    emoticons: [],
    keywords: ['github'],
    imageUrl: 'https://assets-cdn.github.com/images/icons/emoji/octocat.png?v7'
  },
]

<ngx-emoji [custom]="customEmojis"></ngx-emoji>

Headless search

The Picker doesn’t have to be mounted for you to take advantage of the advanced search results.

import { EmojiSearch } from 'ngx-odinvt-emoji-mart';
class ex {
  constructor(private emojiSearch: EmojiSearch) {
    this.emojiSearch.search('christmas').map(o => o.native);
    // => [🎄, 🎅🏼, 🔔, 🎁, ⛄️, ❄️]
  }
}

Storage

By default EmojiMart will store user chosen skin and frequently used emojis in localStorage.

Possible keys are:

| Key | Value | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------- | | skin | 1, 2, 3, 4, 5, 6 | | | frequently | { 'astonished': 11, '+1': 22 } | An object where the key is the emoji name and the value is the usage count | | last | 'astonished' | (Optional) Used by frequently to be sure the latest clicked emoji will always appear in the “Recent” category |

Features

Powerful search

Short name, name and keywords

Not only does Emoji Mart return more results than most emoji picker, they’re more accurate and sorted by relevance.

Emoticons

The only emoji picker that returns emojis when searching for emoticons.

Fully customizable

Anchors color, title and default emoji

Emojis sizes and length

Default skin color

As the developer, you have control over which skin color is used by default.

It can however be overwritten as per user preference.

Multiple sets supported

Apple / Google / Twitter / EmojiOne / Messenger / Facebook

GitHub @scttcper · Twitter @scttcper