# ngx-simple-text-editor

> Ngx Simple Text editor or ST editor is a simple native text editor component for Angular 9+.

Latest version **6.0.2** (published 2026-01-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install ngx-simple-text-editor
pnpm add ngx-simple-text-editor
yarn add ngx-simple-text-editor
bun add ngx-simple-text-editor
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 6.0.2 |
| Published | 2026-01-11 |
| First published | 2022-06-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 236.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Maintainers | raiper34 |
| Keywords | angular, text, editor, text editor, angular text editor, wysiwyg, wysiwyg editor |

## Links

- npm: https://www.npmjs.com/package/ngx-simple-text-editor
- Repository: https://github.com/Raiper34/ngx-simple-text-editor
- Homepage: https://ngx-simple-text-editor.netlify.app
- Issues: https://github.com/Raiper34/ngx-simple-text-editor/issues
- npm.io page: https://npm.io/package/ngx-simple-text-editor

## Dependencies (1)

- [tslib](https://npm.io/package/tslib.md) ^2.0.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

- 6.0.2 (latest) — 2026-01-11
- 6.0.1 — 2025-11-15
- 6.0.0 — 2025-11-15
- 5.0.3 — 2025-01-18
- 5.0.2 — 2025-01-09
- 5.0.1 — 2024-12-29
- 3.0.1 — 2024-06-15
- 2.0.1 — 2024-06-15
- 1.4.1 — 2024-06-14
- 5.0.0 — 2024-04-01
- 4.0.3 — 2023-10-26
- 4.0.2 — 2023-10-12
- 4.0.1 — 2023-08-27
- 4.0.0 — 2023-08-27
- 3.0.0 — 2023-01-10
- … 8 more at https://npm.io/package/ngx-simple-text-editor/versions

## README

[![npm version](https://badge.fury.io/js/ngx-simple-text-editor.svg)](https://badge.fury.io/js/ngx-simple-text-editor)
[![docs](https://badgen.net/badge/docs/online/orange)](https://ngx-simple-text-editor.netlify.app)
![npm bundle size](https://img.shields.io/bundlephobia/min/ngx-simple-text-editor)
![NPM](https://img.shields.io/npm/l/ngx-simple-text-editor)
[![CircleCI](https://circleci.com/gh/Raiper34/ngx-simple-text-editor.svg?style=shield)](https://circleci.com/gh/Raiper34/ngx-simple-text-editor)
[![Coverage Status](https://coveralls.io/repos/github/Raiper34/ngx-simple-text-editor/badge.svg?branch=main)](https://coveralls.io/github/Raiper34/ngx-simple-text-editor?branch=main)
[![npm](https://img.shields.io/npm/dt/ngx-simple-text-editor)](https://badge.fury.io/js/ngx-simple-text-editor)
[![npm](https://img.shields.io/npm/dm/ngx-simple-text-editor)](https://badge.fury.io/js/ngx-simple-text-editor)
[![npm](https://img.shields.io/npm/dw/ngx-simple-text-editor)](https://badge.fury.io/js/ngx-simple-text-editor)
[![](https://data.jsdelivr.com/v1/package/npm/ngx-simple-text-editor/badge?style=rounded)](https://www.jsdelivr.com/package/npm/ngx-simple-text-editor)
[![GitHub Repo stars](https://img.shields.io/github/stars/raiper34/ngx-simple-text-editor)](https://github.com/Raiper34/ngx-simple-text-editor)


![ngc simple text editor logo](assets/logo.svg)
# Ngx Simple Text editor
Ngx Simple Text editor or ST editor is a simple native text editor component for Angular 9+.
The key features of this editor are simplicity, cross-browser compatibility, and extensibility.

![demo](assets/demo.gif)


### Content
- [🔗 Compatibility](#-compatibility)
- [🚀 Instalation](#-instalation)
- [💻 Usage](#-usage)
- [📚 Documentation and demos](#-documentation-and-demos)
- [📖 License](#-license)


## 🔗 Compatibility
| Angular version | Ngx simple text editor version | Font awesome version |
|-----------------|--------------------------------|----------------------|
| 9 - 13          | 0.0.0 - 1.x.x                  | 5.0.0-7.x.x          |
| 14              | 2.x.x                          | 5.0.0-7.x.x          |
| 15              | 3.x.x                          | 5.0.0-7.x.x          |
| 16              | 4.x.x                          | 5.0.0-7.x.x          |
| 17 - 19         | 5.x.x                          | 5.0.0-7.x.x          |
| 20              | 6.x.x                          | 5.0.0-7.x.x          |

## 🚀 Instalation

`npm install ngx-simple-text-editor --save`

then add `NgxSimpleTextEditorModule` into module imports
```typescript
import {NgxSimpleTextEditorModule} from 'ngx-simple-text-editor';

@NgModule({
// ...
  imports: [
    // ...
    NgxSimpleTextEditorModule,
    // ...
  ],
// ...
})
```
If you want to use default button icons, you must install Font awesome. 
`npm install @fortawesome/fontawesome-free` and declare in styles in angular.json
```json
...
"styles": [
  "src/styles.scss",
  "node_modules/@fortawesome/fontawesome-free/css/all.css"
]
...
```

## 💻 Usage
You can use Ngx simple text editor as classic template-driven form input or as reactive form input.
```angular2html
<st-editor [(ngModel)]="content" [config]="config"></st-editor>
```
The editor has got only one @Input with config object, which is optional.
The config object is defined by placeholder and buttons, both are optional and can be omitted.  
```typescript
import { Component } from '@angular/core';
import {EditorConfig, ST_BUTTONS} from 'ngx-simple-text-editor';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.scss']
})
export class AppComponent {
  content = '';
  config: EditorConfig = {
    placeholder: 'Type something...',
    buttons: ST_BUTTONS,
  };
}
```

## 📚 Documentation and demos
[Online documentation and demos](https://ngx-simple-text-editor.netlify.app/)

# ⚖️ License
[MIT](https://choosealicense.com/licenses/mit/)

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