Skip to content
This repository has been archived by the owner. It is now read-only.

jrquick17/ngx-text-editor

master
Switch branches/tags
Code
This branch is 106 commits ahead, 665 commits behind sibiraj-s:master.
Contribute

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
e2e
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

ngx-text-editor

npm npm npm

Index

About

This is an Angular 2+ WYSIWYG component.

  • Visit the demo to see it in action!
  • Visit my website for other cool projects!

Setup

Installation

For Angular 2-7:

npm install ngx-text-editor@^1.0.0 --save

For Angular 8:

npm install ngx-text-editor@^2 --save

For Angular 9+:

npm install ngx-text-editor@^3^ --save

Documentation

Import ngx-text-editor module

import { NgxTextEditorModule } from 'ngx-text-editor';

@NgModule({
  imports: [ NgxTextEditorModule ]
})

Import font-awesome into your application

Then in HTML

<ngx-text-editor [placeholder]="'Enter text here...'" [spellcheck]="true" [(ngModel)]="htmlContent"></ngx-text-editor>

For ngModel to work, You must import FormsModule from @angular/forms

Issues

If you find any issues feel free to open a request in the Issues tab. If I have the time I will try to solve any issues but cannot make any guarantees. Feel free to contribute yourself.

Documentation

Documentation is auto-generated using compodoc, and can be viewed here: https://jrquick17.github.io/ngx-text-editor/

Contributing

A special thanks to all of our contributors! To contribute yourself just submit a pull request!

Deploy

  • Generate Docs

    • Run npm run docs:build
  • Update Version

  • Build

    • Run npm run build from root.
  • Test

    • Copy dist/ contents into demo/node_modules/ngx-text-editor/
      • Run from root: cp -fr dist/* demo/node_modules/ngx-text-editor/
    • Run ionic serve from demo/
    • Run ionic build --prod from demo/
  • NPM Release

    • Run npm publish from dist/ directory.
  • Update Changelog

    • Add updates to CHANGELOG.md in root.

Future Plans

  • Add model for editorConfig
  • Update stackblitz
  • Update color picker

About

πŸ–‹οΈ A Simple WYSIWYG Editor for Angular 2+ apps.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 54.5%
  • HTML 27.8%
  • SCSS 16.3%
  • JavaScript 1.4%