Official CKEditor 5 React component.
Installations
npm install @ckeditor/ckeditor5-reactDeveloper Guide
Typescript
Yes
Module System
ESM
Min. Node Version
>=18.0.0
Node Version
20.12.2
NPM Version
10.5.0
Score
72.2
Supply Chain
94.8
Quality
86
Maintenance
100
Vulnerability
50
License
Releases
Contributors
Languages
TypeScript (94.95%)
JavaScript (4.74%)
HTML (0.23%)
Shell (0.08%)
Developer
Download Statistics
Total Downloads
22,497,814
Last Day
14,331
Last Week
179,502
Last Month
1,203,111
Last Year
8,953,298
GitHub Statistics
428 Stars
782 Commits
100 Forks
20 Watching
12 Branches
64 Contributors
Bundle Size
26.37 kB
Minified
8.82 kB
Minified + Gzipped
Maintainers
Package Meta Information
Latest Version
9.4.0
Package Id
@ckeditor/ckeditor5-react@9.4.0
Unpacked Size
413.14 kB
Size
96.07 kB
File Count
29
NPM Version
10.5.0
Node Version
20.12.2
Publised On
25 Nov 2024
Total Downloads
Cumulative downloads
Total Downloads
22,497,814
Last day
-79%
14,331
Compared to previous day
Last week
-44.6%
179,502
Compared to previous week
Last month
27.7%
1,203,111
Compared to previous month
Last year
60.5%
8,953,298
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
2
CKEditor 5 rich text editor component for React
Official CKEditor 5 rich text editor component for React.
Developer Documentation 📖
See the "Rich text editor component for React" guide in the CKEditor 5 documentation to learn more:
Contributing
After cloning this repository, install necessary dependencies:
1npm install
You can also use Yarn.
Running the development server
To manually test the editor integration with different versions of React, you can start the development server using one of the commands below:
1npm run dev:16 # Open the demo projects using React 16. 2npm run dev:18 # Open the demo projects using React 18. 3npm run dev:19 # Open the demo projects using React 19.
Executing tests
To test the editor integration against a set of automated tests, run the following command:
1npm run test
If you want to run the tests in watch mode, use the following command:
1npm run test:watch
Building the package
To build the package that is ready to publish, use the following command:
1npm run build
Releasing package
CircleCI automates the release process and can release both channels: stable (X.Y.Z) and pre-releases (X.Y.Z-alpha.X, etc.).
Before you start, you need to prepare the changelog entries.
- Make sure the
#masterbranch is up-to-date:git fetch && git checkout master && git pull. - Prepare a release branch:
git checkout -b release-[YYYYMMDD]whereYYYYMMDDis the current day. - Generate the changelog entries:
yarn run changelog --branch release-[YYYYMMDD] [--from [GIT_TAG]].-
By default, the changelog generator uses the latest published tag as a starting point for collecting commits to process.
The
--frommodifier option allows overriding the default behavior. It is required when preparing the changelog entries for the next stable release while the previous one was marked as a prerelease, e.g.,@alpha.Example: Let's assume that the
v40.5.0-alpha.0tag is our latest and that we want to release it on a stable channel. The--frommodifier should be equal to--from v40.4.0. -
This task checks what changed in each package and bumps the version accordingly. It won't create a new changelog entry if nothing changes at all. If changes were irrelevant (e.g., only dependencies), it would make an "internal changes" entry.
-
Scan the logs printed by the tool to search for errors (incorrect changelog entries). Incorrect entries (e.g., ones without the type) should be addressed. You may need to create entries for them manually. This is done directly in CHANGELOG.md (in the root directory). Make sure to verify the proposed version after you modify the changelog.
-
- Commit all changes and prepare a new pull request targeting the
#masterbranch. - Ping the
@ckeditor/ckeditor-5-devopsteam to review the pull request and trigger the release process.
License
Licensed under the terms of GNU General Public License Version 2 or later. For full details about the license, please check the LICENSE.md file.
No vulnerabilities found.
Reason
30 commit(s) and 5 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
security policy file detected
Details
- Info: security policy file detected: SECURITY.md:1
- Info: Found linked content: SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1
- Info: Found text in security policy: SECURITY.md:1
Reason
no binaries found in the repo
Reason
SAST tool is run on all commits
Details
- Info: SAST configuration detected: CodeQL
- Info: all commits (28) are checked with a SAST tool
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: jobLevel 'packages' permission set to 'read': .github/workflows/codeql.yml:17
- Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql.yml:18
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql.yml:19
- Warn: no topLevel permission defined: .github/workflows/codeql.yml:1
- Info: no jobLevel write permissions found
Reason
license file detected
Details
- Info: project has a license file: LICENSE.md:0
- Warn: project license file does not contain an FSF or OSI license.
Reason
Found 9/11 approved changesets -- score normalized to 8
Reason
3 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Reason
branch protection is not maximal on development and all release branches
Details
- Info: 'allow deletion' disabled on branch 'master'
- Info: 'force pushes' disabled on branch 'master'
- Warn: 'branch protection settings apply to administrators' is disabled on branch 'master'
- Info: 'stale review dismissal' is required to merge on branch 'master'
- Warn: required approving review count is 1 on branch 'master'
- Warn: codeowners review is required - but no codeowners file found in repo
- Warn: 'last push approval' is disabled on branch 'master'
- Warn: no status checks found to merge onto branch 'master'
- Info: PRs are required in order to make changes on branch 'master'
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/ckeditor/ckeditor5-react/codeql.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/ckeditor/ckeditor5-react/codeql.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/ckeditor/ckeditor5-react/codeql.yml/master?enable=pin
- Info: 0 out of 3 GitHub-owned GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Score
7.4
/10
Last Scanned on 2024-12-23
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 @ckeditor/ckeditor5-react
@mdfe/ckeditor5-react
Official React component for CKEditor 5 – the best browser-based rich text editor.
@tony/ckeditor5-fileupload-react
A plugin for CKEditor 5.
anhnk3-ckeditor5
CKEditor 5 Classic Plus is a custom build built on top of CKEditor 5 Build - Classic (version: 35.0.1). It adds Simple Upload Adapter, Image Resize, Font Styling and much more to the official build.
ronds-react-markdown
React Ckeditor 5 for markdown