@domternal/vue 0.6.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 +42 -0
- package/dist/index.d.ts +786 -0
- package/dist/index.js +2046 -0
- package/dist/index.js.map +1 -0
- package/package.json +49 -0
package/README.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# @domternal/vue
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@domternal/vue)
|
|
4
|
+
[](https://github.com/domternal/domternal/blob/main/LICENSE)
|
|
5
|
+
|
|
6
|
+
A lightweight, extensible rich text editor toolkit built on <u>[ProseMirror](https://prosemirror.net/)</u>. Framework-agnostic headless core with first-class Angular, React, and Vue support.
|
|
7
|
+
Use it headless with vanilla JS/TS, add the built-in toolbar and theme, or drop in ready-made framework components. Fully tree-shakeable, import only what you use, unused extensions are stripped from your bundle.
|
|
8
|
+
|
|
9
|
+
## Links
|
|
10
|
+
|
|
11
|
+
<u>[Website](https://domternal.dev)</u> • <u>[Documentation](https://domternal.dev/v1/introduction)</u>
|
|
12
|
+
<u>[StackBlitz (Angular)](https://stackblitz.com/edit/domternal-angular-full-example)</u> • <u>[StackBlitz (React)](https://stackblitz.com/edit/domternal-react-full-example)</u> • <u>[StackBlitz (Vue)](https://stackblitz.com/edit/domternal-vue-full-example)</u> • <u>[StackBlitz (Vanilla TS)](https://stackblitz.com/edit/domternal-vanilla-full-example)</u>
|
|
13
|
+
|
|
14
|
+
## Features
|
|
15
|
+
|
|
16
|
+
See <u>[Packages & Bundle Size](https://domternal.dev/v1/packages)</u> for a full breakdown of all packages and what each one includes.
|
|
17
|
+
|
|
18
|
+
- **Headless core** - use with any framework or vanilla JS/TS
|
|
19
|
+
- **Angular components** - editor, toolbar, bubble menu, floating menu, emoji picker (signals, OnPush, zoneless-ready)
|
|
20
|
+
- **React components** - composable `Domternal` component, toolbar, bubble menu, floating menu, emoji picker, custom node views (React 18+)
|
|
21
|
+
- **Vue components** - composable `Domternal` component, `useEditor`/`useEditorState` composables, toolbar, bubble menu, floating menu, emoji picker, custom node views (Vue 3.3+)
|
|
22
|
+
- **57 extensions across 12 packages** - 23 nodes, 9 marks, and 25 behavior extensions
|
|
23
|
+
- **140+ chainable commands** - `editor.chain().focus().toggleBold().run()`
|
|
24
|
+
- **Full table support** - cell merging, column resize, row/column controls, cell toolbar, all free and MIT licensed
|
|
25
|
+
- **Tree-shakeable** - import only what you use, your bundler strips the rest
|
|
26
|
+
- **~38 KB gzipped** (own code), <u>[~108 KB total](https://domternal.dev/v1/packages)</u> with ProseMirror
|
|
27
|
+
- **TypeScript first** - 100% typed, zero `any`
|
|
28
|
+
- **8,500+ tests** - 2,677 unit tests and 5,800+ E2E tests across 120+ Playwright specs
|
|
29
|
+
- **Light and dark theme** - 70+ CSS custom properties for full visual control
|
|
30
|
+
- **Inline styles export** - `getHTML({ styled: true })` produces inline CSS ready for email clients, CMS, and Google Docs
|
|
31
|
+
- **SSR helpers** - `generateHTML`, `generateJSON`, `generateText` for server-side rendering
|
|
32
|
+
|
|
33
|
+
## Documentation
|
|
34
|
+
|
|
35
|
+
- <u>[Getting Started](https://domternal.dev/v1/getting-started)</u> - install and create your first editor
|
|
36
|
+
- <u>[Introduction](https://domternal.dev/v1/introduction)</u> - core concepts, architecture, and design decisions
|
|
37
|
+
- <u>[Packages & Bundle Size](https://domternal.dev/v1/packages)</u> - what each package includes and bundle size breakdown
|
|
38
|
+
- <u>[Blog](https://domternal.dev/blog)</u>
|
|
39
|
+
|
|
40
|
+
## License
|
|
41
|
+
|
|
42
|
+
<u>[MIT](https://github.com/domternal/domternal/blob/main/LICENSE)</u>
|