Installations

npm install @ckeditor/ckeditor5-vue

Pull Requests

Open

3

Total

110

Closed

18

Merged

89

Issues

Open

24

Total

221

Closed

197

Releases

27

v7.3.0

Published on 25 Nov 2024

v7.3.0-alpha.0

Published on 13 Nov 2024

v7.2.0

Published on 26 Sept 2024

v7.1.0

Published on 19 Sept 2024

v7.1.0-alpha.0

Published on 06 Sept 2024

v7.0.0

Published on 07 Aug 2024

View all 27 releases

Developer

ckeditor

Developer Guide

BETA

Module System

ESM

Min. Node Version

>=18.0.0

Typescript Support

Yes

Node Version

20.12.2

NPM Version

10.5.0 Statistics

361 Stars

446 Commits

77 Forks

18 Watching

1 Branches

54 Contributors

Updated on 28 Nov 2024

Bundle Size

13.75 kB

Minified

5.16 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (67.69%)

JavaScript (18.55%)

Vue (12.29%)

HTML (1.04%)

Shell (0.43%)

Total Downloads

Cumulative downloads

Total Downloads

6,056,639

Last day

-1.8%

8,832

Compared to previous day

Last week

6.1%

47,246

Compared to previous week

Last month

8%

194,632

Compared to previous month

Last year

64.4%

1,896,430

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

2

lodash-es @ckeditor/ckeditor5-integrations-common

Peer Dependencies

2

ckeditor5 vue

Versions

CKEditor 5 rich text editor component for Vue.js 3+

Dependency Status

⚠️ This repository contains the CKEditor 5 component for Vue.js 3+. The component for lower Vue.js versions is located in another repository - @ckeditor/ckeditor5-vue2.

Official CKEditor 5 rich text editor component for Vue.js.

Developer Documentation 📖

See the "Rich text editor component for Vue.js" 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, you can start the development server using one of the commands below:

1npm run dev

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

Prerequisites

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 #master branch is up-to-date: git fetch && git checkout master && git pull.
Prepare a release branch: git checkout -b release-[YYYYMMDD] where YYYYMMDD is 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 --from modifier 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.0 tag is our latest and that we want to release it on a stable channel. The --from modifier 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 #master branch.
Ping the @ckeditor/ckeditor-5-devops team 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.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Maintained

Determines if the project is "actively maintained".

10

Security-Policy

Determines if the project has published a security policy.

10

SAST

Determines if the project uses static code analysis.

9

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

9

License

Determines if the project has defined a license.

8

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

7

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

5

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

Score

7.4

/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 More