{"id":13770298,"url":"https://github.com/VolgaIgor/editorjs-annotation","last_synced_at":"2025-05-11T03:32:42.672Z","repository":{"id":178648578,"uuid":"661792825","full_name":"VolgaIgor/editorjs-annotation","owner":"VolgaIgor","description":"Allows to add an extended annotation to any text in EditorJS block","archived":false,"fork":false,"pushed_at":"2024-10-07T13:24:46.000Z","size":238,"stargazers_count":29,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-24T15:53:47.334Z","etag":null,"topics":["editorjs","editorjs-plugin"],"latest_commit_sha":null,"homepage":"","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/VolgaIgor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2023-07-03T16:55:03.000Z","updated_at":"2025-04-02T23:10:41.000Z","dependencies_parsed_at":"2024-11-17T06:44:07.200Z","dependency_job_id":null,"html_url":"https://github.com/VolgaIgor/editorjs-annotation","commit_stats":null,"previous_names":["volgaigor/editorjs-annotation"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VolgaIgor%2Feditorjs-annotation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VolgaIgor%2Feditorjs-annotation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VolgaIgor%2Feditorjs-annotation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VolgaIgor%2Feditorjs-annotation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VolgaIgor","download_url":"https://codeload.github.com/VolgaIgor/editorjs-annotation/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253514352,"owners_count":21920327,"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":["editorjs","editorjs-plugin"],"created_at":"2024-08-03T17:00:36.056Z","updated_at":"2025-05-11T03:32:42.335Z","avatar_url":"https://github.com/VolgaIgor.png","language":"JavaScript","funding_links":[],"categories":["Tools"],"sub_categories":["Inline Tools"],"readme":"# Annotation Inline Tool for Editor.js\nAllows to add an extended annotation to any text \n\n## Preview\n![Preview image](https://github.com/VolgaIgor/editorjs-annotation/raw/main/asset/screenshot.png)\n\n### Required\n- Editor.js v2.30+\n\n## Installation\n### Install via NPM\nGet the package\n\n```shell\n$ npm i editorjs-annotation\n```\n\nInclude module at your application\n\n```javascript\nimport Annotation from 'editorjs-annotation';\n```\n\n### Load from CDN\n\nYou can load a specific version of the package from jsDelivr CDN.\n\nRequire this script on a page with Editor.js.\n\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/editorjs-annotation\"\u003e\u003c/script\u003e\n```\n\n### Download to your project's source dir\n1. Upload folder `dist` from repository\n2. Add `dist/bundle.js` file to your page.\n\n## Usage\n```javascript\nvar editor = EditorJS({\n  // ...\n  tools: {\n    // ...\n    annotation: Annotation\n  },\n  // ...\n});\n```\n\n## Output data\nAnnotation will be wrapped with a `span` tag. with an `cdx-annotation` class.\n\nAdditional data will be store in element's dataset: `data-title`, `data-text`.\n\n```json\n{\n    \"type\" : \"paragraph\",\n    \"data\" : {\n        \"text\" : \"Nuclear power plants have a \u003cspan class=\\\"cdx-annotation\\\" data-title=\\\"Carbon footprint\\\" data-text=\\\"Indicator to compare the total amount...\\\"\u003ecarbon footprint\u003c/span\u003e...\"\n    }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FVolgaIgor%2Feditorjs-annotation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FVolgaIgor%2Feditorjs-annotation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FVolgaIgor%2Feditorjs-annotation/lists"}