{"id":26837686,"url":"https://github.com/Stuhl/editorjs-inline-hotkey","last_synced_at":"2025-03-30T17:02:56.407Z","repository":{"id":284032550,"uuid":"953580288","full_name":"Stuhl/editorjs-inline-hotkey","owner":"Stuhl","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-23T19:08:37.000Z","size":27,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-23T19:35:16.763Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Stuhl.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2025-03-23T17:29:57.000Z","updated_at":"2025-03-23T19:08:40.000Z","dependencies_parsed_at":"2025-03-23T19:35:18.273Z","dependency_job_id":"995d9cf0-ac2d-4861-a724-9eba783ca536","html_url":"https://github.com/Stuhl/editorjs-inline-hotkey","commit_stats":null,"previous_names":["stuhl/editorjs-inline-hotkey"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Stuhl%2Feditorjs-inline-hotkey","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Stuhl%2Feditorjs-inline-hotkey/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Stuhl%2Feditorjs-inline-hotkey/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Stuhl%2Feditorjs-inline-hotkey/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Stuhl","download_url":"https://codeload.github.com/Stuhl/editorjs-inline-hotkey/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246350975,"owners_count":20763231,"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-03-30T17:01:02.801Z","updated_at":"2025-03-30T17:02:56.400Z","avatar_url":"https://github.com/Stuhl.png","language":"TypeScript","funding_links":[],"categories":["Tools"],"sub_categories":["Inline Tools"],"readme":"# EditorJS Inline Hotkey Plugin\n\n![Stability Badge](https://img.shields.io/badge/stability-stable-green.svg)\n![](https://badgen.net/badge/Editor.js/v2.0/blue)\n\nAdds a Inline Hotkey Marker for [Editor.js](https://editorjs.io). This plugin uses the [kbd](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/kbd) tag to stay in line with accessability rules and have semantic meaning to the marked text.\n\n![](assets/demo.gif)\n\n## Installation\n\nGet the package\n\n```shell\nnpm install editorjs-inline-hotkey\n```\n\nInclude module at your application\n\n```javascript\nimport EditorJSInlineHotkey from \"editorjs-inline-hotkey\"\n```\n\n## Usage\nAdd the plugin to your EditorJS instance:\n\n```javascript\nconst editor = new EditorJS({\n  holder: \"your-holder\",\n  tools : {\n    InlineHotkey: EditorJSInlineHotkey\n  }\n});\n```\n\nor in React with [react-editor-js](https://github.com/Jungwoo-An/react-editor-js).\n\n```javascript\nexport const ReactEditor = () =\u003e {\n  const ReactEditorJS = createReactEditorJS()\n\n  return (\n    \u003cReactEditorJS\n      defaultValue={....}\n      tools       ={{\n        InlineHotkey: EditorJSInlineHotkey\n      }}\n    /\u003e\n  )\n}\n```\n\n\n## Style customization\nYou can customize the hotkey style by overwriting the `editorjs-inline-hotkey` class. By default it has these properties:\n\n```css\n.editorjs-inline-hotkey {\n  padding      : 4px;\n  color        : hsla(0, 0%, 20%, 1);\n  font-weight  : 600;\n  border-radius: 4px;\n  font-size    : 13px;\n  border       : 1px solid hsla(0, 0%, 80%, 1);\n  box-shadow   : 0px 1px 0px hsla(0, 0%, 80%, 1);\n}\n```\n\n## Development\n\n```shell\nnpm run install\nnpm run watch\n```\n\nOpen a pull request if you spot any bugs!\n\n## License\n\nThis plugin is licensed under an MIT license.\n\n## Acknowledgements\n\nMade with 💛 by [Kaan Aksu](https://github.com/Stuhl)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FStuhl%2Feditorjs-inline-hotkey","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FStuhl%2Feditorjs-inline-hotkey","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FStuhl%2Feditorjs-inline-hotkey/lists"}