CKEditor is a UI component add-on for Vaadin 8.
This project is fork of vaadin-ckeditor project from Yozons, Inc. (David Wall)
NOTICE that add-on licensing does not include CKEditor JavaScript library itself. It is required to use this add-on, please check their licensing at http://ckeditor.com/pricing . If you do not buy license you are using it under GPL / LGPL / MPL that will affect software you are using.
CKEditor add-on has Apache 2.0 license, so it can be used in closed source projects as long as you have suitable license from CKEditor.js.
CKEditor add-on's demo project has LGPL license, as it uses Open Source version of CKEditor.
Try the add-on demo at http://app.siika.fi/CKEditorDemo
- Fix value change handling (avoid loops) - Issue #3 and #5
- Use HTTPS to load js file from ckeditor.com (CKEditorTextField) - Issue #7
- Add missing setImmediate to get value change events faster
- Plugin example to demo project
- Initial release. Vaadin 8 port of Vaadin-CKEditor add-on from Yozons, Inc
Official releases of this add-on are available at Vaadin Directory. For Maven instructions, download and reviews, go to http://vaadin.com/addon/ckeditor
git clone mvn clean install cd demo mvn jetty:run
To see the demo, navigate to http://localhost:8080/
For further development of this add-on, the following tool-chain is recommended:
- Eclipse IDE
- m2e wtp plug-in (install it from Eclipse Marketplace)
- Vaadin Eclipse plug-in (install it from Eclipse Marketplace)
- JRebel Eclipse plug-in (install it from Eclipse Marketplace)
- Chrome browser
Choose File > Import... > Existing Maven Projects
Note that Eclipse may give "Plugin execution not covered by lifecycle configuration" errors for pom.xml. Use "Permanently mark goal resources in pom.xml as ignored in Eclipse build" quick-fix to mark these errors as permanently ignored in your project. Do not worry, the project still works fine.
If you have not already compiled the widgetset, do it now by running vaadin:install Maven target for ckeditor-root project.
If you have a JRebel license, it makes on the fly code changes faster. Just add JRebel nature to your ckeditor-demo project by clicking project with right mouse button and choosing JRebel > Add JRebel Nature
To debug project and make code modifications on the fly in the server-side, right-click the ckeditor-demo project and choose Debug As > Debug on Server. Navigate to http://localhost:8080/ckeditor-demo/ to see the application.
Debugging client side code in the ckeditor-demo project:
- run "mvn vaadin:run-codeserver" on a separate console while the application is running
- activate Super Dev Mode in the debug window of the application or by adding ?superdevmode to the URL
- You can access Java-sources and set breakpoints inside Chrome if you enable source maps from inspector settings.
- Proper clean up of code, removing dependency to legacy classes
The issues for this add-on are tracked on its github.com page. All bug reports and feature requests are appreciated.
Contributions are welcome, but there are no guarantees that they are accepted as such. Process for contributing is the following:
- Fork this project
- Create an issue to this project about the contribution (bug or feature) if there is no such issue about it already. Try to keep the scope minimal.
- Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
- Refer to the fixed issue in commit
- Send a pull request for the original project
- Comment on the original issue that you have implemented a fix for it
Add-on is distributed under Apache License 2.0. For license terms, see LICENSE.txt.
MyComponent is written by <...>
Notice that this add-on can be used without copying CKEditor javascript library to project. As it will by default load JavaScript library from ckeditor.com.
TODO, see documentation of old add-on.