https://github.com/sibiraj-s/ngx-editor
๐๏ธ Rich Text Editor for angular using ProseMirror
https://github.com/sibiraj-s/ngx-editor
angular ngx-editor prosemirror rich-text-editor wysiwyg-editor
Last synced: 15 days ago
JSON representation
๐๏ธ Rich Text Editor for angular using ProseMirror
- Host: GitHub
- URL: https://github.com/sibiraj-s/ngx-editor
- Owner: sibiraj-s
- License: mit
- Created: 2017-09-22T12:22:09.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-04-26T13:46:12.000Z (about 1 month ago)
- Last Synced: 2025-04-26T14:38:12.851Z (about 1 month ago)
- Topics: angular, ngx-editor, prosemirror, rich-text-editor, wysiwyg-editor
- Language: TypeScript
- Homepage: https://sibiraj-s.github.io/ngx-editor/
- Size: 17.1 MB
- Stars: 472
- Watchers: 13
- Forks: 196
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-wysiwyg-editors - ngx-editor - ไฝฟ็จ ProseMirror ็ angular ๅฏๆๆฌ็ผ่พๅจ)  (ๅบไบ Angular)
- awesome-angular - ngx-editor - Rich Text Editor for Angular using ProseMirror. (Table of contents / Third Party Components)
- fucking-awesome-angular - ngx-editor - Rich Text Editor for Angular using ProseMirror. (Table of contents / Third Party Components)
- fucking-awesome-angular - ngx-editor - Rich Text Editor for Angular using ProseMirror. (Table of contents / Third Party Components)
README
# NgxEditor
The Rich Text Editor for Angular, Built on ProseMirror
> A simple rich text editor for angular applications built with ProseMirror. It is a drop in and easy-to-use editor
> and can be easily extended using prosemirror plugins to build any additional or missing features
## Getting Started
[demo] | [edit on stackblitz][stackblitz] | [documentation] | [migrating from other editors][migration]
### Installation
Install via Package managers such as [npm] or [pnpm] or [yarn]
```bash
npm install ngx-editor
# or
pnpm install ngx-editor
# or
yarn add ngx-editor
```
### Usage
**Note**: By default the editor comes with minimal features. Refer the [demo] and [documentation] for more details and examples.
Component
```ts
import { NgxEditorComponent, NgxEditorMenuComponent, Editor } from 'ngx-editor';
import { FormsModule } from '@angular/forms';
@Component({
selector: 'editor-component',
templateUrl: 'editor.component.html',
styleUrls: ['editor.component.scss'],
standalone: true,
imports: [NgxEditorComponent, NgxEditorMenuComponent, FormsModule],
})
export class NgxEditorComponent implements OnInit, OnDestroy {
html = '';
editor: Editor;
ngOnInit(): void {
this.editor = new Editor();
}
ngOnDestroy(): void {
this.editor.destroy();
}
}
```
Then in HTML
```html
```
Note: Input can be a HTML string or a jsonDoc
## Browser Compatibility
Mostly works on all Evergreen-Browsers like
- Google Chrome
- Microsoft Edge
- Mozilla Firefox
- Safari
- Opera
## Collaborative Editing
See https://sibiraj-s.github.io/ngx-editor/#/collab
## Icons
Icons are from https://fonts.google.com/icons
## Contributing
All contributions are welcome. See [CONTRIBUTING.md](./.github/CONTRIBUTING.md) to get started.
[npm]: https://www.npmjs.com/
[pnpm]: https://pnpm.io/
[yarn]: https://yarnpkg.com/lang/en/
[documentation]: https://sibiraj-s.github.io/ngx-editor
[demo]: https://ngx-editor.stackblitz.io/
[stackblitz]: https://stackblitz.com/edit/ngx-editor
[migration]: https://sibiraj-s.github.io/ngx-editor/#/migration