@mdaemon/html-editor-react 1.8.3 → 1.8.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +30 -16
  2. package/package.json +4 -1
package/README.md CHANGED
@@ -1,13 +1,19 @@
1
- [![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fmdaemon-technologies%2FMDHTMLEditor-react%2Fmaster%2Fpackage.json&query=%24.version&prefix=v&label=npm&color=blue)](https://www.npmjs.com/package/@mdaemon/html-editor-react) [![install size](https://packagephobia.com/badge?p=@mdaemon/html-editor-react)](https://packagephobia.com/result?p=@mdaemon/html-editor-react) [![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fmdaemon-technologies%2FMDHTMLEditor-react%2Fmaster%2Fpackage.json&query=%24.license&prefix=v&label=license&color=green)](https://github.com/mdaemon-technologies/MDHTMLEditor-react/blob/master/LICENSE) [![Node.js CI](https://github.com/mdaemon-technologies/MDHTMLEditor-react/actions/workflows/ci.yml/badge.svg)](https://github.com/mdaemon-technologies/MDHTMLEditor-react/actions/workflows/ci.yml)
1
+ # @mdaemon/html-editor-react
2
2
 
3
- # MDHTMLEditor React
3
+ [![npm](https://img.shields.io/npm/v/@mdaemon/html-editor-react?color=blue)](https://www.npmjs.com/package/@mdaemon/html-editor-react)
4
+ [![license](https://img.shields.io/npm/l/@mdaemon/html-editor-react?color=green)](LICENSE)
5
+ [![node](https://img.shields.io/node/v/@mdaemon/html-editor-react)](https://nodejs.org)
6
+ [![install size](https://packagephobia.com/badge?p=@mdaemon/html-editor-react)](https://packagephobia.com/result?p=@mdaemon/html-editor-react)
7
+ [![CI](https://github.com/mdaemon-technologies/MDHTMLEditor-react/actions/workflows/ci.yml/badge.svg)](https://github.com/mdaemon-technologies/MDHTMLEditor-react/actions/workflows/ci.yml)
8
+
9
+ React wrapper for MDHTMLEditor
4
10
 
5
11
  A React wrapper for [MDHTMLEditor](https://github.com/mdaemon-technologies/MDHTMLEditor) — a WYSIWYG HTML editor built on TipTap. Provides a drop-in replacement for `@tinymce/tinymce-react` with no license key required.
6
12
 
7
- ## Installation
13
+ ## Install
8
14
 
9
15
  ```bash
10
- npm install @mdaemon/html-editor-react @mdaemon/html-editor
16
+ npm install @mdaemon/html-editor-react
11
17
  ```
12
18
 
13
19
  **Peer dependencies:** `react` and `react-dom` (v18 or v19).
@@ -484,7 +490,7 @@ const templates: Template[] = [
484
490
 
485
491
  The `Template` interface:
486
492
 
487
- ```typescript
493
+ ```ts
488
494
  interface Template {
489
495
  id?: number | string;
490
496
  title: string;
@@ -807,16 +813,6 @@ Key differences:
807
813
  - `plugins` option is not needed — all features are built in
808
814
  - Toolbar customization uses `basicEditor: true/false` or a `toolbar` string
809
815
 
810
- ## Running the Demo
811
-
812
- A demo app is included to see the editor in action:
813
-
814
- ```bash
815
- npm run demo
816
- ```
817
-
818
- This starts a Vite dev server at `http://localhost:5173` with three sections: the `<Editor>` component, the `useEditor` hook, and a [Fonts](#fonts) panel with a live `getFontFamily()` / `getFontSize()` readout that follows the cursor and buttons for the block-font commands.
819
-
820
816
  ## Development
821
817
 
822
818
  The package is bundled with [Vite 8](https://vite.dev/) (Rolldown) and ships ES, CommonJS, and TypeScript declaration outputs.
@@ -836,6 +832,24 @@ The package is bundled with [Vite 8](https://vite.dev/) (Rolldown) and ships ES,
836
832
 
837
833
  Lint, typecheck, and tests run automatically in [CI](.github/workflows/ci.yml) on every push and pull request to `master` across Node 20, 22, 24, and 26.
838
834
 
835
+ ### Running the Demo
836
+
837
+ A demo app is included to see the editor in action:
838
+
839
+ ```bash
840
+ npm run demo
841
+ ```
842
+
843
+ This starts a Vite dev server at `http://localhost:5173` with three sections: the `<Editor>` component, the `useEditor` hook, and a [Fonts](#fonts) panel with a live `getFontFamily()` / `getFontSize()` readout that follows the cursor and buttons for the block-font commands.
844
+
845
+ ## Changelog
846
+
847
+ See [CHANGELOG.md](CHANGELOG.md).
848
+
839
849
  ## License
840
850
 
841
- LGPL-3.0-or-later &mdash; [MDaemon Technologies, Ltd.](https://www.mdaemon.com)
851
+ Published under the [LGPL-3.0-or-later](LICENSE) license.
852
+
853
+ Published by **MDaemon Technologies, Ltd.**
854
+ Simple Secure Email
855
+ [https://www.mdaemon.com](https://www.mdaemon.com)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mdaemon/html-editor-react",
3
- "version": "1.8.3",
3
+ "version": "1.8.4",
4
4
  "description": "React wrapper for MDHTMLEditor",
5
5
  "homepage": "https://github.com/mdaemon-technologies/MDHTMLEditor-react",
6
6
  "repository": {
@@ -48,6 +48,9 @@
48
48
  "url": "https://www.mdaemon.com"
49
49
  },
50
50
  "license": "LGPL-3.0-or-later",
51
+ "engines": {
52
+ "node": ">=20"
53
+ },
51
54
  "peerDependencies": {
52
55
  "react": "^19.0.0 || ^18.0.0",
53
56
  "react-dom": "^19.0.0 || ^18.0.0"