https://github.com/ckeditor/ckeditor5-vue2
Official CKEditor 5 component for Vue.js 2.x.
https://github.com/ckeditor/ckeditor5-vue2
Last synced: about 1 year ago
JSON representation
Official CKEditor 5 component for Vue.js 2.x.
- Host: GitHub
- URL: https://github.com/ckeditor/ckeditor5-vue2
- Owner: ckeditor
- License: other
- Created: 2020-11-06T14:06:00.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-14T08:58:40.000Z (over 1 year ago)
- Last Synced: 2025-06-10T23:01:57.742Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 2.16 MB
- Stars: 35
- Watchers: 12
- Forks: 20
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# CKEditor 5 rich text editor component for Vue.js 2.x
[](https://www.npmjs.com/package/@ckeditor/ckeditor5-vue2)
[](https://app.circleci.com/pipelines/github/ckeditor/ckeditor5-vue2?branch=master)
[](https://coveralls.io/github/ckeditor/ckeditor5-vue2?branch=master)
⚠️ This repository contains the CKEditor 5 component for Vue.js `2.x`. The component for Vue.js `3+` is located in another repository - [@ckeditor/ckeditor5-vue](https://github.com/ckeditor/ckeditor5-vue).
Official [CKEditor 5](https://ckeditor.com/ckeditor-5/) rich text editor component for Vue.js.
## [Developer Documentation](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/frameworks/vuejs-v2.html) 📖
See the ["Rich text editor component for Vue.js"](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/frameworks/vuejs-v2.html) guide in the [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest) to learn more:
* [Quick start](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/frameworks/vuejs-v2.html#quick-start)
* [Using component locally](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/frameworks/vuejs-v2.html#using-component-locally)
* [Using CKEditor from source](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/frameworks/vuejs-v2.html#using-ckeditor-from-source)
* [Using the Document editor build](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/frameworks/vuejs-v2.html#using-the-document-editor-build)
* [Component directives](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/frameworks/vuejs-v2.html#component-directives)
* [Component events](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/frameworks/vuejs-v2.html#component-events)
## Contributing
After cloning this repository, install necessary dependencies:
```bash
npm install
```
### Executing tests
```bash
npm run test -- [additional options]
# or
npm t -- [additional options]
```
The command accepts the following options:
* `--coverage` (`-c`) – Whether to generate the code coverage.
* `--source-map` (`-s`) – Whether to attach the source maps.
* `--watch` (`-w`) – Whether to watch test files.
* `--reporter` (`-r`) – Reporter for Karma (default: `mocha`, can be changed to `dots`).
* `--browsers` (`-b`) – Browsers that will be used to run tests (default: `Chrome`, available: `Firefox`).
If you are going to change the component (`src/ckeditor.js`) or plugin (`src/plugin.js`) files, remember about rebuilding the package. You can use `npm run develop` in order to do it automatically.
### Building the package
Build a minified version of the package that is ready to publish:
```bash
npm run build
```
### Changelog generator
```bash
npm run changelog
```
### Testing component with Vue CLI
When symlinking the component in an application generated using [Vue CLI](https://cli.vuejs.org/), make sure your `vue.config.js` file configures webpack in the following way:
```js
module.exports = {
configureWebpack: {
resolve: {
symlinks: false
}
}
};
```
Otherwise, the application will fail to load the component correctly and, as a result, it will throw a build error.
## Releasing package
### Changelog
Before starting the release process, you need to generate the changelog:
```bash
npm run changelog
```
### Publishing
After generating the changelog, you are able to release the package.
First, you need to bump the version:
```bash
npm run release:prepare-packages
```
After bumping the version, you can publish the changes:
```bash
npm run release:publish-packages
```
Note: The `release/` directory will be published.
## License
Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html). For full details about the license, please check the LICENSE.md file.