Installations
npm install @editorjs/editorjsReleases
Developer
Developer Guide
Module System
CommonJS
Min. Node Version
Typescript Support
Yes
Node Version
NPM Version
Statistics
28,889 Stars
825 Commits
2,088 Forks
247 Watching
73 Branches
77 Contributors
Updated on 28 Nov 2024
Bundle Size
210.88 kB
Minified
56.50 kB
Minified + Gzipped
Languages
TypeScript (88.47%)
HTML (6.93%)
CSS (3.9%)
JavaScript (0.69%)
Total Downloads
Cumulative downloads
Total Downloads
9,066,737
Last day
-2%
20,092
Compared to previous day
Last week
4%
110,468
Compared to previous week
Last month
18.2%
439,163
Compared to previous month
Last year
74.4%
4,127,663
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
34
editorjs.io | documentation | changelog
About
Editor.js is an open-source text editor offering a variety of features to help users create and format content efficiently. It has a modern, block-style interface that allows users to easily add and arrange different types of content, such as text, images, lists, quotes, etc. Each Block is provided via a separate plugin making Editor.js extremely flexible.
Editor.js outputs a clean JSON data instead of heavy HTML markup. Use it in Web, iOS, Android, AMP, Instant Articles, speech readers, AI chatbots — everywhere. Easy to sanitize, extend and integrate with your logic.
- 😍 Modern UI out of the box
- 💎 Clean JSON output
- ⚙️ Well-designed API
- 🛍 Various Tools available
- 💌 Free and open source
Installation
It's quite simple:
- Install Editor.js
- Install tools you need
- Initialize Editor's instance
Install using NPM, Yarn, or CDN:
1npm i @editorjs/editorjs
Choose and install tools:
- Heading
- Quote
- Image
- Simple Image (without backend requirement)
- Nested List
- Checklist
- Link embed
- Embeds (YouTube, Twitch, Vimeo, Gfycat, Instagram, Twitter, etc)
- Table
- Delimiter
- Warning
- Code
- Raw HTML
- Attaches
- Marker
- Inline Code
See the 😎 Awesome Editor.js list for more tools.
Initialize the Editor:
1<div id="editorjs"></div>
1import EditorJS from '@editorjs/editorjs' 2 3const editor = new EditorJS({ 4 tools: { 5 // ... your tools 6 } 7})
See details about Installation and Configuration at the documentation.
Saving Data
Call editor.save() and handle returned Promise with saved data.
1const data = await editor.save()
Example
Take a look at the example.html to view more detailed examples.
Roadmap
- Unified Toolbars
- Block Tunes moved left
- Toolbox becomes vertical
- Ability to display several Toolbox buttons by the single Tool
- Block Tunes become vertical
- Block Tunes support nested menus
- Block Tunes support separators
- Conversion Menu added to the Block Tunes
- Unified Toolbar supports hints
- Conversion Toolbar uses Unified Toolbar
- Inline Toolbar uses Unified Toolbar
- Collaborative editing
- Implement Inline Tools JSON format
- Operations Observer, Executor, Manager, Transformer
- Implement Undo/Redo Manager
- Implement Tools API changes
- Implement Server and communication
- Update basic tools to fit the new API
- Other features
- Blocks drag'n'drop
- New cross-block selection
- New cross-block caret moving
- Ecosystem improvements
- CodeX Icons — the way to unify all tools and core icons
- New Homepage and Docs
- @editorjs/create-tool for Tools bootstrapping
- Editor.js DevTools — stand for core and tools development
- Editor.js Design System
- Editor.js Preset Env
- Editor.js ToolKit
- New core bundle system
- New documentation and guides
Like Editor.js?
You can support project improvement and development of new features with a donation to our team.
Donate via OpenCollective
Donate via Crypto
Donate via Patreon
Why donate
Donations to open-source products have several advantages for your business:
- If your business relies on Editor.js, you'll probably want it to be maintained
- It helps Editor.js to evolve and get the new features
- We can support contributors and the community around the project. You'll receive well organized docs, guides, etc.
- We need to pay for our infrastructure and maintain public resources (domain names, homepages, docs, etc). Supporting it guarantees you to access any resources at the time you need them.
- You can advertise by adding your brand assets and mentions on our public resources
Sponsors
Support us by becoming a sponsor. Your logo will show up here with a link to your website.
Backers
Thank you to all our backers
Contributors
This project exists thanks to all the people who contribute.
Need something special?
Hire CodeX experts to resolve technical challenges and match your product requirements.
- Resolve a problem that has high value for you
- Implement a new feature required by your business
- Help with integration or tool development
- Provide any consultation
Contact us via team@codex.so and share your details
Community
About CodeX
CodeX is a team of digital specialists around the world interested in building high-quality open source products on a global market. We are open for young people who want to constantly improve their skills and grow professionally with experiments in cutting-edge technologies.
| 🌐 | Join 👋 | ||
|---|---|---|---|
| codex.so | codex.so/join | @codex_team | @codex_team |
Stable Version
The latest stable version of the package.
Stable Version
2.30.7
MODERATE
1
6.1/10
Summary
Editor.js vulnerable to Code Injection
Affected Versions
< 2.26.0
Patched Versions
2.26.0
Reason
16 commit(s) and 14 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0
Reason
Found 20/21 approved changesets -- score normalized to 9
Reason
SAST tool is not run on all commits -- score normalized to 8
Details
- Warn: 24 commits out of 29 are checked with a SAST tool
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: jobLevel 'actions' permission set to 'write': .github/workflows/bump-version-on-merge-next.yml:22
- Warn: jobLevel 'contents' permission set to 'write': .github/workflows/bump-version-on-merge-next.yml:58
- Warn: jobLevel 'contents' permission set to 'write': .github/workflows/create-a-release-draft.yml:62
- Warn: jobLevel 'actions' permission set to 'write': .github/workflows/create-a-release-draft.yml:22
- Warn: no topLevel permission defined: .github/workflows/bump-version-on-merge-next.yml:1
- Warn: no topLevel permission defined: .github/workflows/create-a-release-draft.yml:1
- Warn: no topLevel permission defined: .github/workflows/cypress.yml:1
- Warn: no topLevel permission defined: .github/workflows/eslint.yml:1
- Warn: no topLevel permission defined: .github/workflows/publish-package-to-npm.yml:1
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/bump-version-on-merge-next.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/bump-version-on-merge-next.yml/next?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/bump-version-on-merge-next.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/bump-version-on-merge-next.yml/next?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/bump-version-on-merge-next.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/bump-version-on-merge-next.yml/next?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/bump-version-on-merge-next.yml:62: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/bump-version-on-merge-next.yml/next?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/bump-version-on-merge-next.yml:65: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/bump-version-on-merge-next.yml/next?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/bump-version-on-merge-next.yml:76: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/bump-version-on-merge-next.yml/next?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/bump-version-on-merge-next.yml:80: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/bump-version-on-merge-next.yml/next?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/create-a-release-draft.yml:65: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/create-a-release-draft.yml/next?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/create-a-release-draft.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/create-a-release-draft.yml/next?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/create-a-release-draft.yml:86: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/create-a-release-draft.yml/next?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/create-a-release-draft.yml:90: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/create-a-release-draft.yml/next?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/create-a-release-draft.yml:108: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/create-a-release-draft.yml/next?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/create-a-release-draft.yml:119: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/create-a-release-draft.yml/next?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/create-a-release-draft.yml:130: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/create-a-release-draft.yml/next?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/create-a-release-draft.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/create-a-release-draft.yml/next?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/create-a-release-draft.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/create-a-release-draft.yml/next?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/create-a-release-draft.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/create-a-release-draft.yml/next?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/create-a-release-draft.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/create-a-release-draft.yml/next?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/cypress.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/cypress.yml/next?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/cypress.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/cypress.yml/next?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/cypress.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/cypress.yml/next?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/eslint.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/eslint.yml/next?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/eslint.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/eslint.yml/next?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-package-to-npm.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/publish-package-to-npm.yml/next?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish-package-to-npm.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/publish-package-to-npm.yml/next?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-package-to-npm.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/publish-package-to-npm.yml/next?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-package-to-npm.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/publish-package-to-npm.yml/next?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish-package-to-npm.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/publish-package-to-npm.yml/next?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish-package-to-npm.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/codex-team/editor.js/publish-package-to-npm.yml/next?enable=pin
- Info: 0 out of 17 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 12 third-party GitHubAction dependencies pinned
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
Project has not signed or included provenance with any releases.
Details
- Warn: release artifact v2.31.0-rc.4 not signed: https://api.github.com/repos/codex-team/editor.js/releases/184002081
- Warn: release artifact v2.31.0-rc.3 not signed: https://api.github.com/repos/codex-team/editor.js/releases/183994432
- Warn: release artifact v2.31.0-rc.2 not signed: https://api.github.com/repos/codex-team/editor.js/releases/180502724
- Warn: release artifact v2.31.0-rc.4 does not have provenance: https://api.github.com/repos/codex-team/editor.js/releases/184002081
- Warn: release artifact v2.31.0-rc.3 does not have provenance: https://api.github.com/repos/codex-team/editor.js/releases/183994432
- Warn: release artifact v2.31.0-rc.2 does not have provenance: https://api.github.com/repos/codex-team/editor.js/releases/180502724
Reason
10 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-fx46-whrj-73v5
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-8jhw-289h-jh2g
- Warn: Project is vulnerable to: GHSA-64vr-g452-qvp3
- Warn: Project is vulnerable to: GHSA-9cwx-2883-4wfx
Score
4.8
/10
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn MoreOther packages similar to @editorjs/editorjs
@editorjs/list
List Tool for EditorJS
editorjs-drag-drop
Drag and Drop feature for Editor.js
@editorjs/header
Heading Tool for Editor.js
editorjs-html
A utility to parse editorjs clean data to HTML. - Use it with plain Javascript/Typescript, React, Angular, Vue or any templating engine/framework of your choice. - Fast, Efficient and Lightweight. - Fully customizable to the core. - Supports ba