@malva-ui/editor 0.1.12 → 0.1.13

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Malva UI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,80 @@
+# @malva-ui/editor
+
+Rich-text editor for [Malva UI](https://www.npmjs.com/package/@malva-ui/core) — an SSR-safe Angular shell around a single browser-only [Tiptap](https://tiptap.dev) instance.
+
+Ships as its own package so applications that never render an editor never pull in Tiptap: every `@tiptap/*` peer lives here, not in `@malva-ui/core`.
+
+## Install
+
+```bash
+npm install @malva-ui/editor
+```
+
+Tiptap is a peer dependency set, so install it alongside:
+
+```bash
+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
+```
+
+## Quick start
+
+```ts
+import { MlvEditor } from '@malva-ui/editor';
+
+@Component({ imports: [MlvEditor] })
+export class ReleaseNotes {
+  readonly value = signal<string | null>('<p>Hello</p>');
+}
+```
+
+```html
+<mlv-editor [(value)]="value" label="Release notes" ariaLabel="Release notes editor" />
+```
+
+## Value formats
+
+`format` selects what the two-way `value` model holds:
+
+| `format`     | `value` shape                     |
+| ------------ | --------------------------------- |
+| `'html'`     | HTML string (default)             |
+| `'markdown'` | Markdown string                   |
+| `'json'`     | Serialised Tiptap JSON document   |
+
+```html
+<mlv-editor [(value)]="markdown" format="markdown" />
+```
+
+`value` is nullable — setting it to `null` clears the document.
+
+## Features
+
+- Composable extension presets, or pass your own via `extensions`
+- Replaceable command toolbar
+- Image uploads with an upload-placeholder extension
+- Block drag reordering via a block handle
+- Server-side rendering safe: Tiptap is only constructed in the browser
+
+## AI toolkit
+
+`@malva-ui/editor/ai` adds an optional AI surface — an action menu, a streaming transform contract, and an inline suggestion/review bar with word-level diffs:
+
+```ts
+import { MlvEditorAiMenu, MLV_EDITOR_AI_CONTEXT } from '@malva-ui/editor/ai';
+```
+
+You supply the model call; the package owns the editing UX around it.
+
+## Peer dependencies
+
+`@angular/cdk`, `@angular/common`, `@angular/core`, `@angular/forms`, `@lucide/angular`, `rxjs`, `@malva-ui/core`, `@malva-ui/cdk`, `@malva-ui/i18n`, and the twelve `@tiptap/*` packages listed above.
+
+## Related packages
+
+- [`@malva-ui/core`](https://www.npmjs.com/package/@malva-ui/core) — the component library
+- [`@malva-ui/cdk`](https://www.npmjs.com/package/@malva-ui/cdk) — headless primitives
+- [`@malva-ui/i18n`](https://www.npmjs.com/package/@malva-ui/i18n) — localisation
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,18 @@
 {
   "name": "@malva-ui/editor",
-  "version": "0.1.12",
+  "version": "0.1.13",
+  "description": "SSR-safe Angular rich-text editor for Malva UI — a Tiptap shell with HTML/Markdown/JSON values, image uploads and block reordering.",
+  "license": "MIT",
+  "keywords": [
+    "angular",
+    "editor",
+    "rich-text",
+    "wysiwyg",
+    "tiptap",
+    "prosemirror",
+    "markdown",
+    "malva-ui"
+  ],
   "publishConfig": {
     "access": "public"
   },
@@ -10,9 +22,9 @@
     "@angular/core": "22.0.7",
     "@angular/forms": "22.0.7",
     "@lucide/angular": "^1.25.0",
-    "@malva-ui/cdk": "0.1.12",
-    "@malva-ui/core": "0.1.12",
-    "@malva-ui/i18n": "0.1.12",
+    "@malva-ui/cdk": "0.1.13",
+    "@malva-ui/core": "0.1.13",
+    "@malva-ui/i18n": "0.1.13",
     "@tiptap/core": "3.29.2",
     "@tiptap/extension-file-handler": "3.29.2",
     "@tiptap/extension-highlight": "3.29.2",