{"id":27963194,"url":"https://github.com/windmillcode/quill-emoji","last_synced_at":"2025-05-07T19:58:23.305Z","repository":{"id":236351168,"uuid":"792431438","full_name":"WindMillCode/quill-emoji","owner":"WindMillCode","description":"Support of contentco/quill-emoji","archived":false,"fork":false,"pushed_at":"2024-12-03T12:55:09.000Z","size":13870,"stargazers_count":9,"open_issues_count":5,"forks_count":5,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-05-07T19:58:16.556Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/WindMillCode.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","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},"funding":{"github":["windmillcode"],"patreon":"windmillcode","ko_fi":"windmillcode","open_collective":"windmill-code","community_bridge":"42056b04-305f-4e08-929c-66725181d6af","liberapay":"windmillcode","tidelift":"npm/windmillcode","polar":"windmillcode","thanks_dev":"windmillcode","custom":["https://www.gofundme.com/f/strengthen-our-business-to-take-on-bigger-initiati?utm_campaign=p_lico+share-sheet-first-launch\u0026utm_medium=copy_link\u0026utm_source=customer"]}},"created_at":"2024-04-26T16:50:38.000Z","updated_at":"2024-12-03T12:55:37.000Z","dependencies_parsed_at":"2024-12-03T13:40:27.519Z","dependency_job_id":null,"html_url":"https://github.com/WindMillCode/quill-emoji","commit_stats":null,"previous_names":["windmillcode/quill-emoji"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WindMillCode%2Fquill-emoji","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WindMillCode%2Fquill-emoji/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WindMillCode%2Fquill-emoji/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WindMillCode%2Fquill-emoji/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WindMillCode","download_url":"https://codeload.github.com/WindMillCode/quill-emoji/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252949274,"owners_count":21830150,"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":[],"created_at":"2025-05-07T19:58:22.688Z","updated_at":"2025-05-07T19:58:23.282Z","avatar_url":"https://github.com/WindMillCode.png","language":"JavaScript","funding_links":["https://github.com/sponsors/windmillcode","https://patreon.com/windmillcode","https://ko-fi.com/windmillcode","https://opencollective.com/windmill-code","https://funding.communitybridge.org/projects/42056b04-305f-4e08-929c-66725181d6af","https://liberapay.com/windmillcode","https://tidelift.com/funding/github/npm/windmillcode","https://polar.sh/windmillcode","https://thanks.dev/windmillcode","https://www.gofundme.com/f/strengthen-our-business-to-take-on-bigger-initiati?utm_campaign=p_lico+share-sheet-first-launch\u0026utm_medium=copy_link\u0026utm_source=customer"],"categories":[],"sub_categories":[],"readme":"# Notes\n* shorthand does not work make a PR to fix and make an option\n* everything seems to export as [name].default and all the usual properties exist on  [name].default need assistance in order to make truly tree shakable\n* built for Quill 2.0.0 lsb\nversion will be based on version starting with  2.0.0000\n  * [2.0.0] - is the quill version\n  * [000] - is the major minor patch version of our library\n  * meaning we only have 9 digits avaialble for major,minor and patch before we have to wait for qull library to update hopefully it does not come to that\n  * however according to the semver spec the there cant be trailing zeros so for 2.0.0 there will be patch  updates until 2.x.x comes out\n  * for every new version of quill down to its patch there will be new release hopefully on the same day\n* there is no testing but minimal modification from quill emoji to get things to work with quill 2.0.0 feel free to add test cases and open a PR\n* cant copy emojis open a PR as necessary\n\n\n\n# Windmillcode Quill Emoji Selector\nModule extension for [Quill.js](https://github.com/quilljs/quill) that handles emojis in the toolbar. Through this extension, you can add emojis through the toolbar at the top, or by typing the emoji code.\n\n![Screenshot](/demo/screenshot.png)\n\n\n\u003c!-- Needs fix --\u003e\nTo add an emoji via emoji code, type ``:`` followed by the first few letters, and an autocomplete menu will appear. You can then select or ``tab`` to the preferred emoji.\n\n\n## Installation\n\n```sh\nnpm install  @windmillcode/quill-emoji\n```\n\n## Usage\n\n\n```javascript\n// someone can contribute and make ShortNameEmoji work\n// itseems the only emoji needed is text area\nimport Quill from 'quill';\nimport {\n// ShortNameEmoji\n// EmojiBlot\n// ToolbarEmoji\n  TextAreaEmoji }from \"@windmillcode/quill-emoji\";\n\n\n// Quill.register(EmojiBlot)\n// Quill.register('modules/emoji-shortname', ShortNameEmoji,true)\n// Quill.register('modules/emoji-toolbar', ToolbarEmoji,true)\nQuill.register('modules/emoji-textarea', TextAreaEmoji,true)\n```\n\n### Import styles\n\nStyles are present under\n\n```javascript\nimport \"@windmillcode/quill-emoji/quill-emoji.css\";\n```\n\n\n\n\n### Options\nSee [emoji-list.js](src/emoji-list.js) for emoji list example\n\n#### Example options\n```javascript\n// Custom emoji-list\nconst emojiList = [ /* emojiList */ ];\n\n// MDI emojicon instead of default icon\nconst emojiIcon = '\u003csvg class=\"i\" viewBox=\"0 0 24 24\"\u003e\u003cuse href=\"#emoticon-happy\"\u003e\u003c/use\u003e\u003c/svg\u003e';\n\nconst quill = new Quill(editor, {\n  // ...\n  modules: {\n    // ...\n    \"emoji-shortname\": {\n      emojiList: emojiList,\n      fuse: {\n        shouldSort: true,\n        threshold: 0.1,\n        location: 0,\n        distance: 100,\n        maxPatternLength: 32,\n        minMatchCharLength: 1,\n        keys: [\n          \"shortname\"\n        ]\n      },\n      onOpen: function() { /* ... */ },\n      onClose: function(emojiListItem) { /* ... */ }\n    },\n    \"emoji-toolbar\": {\n      buttonIcon: emojiIcon\n    },\n    \"emoji-textarea\": {\n      buttonIcon: emojiIcon\n    }\n\n  }\n});\n```\n\n### Custom Emoji Blot\nIf you need to display the emojis in a different way, you can customize the [emoji blot](src/format-emoji-blot.js) by creating a new blot or extending the default emoji blot.\n\n\n\n## Contributing\n\nPlease check out our [contributing guidelines](CONTRIBUTING.md).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwindmillcode%2Fquill-emoji","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwindmillcode%2Fquill-emoji","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwindmillcode%2Fquill-emoji/lists"}