debian-mirror-gitlab/doc/development/fe_guide/emojis.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

38 lines
2 KiB
Markdown
Raw Normal View History

2021-01-29 00:20:46 +05:30
---
stage: none
group: unassigned
2022-11-25 23:54:43 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2021-01-29 00:20:46 +05:30
---
2018-03-17 18:26:18 +05:30
# Emojis
2020-06-23 00:09:42 +05:30
GitLab supports native Unicode emojis and falls back to image-based emojis selectively
2018-03-17 18:26:18 +05:30
when your platform does not support it.
2019-09-30 21:07:59 +05:30
## How to update Emojis
2018-03-17 18:26:18 +05:30
1. Update the `gemojione` gem
2019-09-30 21:07:59 +05:30
1. Update `fixtures/emojis/index.json` from [Gemojione](https://github.com/bonusly/gemojione/blob/master/config/index.json).
2018-03-17 18:26:18 +05:30
In the future, we could grab the file directly from the gem.
We should probably make a PR on the Gemojione project to get access to
all emojis after being parsed or just a raw path to the `json` file itself.
1. Ensure [`emoji-unicode-version`](https://www.npmjs.com/package/emoji-unicode-version)
is up to date with the latest version.
1. Run `bundle exec rake gemojione:aliases`
1. Run `bundle exec rake gemojione:digests`
1. Run `bundle exec rake gemojione:sprite`
1. Ensure new sprite sheets generated for 1x and 2x
- `app/assets/images/emoji.png`
- `app/assets/images/emoji@2x.png`
2022-07-23 23:45:48 +05:30
1. Update `fixtures/emojis/intents.json` with any new emoji that we would like to highlight as having positive or negative intent.
- Positive intent should be set to `0.5`.
- Neutral intent can be set to `1`. This is applied to all emoji automatically so there is no need to set this explicitly.
- Negative intent should be set to `1.5`.
2018-03-17 18:26:18 +05:30
1. Ensure you see new individual images copied into `app/assets/images/emoji/`
2022-06-21 17:19:12 +05:30
1. Ensure you can see the new emojis and their aliases in the GitLab Flavored Markdown (GLFM) Autocomplete
2018-03-17 18:26:18 +05:30
1. Ensure you can see the new emojis and their aliases in the award emoji menu
2020-06-23 00:09:42 +05:30
1. You might need to add new emoji Unicode support checks and rules for platforms
2018-03-17 18:26:18 +05:30
that do not support a certain emoji and we need to fallback to an image.
See `app/assets/javascripts/emoji/support/is_emoji_unicode_supported.js`
and `app/assets/javascripts/emoji/support/unicode_support_map.js`