Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/concordnow/tinymce-ember
TinyMCE Ember addon
https://github.com/concordnow/tinymce-ember
ember ember-addon hacktoberfest tinymce
Last synced: about 1 month ago
JSON representation
TinyMCE Ember addon
- Host: GitHub
- URL: https://github.com/concordnow/tinymce-ember
- Owner: concordnow
- License: other
- Created: 2020-11-19T17:09:08.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-09-04T20:47:48.000Z (over 1 year ago)
- Last Synced: 2024-04-18T18:11:30.661Z (8 months ago)
- Topics: ember, ember-addon, hacktoberfest, tinymce
- Language: JavaScript
- Homepage: https://concordnow.github.io/tinymce-ember/
- Size: 7.66 MB
- Stars: 1
- Watchers: 5
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
tinymce-ember
==============================================================================
[](https://github.com/concordnow/tinymce-ember/actions/workflows/main.yml)
[](https://emberobserver.com/addons/tinymce-ember)
Ember addon that helps you integrate [TinyMCE](https://www.tiny.cloud/docs/) editor into your application.
Compatibility
------------------------------------------------------------------------------
* Ember.js v3.20 or above
* Ember CLI v3.20 or above
* Node.js v12 or above
* ember-auto-import >= 2
* Tinymce v5 or above
Installation
------------------------------------------------------------------------------
```
ember install tinymce-ember
```
**Note:**
The addon is designed in such way that it is the responsability of the application to provide the TinyMCE module.
Install TinyMCE via [package](https://www.npmjs.com/package/tinymce) or via [script](https://www.tiny.cloud/docs/quick-start/).
Motivation
------------------------------------------------------------------------------
This addon is inspired by official TinyMCE React plugin [tinymce-react](https://github.com/tinymce/tinymce-react).
Its goal is to be a standard, drop-in solution for the ember community.
Usage
------------------------------------------------------------------------------
Place the `{{editor}}` modifier on any `div`, `textarea` to create a TinyMCE editor instance.
Based on action up / data down principle, you can update your content.
[simple-example][]
You can pass [TinyMCE config](https://www.tiny.cloud/docs/configure/) object to your editor instance.
[inline-example][]
You can turn on/off TinyMCE read-only mode dynamically.
[disabled-example][]
API
------------------------------------------------------------------------------
### {{editor}}
**customEvents**: *Array*
Defaults to `[]`.
List of events given to the editor
Type of event should be
```js
{
name: string,
handler: function
}
```
**content**: *String*
Defaults to `''`.
A given string to be set as editor's content
**onEditorContentChange**: *String*
Defaults to `'change keyup setcontent'`.
Each of those events will call an `onEditorContentChange` function if given as parameter
Thanks
------------------------------------------------------------------------------
* [TinyMCE React](https://github.com/tinymce/tinymce-react)
Contributing
------------------------------------------------------------------------------
See the [Contributing](CONTRIBUTING.md) guide for details.
License
------------------------------------------------------------------------------
This project is licensed under the [MIT License](LICENSE.md).
[simple-example]: https://codesandbox.io/s/github/concordnow/tinymce-ember/tree/master/test-app?initialpath=%2Fexamples%2Fsimple&file=%2Fapp%2Fcomponents%2Fsimple-example.hbs
[inline-example]: https://codesandbox.io/s/github/concordnow/tinymce-ember/tree/master/test-app?initialpath=%2Fexamples%2Finline&file=%2Fapp%2Fcomponents%2Finline-example.hbs
[disabled-example]: https://codesandbox.io/s/github/concordnow/tinymce-ember/tree/master/test-app?initialpath=%2Fexamples%2Fdisabled&file=%2Fapp%2Fcomponents%2Fdisabled-example.hbs