emoji-toolkit
Advanced tools
emoji-toolkit - npm Package Compare versions
Comparing version 4.5.0 to 4.5.1
| ### Installation | ||
| We've teamed up with [JSDelivr](http://www.jsdelivr.com/#!emojione) to provide a simple way to install these emoji on any javascript-enabled website. Add the following script and stylesheet links to the head of your webpage: | ||
| We've teamed up with [JSDelivr](https://www.npmjs.com/settings/joypixels/packages) to provide a simple way to install these emoji on any javascript-enabled website. Add the following script and stylesheet links to the head of your webpage: | ||
| ``` | ||
| <script src="https://cdn.jsdelivr.net/npm/joypixels@4.5.0/lib/js/joypixels.min.js"></script> | ||
| <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/joypixels@4.5.0/extras/css/joypixels.min.css"/> | ||
| <script src="https://cdn.jsdelivr.net/npm/emoji-toolkit@4.5.1/lib/js/joypixels.min.js"></script> | ||
| <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/emoji-toolkit@4.5.1/extras/css/joypixels.min.css"/> | ||
| ``` | ||
@@ -14,3 +14,3 @@ | ||
| ``` | ||
| > npm install joypixels | ||
| > npm install emoji-toolkit | ||
| ``` | ||
@@ -20,3 +20,3 @@ | ||
| ``` | ||
| > bower install joypixels | ||
| > bower install emoji-toolkit | ||
| ``` | ||
@@ -23,0 +23,0 @@ |
| Package.describe({ | ||
| name: 'joypixels:emoji-toolkit', | ||
| summary: 'Meteor Package of the https://www.joypixels.com/ set.', | ||
| version: '4.5.0', | ||
| version: '4.5.1', | ||
| git: 'https://github.com/joypixels/emoji-toolkit.git' | ||
@@ -6,0 +6,0 @@ }); |
| { | ||
| "name": "emoji-toolkit", | ||
| "version": "4.5.0", | ||
| "version": "4.5.1", | ||
| "description": "JoyPixels is a complete set of emoji designed for the web. The emoji-toolkit includes libraries to easily convert unicode characters to shortnames (:smile:) and shortnames to JoyPixels emoji images. PNG formats provided for the emoji images.", | ||
| "author": "JoyPixels <support@joypixels.com> (https://www.joypixels.com)", | ||
| "main": "lib/js/emojione.js", | ||
| "main": "lib/js/joypixels.js", | ||
| "keywords": [ | ||
@@ -8,0 +8,0 @@ "joypixels", |
| #  | ||
| > [](https://www.npmjs.com/package/joypixels) [](https://www.npmjs.com/package/joypixels) [](https://www.jsdelivr.com/package/npm/joypixels) | ||
| > [](https://www.npmjs.com/package/emoji-toolkit) [](https://www.npmjs.com/package/emoji-toolkit) [](https://www.jsdelivr.com/package/npm/emoji-toolkit) | ||
| A set of libraries to help users find and replace native system emojis with JoyPixels (formerly EmojiOne) in their app or website. | ||
| > ###Heads up! | ||
| > EmojiOne has rebranded to JoyPixels. Please see our [UPGRADE DOC](UPGRADE.md) for details on what's new, especially | ||
| > if you're migrating from [emojione](https://www.github.com/joypixels/emojione), as all references to "emojione" in | ||
| > class names and file names have been changed. | ||
@@ -8,0 +12,0 @@ ## What's Included? |
101
UPGRADE.md
@@ -1,79 +0,28 @@ | ||
| # Upgrading from JoyPixels v2 to JoyPixels v3+ | ||
| #Migrating from joypixels/emojione to joypixels/emoji-toolkit | ||
| * JoyPixels v3 brought about several breaking changes and new considerations | ||
| * please review JoyPixels Licensing for more information on using SVG or PNG (larger than 128px) assets | ||
| * EmojiOne has officially rebranded to JoyPixels | ||
| * The joypixels/emojione repository will no longer be updated and will eventually be deprecated | ||
| * See what's changed below | ||
| ## Libraries | ||
| **JS** | ||
| - Deprecated vars: | ||
| - [joypixels.js] imagePathSVG, imagePathSVGSprites, imageType (now defaulted to png) | ||
| - Tests also updated (added explicit protocol for cdn, included previously-added title attribute to img tag) | ||
| - Added vars: | ||
| - emojiVersion (str) | ||
| - emojiSize (str) | ||
| - greedyMatch (bool) | ||
| - blacklistChars (bool) | ||
| - spriteSize (str) | ||
| - riskyMatchAscii (bool) | ||
| - fileExtension (str) | ||
| **PHP** | ||
| - Deprecated vars: | ||
| - [src/Client.php] imagePathSVG, imagePathSVGSprites | ||
| - [src/Joypixels.php] imagePathSVG, imagePathSVGSprites, imageType | ||
| - Added vars: | ||
| - emojiVersion (str) | ||
| - emojiSize (str) | ||
| - greedyMatch (bool) | ||
| - blacklistChars (str) | ||
| - spriteSize (str) | ||
| - riskyMatchAscii (bool) | ||
| - fileExtension (str) | ||
| - Tests | ||
| - [tests/ConversionTest.php] removed testSmileyInsideAnObject() | ||
| - [tests/ConversionTest.php] removed testShortnameInsideOfObjectTag() | ||
| ## Demos | ||
| Replaced by ‘examples’. Contains code snippets of each of the functions previously demonstrated. Updated demos can be found at <a href="https://demos.joypixels.com/latest">https://demos.joypixels.com/latest</a>. | ||
| ## JSON Files | ||
| **EMOJI.JSON (updated)** | ||
| - primary key is now *base code point* rather than shortname | ||
| - base code point is the full unicode code point minus VS16 and ZWJ | ||
| - base code point is used as an identifier for emoji file names (PNG) as well as within sprites (CSS) | ||
| - **name** (str) | ||
| - **unicode_version** (num) - floating-point number indicating initial Unicode release | ||
| - **category** (str) - key for `category` property in `emoji_categories.json` | ||
| - **emoji_order** (num) is now simply **order** (num) | ||
| - **display** (num) determines whether an emoji should be shown on a keyboard | ||
| - **shortname** (str) colon-encapsulated, snake_case representation of the emoji name | ||
| - **aliases** (array) is now **shortname_alternates** (array) alternative (including previously-used) shortnames | ||
| - **aliases_ascii** (array) is now **ascii** (array) | ||
| - **diversity** (str) is either `null` or the base code point of the corresponding Fitzpatrick Emoji Modifier | ||
| - **diversities** (array) contains the base code points of the diversity children for a diversity parent (non-diverse, diversity base) | ||
| - **gender** (str) is either `null` or the base code point of the corresponding male/female emoji symbol | ||
| - **genders** (array) contains the base code points of the gender children for a gender parent (gender-neutral, gender base) | ||
| - **unicode** (str) and **unicode_alt** (str) are depricated. code points are now organized within **code_points** (array) | ||
| - **base** (str) is identical to the primary key | ||
| - **fully_qualified** (str) represents code point according to [this Unicode documentation](http://unicode.org/Public/emoji/11.0/emoji-test.txt) | ||
| - **non_fully_qualified** (str) derived from same documentation as FQ. NFQ code point convention is used for PNG file names in font file builds | ||
| - **output** (str) is the recommended code point to use for conversion to native unicode | ||
| - **match_default** (array) contains one or more code points used to identify native unicode | ||
| - **match_greedy** (array) contains one or more code points used to identify potential native unicode variants | ||
| - note: the match_greedy code point(s) may replace non-emoji variants producing undesired results | ||
| - **decimal** (str) replaces **code_decimal** (str) | ||
| - **keywords** (array) | ||
| **EMOJI_STRATEGY.JSON (updated)** | ||
| - primary key is now *base code point* rather than short name | ||
| - **aliases** (str) is now **shortname_alternates** (array) | ||
| - **keywords** (str) is now **keywords** (array) | ||
| - **unicode** (str) is now **unicode_output** (str) | ||
| **EMOJI_CATEGORIES.JSON (new)** | ||
| - **order** (str) | ||
| - **category** (str) | ||
| - **category_label** (str) | ||
| ## Shortname Changes | ||
| Along with the many changes to EmojiOne version 3.0 comes a number of shortname updates. **Any shortnames that change will still appear as an alternate shortname (or alias) in the data files.** You can view the complete list of primary shortname changes in the [extras/alpha-codes readme](extras/alpha-codes/). | ||
| ## What's Changed? | ||
| **Libraries** | ||
| - This repository retains all PHP and JS library functionality, with renamed classes, attributes, and variables | ||
| - PHP namespace/classes changed from `Emojione` to `JoyPixels` | ||
| - JS library name has changed `joypixels.js` (`joypixels.min.js`) | ||
| - CSS filename has changed to `joypixels.css` (`joypixels.min.css`) | ||
| - emojione-awesome is now joypixels-awesome | ||
| - implementation class names have changed from `e1a-` to `jpa-` (e.g. `e1a-sm e1a-grinning` is now `jpa-sm jpa-grinning`) | ||
| - The joypixels/emoji-toolkit repository deprecates existing libraries: | ||
| - ios | ||
| - android | ||
| - swift | ||
| - These libraries have been replaced by standalone projects: | ||
| - ios [https://www.github.com/joypixels/emoji-toolkit-ios](https://www.github.com/joypixels/emoji-toolkit-ios) | ||
| - android [https://www.github.com/joypixels/emoji-toolkit-android](https://www.github.com/joypixels/emoji-toolkit-android) | ||
| **Emoji Assets** | ||
| - the new asset repository is located at [https://www.github.com/joypixels/emoji-assets](https://www.github.com/joypixels/emoj-assets) | ||
| - sprite filenames have changed from `emojione-` to `joypixels-` | ||
| - sprite css class names have changed from `emojione-` to `joypixels` |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Number of lines in readme file
- increased by5.33%
79
Worsened metrics
- Total package byte prevSize
- decreased by-0.04%
5983672
No dependency changes