-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
23 changed files
with
1,813 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
# CKEditor 4 Angular Integration Changelog | ||
|
||
## ckeditor-angular 2.0.0 | ||
|
||
Breaking Changes: | ||
|
||
* [#130](https://github.com/ckeditor/ckeditor4-angular/issues/130): `DIVAREA` editor type has been deprecated. Use [Div Editing Area](https://ckeditor.com/cke4/addon/divarea) plugin instead (see [migration guide](https://ckeditor.com/docs/ckeditor4/latest/guide/dev_angular.html#using-the-div-based-editor-type)). | ||
|
||
## ckeditor4-angular 1.3.0 | ||
|
||
Other Changes: | ||
|
||
* Updated default CDN CKEditor 4 dependency to [4.15.0](https://github.com/ckeditor/ckeditor4/blob/master/CHANGES.md#ckeditor-415). | ||
* [#98](https://github.com/ckeditor/ckeditor4-angular/issues/98): Updated repository dependencies (no changes in the actual `ckeditor4-angular` package). | ||
* [#128](https://github.com/ckeditor/ckeditor4-angular/issues/128): Improve the stability of `getEditorNamespace()` method. | ||
|
||
## ckeditor4-angular 1.2.2 | ||
|
||
Fixed Issues: | ||
|
||
* [#110](https://github.com/ckeditor/ckeditor4-angular/issues/110): Fixed: Integration throws an error when CKEditor 4 component is removed from the DOM before CKEditor 4 is loaded. Thanks to [Benjamin Hugot](https://github.com/bhugot)! | ||
|
||
## ckeditor4-angular 1.2.1 | ||
|
||
Other Changes: | ||
|
||
* Updated the default CKEditor 4 CDN dependency to [4.14.1](https://github.com/ckeditor/ckeditor4/blob/master/CHANGES.md#ckeditor-4141). | ||
|
||
## ckeditor4-angular 1.2.0 | ||
|
||
New Features: | ||
|
||
* [#7](https://github.com/ckeditor/ckeditor4-angular/issues/7): The CKEditor 4 Angular component now exposes more CKEditor 4 native events. Thanks to [Eduard Zintz](https://github.com/ezintz)! The newly exposed events are: | ||
* [`paste`](https://ckeditor.com/docs/ckeditor4/latest/api/CKEDITOR_editor.html#event-paste) | ||
* [`afterPaste`](https://ckeditor.com/docs/ckeditor4/latest/api/CKEDITOR_editor.html#event-afterPaste) | ||
* [`dragStat`](https://ckeditor.com/docs/ckeditor4/latest/api/CKEDITOR_editor.html#event-dragstart) | ||
* [`dragEnd`](https://ckeditor.com/docs/ckeditor4/latest/api/CKEDITOR_editor.html#event-dragend) | ||
* [`drop`](https://ckeditor.com/docs/ckeditor4/latest/api/CKEDITOR_editor.html#event-drop) | ||
* [`fileUploadRequest`](https://ckeditor.com/docs/ckeditor4/latest/api/CKEDITOR_editor.html#event-fileUploadRequest) | ||
* [`fileUploadResponse`](https://ckeditor.com/docs/ckeditor4/latest/api/CKEDITOR_editor.html#event-fileUploadResponse) | ||
|
||
## ckeditor4-angular 1.1.0 | ||
|
||
Other Changes: | ||
|
||
* Updated the default CKEditor 4 CDN dependency to [4.14.0](https://github.com/ckeditor/ckeditor4/blob/master/CHANGES.md#ckeditor-414). | ||
|
||
## ckeditor4-angular 1.0.1 | ||
|
||
Other Changes: | ||
|
||
* Updated the default CKEditor 4 CDN dependency to [4.13.1](https://github.com/ckeditor/ckeditor4/blob/master/CHANGES.md#ckeditor-4131). | ||
|
||
## ckeditor4-angular 1.0.0 | ||
|
||
New Features: | ||
|
||
* [#6](https://github.com/ckeditor/ckeditor4-angular/issues/6): Added support for classic (iframe-based) editor. Starting from this version classic editor is used by default. | ||
* [#40](https://github.com/ckeditor/ckeditor4-angular/pull/40): Added support for Angular 5. | ||
|
||
Fixed Issues: | ||
|
||
* [#42](https://github.com/ckeditor/ckeditor4-angular/issues/42): Fixed: The `elementRef` related error is thrown when using Angular 5. | ||
* [#54](https://github.com/ckeditor/ckeditor4-angular/issues/54): Fixed: Two-way data binding does not work when the [Undo](https://ckeditor.com/cke4/addon/undo) plugin is not present. | ||
|
||
Other Changes: | ||
|
||
* Updated the default CKEditor 4 CDN dependency to [4.13.0](https://github.com/ckeditor/ckeditor4-angular/issues/59). | ||
|
||
## ckeditor4-angular 1.0.0-beta.2 | ||
|
||
Other Changes: | ||
|
||
* Updated the default CKEditor 4 CDN dependency to [4.12.1](https://github.com/ckeditor/ckeditor4-angular/commit/2bf8a8c489f2a9ea2f2d9304e2e3d92646dbe89e). | ||
|
||
## ckeditor4-angular 1.0.0-beta | ||
|
||
Other Changes: | ||
|
||
* [#28](https://github.com/ckeditor/ckeditor4-angular/issues/28): Updated package dev dependencies. | ||
|
||
## ckeditor4-angular 0.1.2 | ||
|
||
Other Changes: | ||
|
||
* [#20](https://github.com/ckeditor/ckeditor4-angular/issues/20): Added the "Quick Start" section to README file. | ||
* [#10](https://github.com/ckeditor/ckeditor4-angular/issues/10): Updated the LICENSE file with all required dependencies. | ||
|
||
## ckeditor4-angular 0.1.1 | ||
|
||
Other Changes: | ||
|
||
* `README.md` file improvements. | ||
|
||
## ckeditor4-angular 0.1.0 | ||
|
||
The first beta release of CKEditor 4 WYSIWYG Editor Angular Integration. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
Software License Agreement | ||
========================== | ||
|
||
**CKEditor 4 WYSIWYG editor Angular component** – https://github.com/ckeditor/ckeditor4-angular <br> | ||
Copyright (c) 2003-2020, [CKSource](https://cksource.com/) Frederico Knabben. All rights reserved. | ||
|
||
Licensed under the terms of any of the following licenses at your | ||
choice: | ||
|
||
- GNU General Public License Version 2 or later (the "GPL") | ||
http://www.gnu.org/licenses/gpl.html | ||
|
||
- GNU Lesser General Public License Version 2.1 or later (the "LGPL") | ||
http://www.gnu.org/licenses/lgpl.html | ||
|
||
- Mozilla Public License Version 1.1 or later (the "MPL") | ||
http://www.mozilla.org/MPL/MPL-1.1.html | ||
|
||
Sources of Intellectual Property Included in CKEditor | ||
----------------------------------------------------- | ||
|
||
Where not otherwise indicated, all CKEditor content is authored by CKSource engineers and consists of CKSource-owned intellectual property. In some specific instances, CKEditor will incorporate work done by developers outside of CKSource with their express permission. | ||
|
||
The following libraries are included in CKEditor 4 component for Angular under the following licenses: | ||
|
||
- load-script [MIT](https://github.com/eldargab/load-script#license) | ||
- tslib Copyright (c) 2012-2020 Microsoft [Apache-2.0](https://github.com/Microsoft/tslib/blob/master/LICENSE.txt) | ||
|
||
Trademarks | ||
---------- | ||
|
||
**CKEditor** is a trademark of [CKSource](https://cksource.com/) Frederico Knabben. All other brand and product names are trademarks, registered trademarks or service marks of their respective holders. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,136 @@ | ||
# CKEditor 4 WYSIWYG editor Angular component [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Check%20out%20CKEditor%204%20Angular%20integration&url=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Fckeditor4-angular) | ||
|
||
[![npm version](https://badge.fury.io/js/ckeditor4-angular.svg)](https://www.npmjs.com/package/ckeditor4-angular) | ||
[![GitHub tag](https://img.shields.io/github/tag/ckeditor/ckeditor4-angular.svg)](https://github.com/ckeditor/ckeditor4-angular) | ||
|
||
[![Build Status](https://travis-ci.org/ckeditor/ckeditor4-angular.svg?branch=master)](https://travis-ci.org/ckeditor/ckeditor4-angular) | ||
[![Dependency Status](https://david-dm.org/ckeditor/ckeditor4-angular/status.svg)](https://david-dm.org/ckeditor/ckeditor4-angular) | ||
[![devDependency Status](https://david-dm.org/ckeditor/ckeditor4-angular/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor4-angular?type=dev) | ||
|
||
[![Join newsletter](https://img.shields.io/badge/join-newsletter-00cc99.svg)](http://eepurl.com/c3zRPr) | ||
[![Follow Twitter](https://img.shields.io/badge/follow-twitter-00cc99.svg)](https://twitter.com/ckeditor) | ||
|
||
Official [CKEditor 4](https://ckeditor.com/ckeditor-4/) WYSIWYG editor component for Angular. | ||
|
||
We are looking forward to your feedback! You can report any issues, ideas or feature requests on the [integration issues page](https://github.com/ckeditor/ckeditor4-angular/issues/new). | ||
|
||
![CKEditor 4 screenshot](https://c.cksource.com/a/1/img/npm/ckeditor4.png) | ||
|
||
## Usage | ||
|
||
In order to create an editor instance in Angular, install the `ckeditor4-angular` npm package as a dependency of your project: | ||
|
||
```bash | ||
npm install --save ckeditor4-angular | ||
``` | ||
|
||
After installing, import `CKEditorModule` to your application: | ||
|
||
```js | ||
import { CKEditorModule } from 'ckeditor4-angular'; | ||
|
||
@NgModule( { | ||
imports: [ | ||
... | ||
CKEditorModule, | ||
... | ||
], | ||
… | ||
} ) | ||
``` | ||
|
||
You can now use the `<ckeditor>` tag in the component template to include the rich text editor: | ||
|
||
```html | ||
<ckeditor data="<p>Hello, world!</p>"></ckeditor> | ||
``` | ||
|
||
The `data` attribute used in the example above is responsible for setting the editor’s data. | ||
|
||
## Documentation and examples | ||
|
||
See the [CKEditor 4 Angular Integration](https://ckeditor.com/docs/ckeditor4/latest/guide/dev_angular.html) article and [Angular examples](https://ckeditor.com/docs/ckeditor4/latest/examples/angular.html) in the [CKEditor 4 documentation](https://ckeditor.com/docs/ckeditor4/latest/). | ||
|
||
## Browser support | ||
|
||
The CKEditor 4 Angular component works with all the [supported browsers](https://ckeditor.com/docs/ckeditor4/latest/guide/dev_browsers.html#officially-supported-browsers) except for Internet Explorer 8-10. | ||
|
||
## Supported Angular versions | ||
|
||
The integration can be used together with Angular at version 5.0.0 and higher. It is an implication of Angular metadata produced for this package by the Angular builder. Note that the `package.json` used in the main repository isn't published on NPM (the production one is present in `src/ckeditor/package.json`), so there are only a few peer dependencies: | ||
|
||
* `@angular/core` >= 5.0.0 | ||
* `@angular/common` >= 5.0.0 | ||
* `@angular/forms` >= 5.0.0 | ||
|
||
required by this package. | ||
|
||
## Contributing | ||
|
||
Here is how you can contribute to the development of the component. Any feedback and help will be most appreciated! | ||
|
||
### Reporting issues and feature requests | ||
|
||
All issues and feature requests should be reported in the [issues section](https://github.com/ckeditor/ckeditor4-angular/issues/new) of the official GitHub repository for the CKEditor 4 Angular integration. | ||
|
||
### Development | ||
|
||
Clone the [CKEditor 4 Angular integration repository](https://github.com/ckeditor/ckeditor4-angular). | ||
|
||
Once you have cloned it, install dependencies by running: | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
#### The structure of the repository | ||
|
||
This repository contains the following code: | ||
|
||
* `./src/ckeditor` contains the CKEditor component, | ||
* `./src/app` is a demo application using the component. | ||
|
||
#### Development server | ||
|
||
Run `ng serve` to start the development server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. | ||
|
||
#### Building samples | ||
|
||
Run `ng build` to build the samples. The build artifacts will be stored in the `samples/` directory. | ||
|
||
#### Running unit tests | ||
|
||
Run `npm test` to execute unit tests via [Karma](https://karma-runner.github.io). | ||
|
||
There are two options available to alternate the testing process: | ||
|
||
* `url` / `u` - pass custom URL to Karma, for example custom CKEditor 4 build. | ||
* `watch` / `w` - tell Karma to watch for changes. | ||
|
||
For example: | ||
|
||
``` | ||
npm run test -- -u http://localhost:5000/ckeditor.js -w | ||
``` | ||
|
||
#### Running end-to-end tests | ||
|
||
Run `ng e2e` to execute the end-to-end tests via [Protractor](https://www.protractortest.org/). | ||
|
||
#### Publishing | ||
|
||
To build and publish the package, run `npm run publish`. | ||
|
||
You can also manually build the package with `npm run build-package` which will be stored in `dist/`. Then you can publish it with `npm publish dist/`. | ||
|
||
## License | ||
|
||
Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved. | ||
|
||
Licensed under the terms of any of the following licenses at your choice: | ||
|
||
* [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html), | ||
* [GNU Lesser General Public License Version 2.1 or later](http://www.gnu.org/licenses/lgpl.html), | ||
* [Mozilla Public License Version 1.1 or later (the "MPL")](http://www.mozilla.org/MPL/MPL-1.1.html). | ||
|
||
For full details about the license, please check the `LICENSE.md` file. |
Oops, something went wrong.