Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jodit/jodit-angular
Angular wrapper for Jodit && Hey. Due to the fact that I do not use Angular in my projects, I cannot fix plugin errors in a timely manner. If you want the plugin to develop, send PR or better become a contributor
https://github.com/jodit/jodit-angular
Last synced: 25 days ago
JSON representation
Angular wrapper for Jodit && Hey. Due to the fact that I do not use Angular in my projects, I cannot fix plugin errors in a timely manner. If you want the plugin to develop, send PR or better become a contributor
- Host: GitHub
- URL: https://github.com/jodit/jodit-angular
- Owner: jodit
- License: mit
- Created: 2017-12-08T11:33:32.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-26T14:12:35.000Z (8 months ago)
- Last Synced: 2024-10-04T03:33:48.917Z (about 1 month ago)
- Language: TypeScript
- Homepage:
- Size: 5.82 MB
- Stars: 48
- Watchers: 8
- Forks: 35
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-wysiwyg - jodit-angular - Angular wrapper around Jodit to make it easier to use in a Angular. (For Angular)
- awesome-wysiwyg-editors - jodit-angular - 围绕 Jodit 的 Angular 包装器，使其更容易在 Angular 中使用。  (基于 Angular)
README
> Hey. Due to the fact that I do not use Angular in my projects, I cannot fix plugin errors in a timely manner. If you want the plugin to develop, send PR or better become a contributor
# Jodit Angular Component
[](https://www.npmjs.com/package/jodit-angular)
[](https://www.npmjs.com/package/jodit-angular)
[](https://www.npmjs.com/package/jodit-angular)
This package is a wrapper around [Jodit](https://xdsoft.net/jodit/) to make it easier to use in a Angular application.
## for contributors
The editor component itselt is located in the `jodit-angular` folder and packaged into a redistributable package with the [ng-packagr](https://www.npmjs.com/package/ng-packagr) tool. A test app has been created with the @angular/cli. It is located in the src directory and a dev server can be started by using the `npm start` command.
## Installation
```bash
$ npm install jodit-angular
```
## Usage
### Loading the component
Import the EditorModule from the npm package like this:
```typescript
import { JoditAngularModule } from 'jodit-angular';
```
And add it to you application module:
```typescript
// This might look different depending on how you have set up your app
// but the important part is the imports array
@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
JoditAngularModule // <- Important part
],
providers: [],
bootstrap: [AppComponent]
})
```
Using the component in your templates
Use the editor in your templates like this:
```html
```
In config you can set all [Jodit's options](https://xdsoft.net/jodit/play.html)
**Note about toolbar buttons override:**
Jodit editor apply a different toolbar buttons layout based on width available for the editor itself.
So a different width size for editor will show a different buttons layout.
The "buttons" config setting in the example above will override only the default toolbar buttons for large widths.
If you want to override buttons displayed on all editor sizes use something like this:
```
```
## Event binding
You can also bind editor events via a shorthand prop on the editor, for example:
```html
```
### Events list
* onChange
* onKeydown
* onMousedown
* onClick
* onFocus
* onPaste
* onResize
* onBeforeEnter
* onBeforeCommand
* onAfterCommand
* onAfterExec
* onAfterPaste
* onChangeSelection
Where the handler gets called with an object containing the properties event, which is the event object, and editor, which is a reference to the editor.
\
License
-----
This package is available under `MIT` License.