@malva-ui/editor 0.1.14 → 0.2.0
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.
- package/README.md +19 -3
- package/fesm2022/malva-ui-editor.mjs +1800 -317
- package/fesm2022/malva-ui-editor.mjs.map +1 -1
- package/package.json +18 -16
- package/types/malva-ui-editor.d.ts +264 -17
package/README.md
CHANGED
|
@@ -10,12 +10,20 @@ Ships as its own package so applications that never render an editor never pull
|
|
|
10
10
|
npm install @malva-ui/editor
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Tiptap
|
|
13
|
+
Tiptap and two ProseMirror packages are peer dependencies, so install them alongside. Tiptap must be **3.31 or later**, all twelve packages on one version:
|
|
14
14
|
|
|
15
15
|
```bash
|
|
16
|
-
npm install @tiptap/core @tiptap/pm @tiptap/starter-kit @tiptap/extensions @tiptap/markdown @tiptap/extension-file-handler @tiptap/extension-highlight @tiptap/extension-image @tiptap/extension-list @tiptap/extension-table @tiptap/extension-text-align @tiptap/extension-text-style
|
|
16
|
+
npm install @tiptap/core@^3.31 @tiptap/pm@^3.31 @tiptap/starter-kit@^3.31 @tiptap/extensions@^3.31 @tiptap/markdown@^3.31 @tiptap/extension-file-handler@^3.31 @tiptap/extension-highlight@^3.31 @tiptap/extension-image@^3.31 @tiptap/extension-list@^3.31 @tiptap/extension-table@^3.31 @tiptap/extension-text-align@^3.31 @tiptap/extension-text-style@^3.31 prosemirror-view@^1.42.5 prosemirror-model@^1.25.12
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
+
`prosemirror-view` ≥ 1.42.5 and `prosemirror-model` ≥ 1.25.12 are security floors (a paste XSS fix); 1.42.5 is the first view release that pairs with model ≥ 1.25.12. The install must resolve **exactly one copy of each**: a second, older `prosemirror-model` silently turns the fix off. Check with:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm ls prosemirror-view prosemirror-model
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Upgrading from Tiptap 3.29 or 3.30: see the [Tiptap 3.31 migration](https://github.com/N1XUS/malva-ui/blob/main/docs/migrations/2026-09-editor-tiptap-3-31.md).
|
|
26
|
+
|
|
19
27
|
## Quick start
|
|
20
28
|
|
|
21
29
|
```ts
|
|
@@ -67,7 +75,7 @@ You supply the model call; the package owns the editing UX around it.
|
|
|
67
75
|
|
|
68
76
|
## Peer dependencies
|
|
69
77
|
|
|
70
|
-
`@angular/cdk`, `@angular/common`, `@angular/core`, `@angular/forms`, `@lucide/angular`, `rxjs`, `@malva-ui/core`, `@malva-ui/cdk`, `@malva-ui/i18n`,
|
|
78
|
+
`@angular/cdk`, `@angular/common`, `@angular/core`, `@angular/forms`, `@lucide/angular`, `rxjs`, `@malva-ui/core`, `@malva-ui/cdk`, `@malva-ui/i18n`, the twelve `@tiptap/*` packages listed above (`^3.31.0`), `prosemirror-view` (`^1.42.5`) and `prosemirror-model` (`^1.25.12`).
|
|
71
79
|
|
|
72
80
|
## Related packages
|
|
73
81
|
|
|
@@ -75,6 +83,14 @@ You supply the model call; the package owns the editing UX around it.
|
|
|
75
83
|
- [`@malva-ui/cdk`](https://www.npmjs.com/package/@malva-ui/cdk) — headless primitives
|
|
76
84
|
- [`@malva-ui/i18n`](https://www.npmjs.com/package/@malva-ui/i18n) — localisation
|
|
77
85
|
|
|
86
|
+
## Versioning and support
|
|
87
|
+
|
|
88
|
+
Semver contract, what counts as public API, the deprecation window and the
|
|
89
|
+
support window per major:
|
|
90
|
+
[VERSIONING.md](https://github.com/N1XUS/malva-ui/blob/main/VERSIONING.md)
|
|
91
|
+
(the repository is private while the library is pre-1.0, so the link needs
|
|
92
|
+
repository access — ask us for the policy if it 404s for you).
|
|
93
|
+
|
|
78
94
|
## License
|
|
79
95
|
|
|
80
96
|
MIT
|