# ng6x-editor

> WYSIWYG Editor for Angular 6+ Applications

Latest version **4.0.2** (published 2018-08-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install ng6x-editor
pnpm add ng6x-editor
yarn add ng6x-editor
bun add ng6x-editor
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.2 |
| Published | 2018-08-07 |
| First published | 2018-08-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | fulte004 |
| Keywords | angular-editor, angular-wysiwyg-editor, wysiwyg-editor, ng6x-editor, angular2-wysiwyg-editor, angular4-wysiwyg-editor |

## Links

- npm: https://www.npmjs.com/package/ng6x-editor
- Repository: https://github.com/fulte004/ng6x-editor
- Issues: https://github.com/fulte004/ng6x-editor/issues
- npm.io page: https://npm.io/package/ng6x-editor

## Dependencies (6)

- [hoek](https://npm.io/package/hoek.md) ^5.0.3
- [tslib](https://npm.io/package/tslib.md) ^1.9.0
- [eslint](https://npm.io/package/eslint.md) ^5.2.0
- [jquery](https://npm.io/package/jquery.md) ^3.3.1
- [popper.js](https://npm.io/package/popper.js.md) ^1.14.3
- [tunnel-agent](https://npm.io/package/tunnel-agent.md) ^0.6.0

## Alternatives

- [ext-list](https://npm.io/package/ext-list.md) — 6.3M weekly downloads
- [@lexical/selection](https://npm.io/package/@lexical/selection.md) — 3.8M weekly downloads
- [@lexical/text](https://npm.io/package/@lexical/text.md) — 3.6M weekly downloads
- [@lexical/clipboard](https://npm.io/package/@lexical/clipboard.md) — 3.0M weekly downloads
- [@tiptap/extension-mention](https://npm.io/package/@tiptap/extension-mention.md) — 3.0M weekly downloads

## Recent versions

- 4.0.2 (latest) — 2018-08-07
- 4.0.1 — 2018-08-06

## README

# NgxEditor

<p align="center">
  <a href="https://github.com/fulte004/ng6x-editor">
   <img src="https://raw.githubusercontent.com/Sibiraj-S/ng6x-editor/master/src/assets/icons/ng6x-editor.png" alt="ngxEditor">
  </a>
</p>
<p align="center">A Simple WYSIWYG Editor for Angular6+ Applications.</p>
<p align="center">
  <a href="https://travis-ci.org/Sibiraj-S/ng6x-editor">
    <img alt="Build Status" src="https://travis-ci.org/Sibiraj-S/ng6x-editor.svg?branch=master">
  </a>
  <a href="https://www.npmjs.com/package/ng6x-editor">
    <img alt="npm version" src="https://img.shields.io/npm/v/ng6x-editor.svg">
  </a>
  <a href="https://www.npmjs.com/package/ng6x-editor">
    <img alt="npm" src="https://img.shields.io/npm/dm/ng6x-editor.svg">
  </a>
  <a href="https://github.com/Sibiraj-S/ng6x-editor/blob/master/LICENSE">
    <img alt="licence" src="https://img.shields.io/npm/l/ng6x-editor.svg">
  </a>
</p>

## Getting Started

### Installation

Install via Package managers such as [npm][npm] or [yarn][yarn]

```bash
npm install ng6x-editor --save
# or
yarn add ng6x-editor
```

### Usage

Import `ng6x-editor` module

```typescript
import { NgxEditorModule } from 'ng6x-editor';

@NgModule({
  imports: [ NgxEditorModule ]
})
```

Import [font-awesome](https://github.com/FortAwesome/Font-Awesome) into your application

Then in HTML

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

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

#### PeerDependencies

`ng6x-editor` depeneds on the following libraries to work.

* [Font-Awesome v5.2.0](https://github.com/FortAwesome/Font-Awesome)
* [Ngx-Bootstrap](https://github.com/valor-software/ngx-bootstrap)

## Compatibility

All Evergreen-Browsers are supported

* Google Chrome
* Microsoft Edge
* Mozilla Firefox
* Opera

## Demo

Demo at stackblitz [ng6x-editor](https://ng6x-editor.stackblitz.io/)

## Documentation

Documentation is auto-generated using [compodoc][compodoc], and can be viewed here: [https://sibiraj-s.github.io/ng6x-editor/](https://sibiraj-s.github.io/ng6x-editor/)

[npm]: https://www.npmjs.com/
[yarn]: https://yarnpkg.com/lang/en/
[github]: https://fulte004.github.io/
[wiki]:https://github.com/Sibiraj-S/ng6x-editor/wiki/ngxEditor
[compodoc]: https://compodoc.github.io/website/

---
_Source: https://npm.io/package/ng6x-editor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._