@lexion-rte/nuxt 0.1.0 → 0.1.2

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 (3) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/README.md +53 -0
  3. package/package.json +6 -6
package/CHANGELOG.md ADDED
@@ -0,0 +1,23 @@
1
+ # @lexion-rte/nuxt
2
+
3
+ ## 0.1.2
4
+
5
+ ### Patch Changes
6
+
7
+ - Refresh package metadata links and expand package-level README documentation.
8
+ - Updated dependencies
9
+ - @lexion-rte/core@0.1.2
10
+ - @lexion-rte/vue@0.1.2
11
+
12
+ ## 0.1.1
13
+
14
+ ### Patch Changes
15
+
16
+ - Update package metadata and documentation for the `@lexion-rte` package set.
17
+
18
+ - Align repository/homepage/bugs metadata with the current GitHub repository owner.
19
+ - Add package-level README files with package purpose and usage examples.
20
+
21
+ - Updated dependencies
22
+ - @lexion-rte/core@0.1.1
23
+ - @lexion-rte/vue@0.1.1
package/README.md ADDED
@@ -0,0 +1,53 @@
1
+ # @lexion-rte/nuxt
2
+
3
+ Nuxt adapter for Lexion.
4
+
5
+ ## Overview
6
+
7
+ `@lexion-rte/nuxt` exports `LexionNuxtEditorView`, a Nuxt-friendly wrapper around the Vue adapter.
8
+
9
+ It is intended for client-side rendering in Nuxt.
10
+
11
+ ## Install
12
+
13
+ ```bash
14
+ pnpm add @lexion-rte/nuxt nuxt vue
15
+ ```
16
+
17
+ ## Usage with `ClientOnly`
18
+
19
+ ```vue
20
+ <template>
21
+ <ClientOnly>
22
+ <LexionNuxtEditorView v-model="value" />
23
+ </ClientOnly>
24
+ </template>
25
+
26
+ <script setup lang="ts">
27
+ import { ref } from "vue";
28
+ import type { JSONDocument } from "@lexion-rte/core";
29
+ import { LexionNuxtEditorView } from "@lexion-rte/nuxt";
30
+
31
+ const value = ref<JSONDocument | undefined>(undefined);
32
+ </script>
33
+ ```
34
+
35
+ ## Props
36
+
37
+ - `editor?: LexionEditor`
38
+ - `modelValue?: JSONDocument`
39
+ - `defaultValue?: JSONDocument`
40
+ - `readOnly?: boolean`
41
+ - `className?: string`
42
+ - `style?: StyleValue`
43
+
44
+ ## Emits
45
+
46
+ - `update:modelValue`
47
+ - `change`
48
+ - `ready`
49
+
50
+ ## Notes
51
+
52
+ - Wrap with `<ClientOnly>` to avoid SSR DOM constraints.
53
+ - Prop and event behavior mirrors `@lexion-rte/vue`.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lexion-rte/nuxt",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "Nuxt adapter for the Lexion editor.",
5
5
  "private": false,
6
6
  "type": "module",
@@ -15,12 +15,12 @@
15
15
  "license": "GPL-3.0-only",
16
16
  "repository": {
17
17
  "type": "git",
18
- "url": "https://github.com/lexion-rte/lexion.git",
18
+ "url": "https://github.com/dariusve/lexion.git",
19
19
  "directory": "packages/nuxt"
20
20
  },
21
- "homepage": "https://github.com/lexion-rte/lexion/tree/main/packages/nuxt",
21
+ "homepage": "https://github.com/dariusve/lexion/tree/main/packages/nuxt",
22
22
  "bugs": {
23
- "url": "https://github.com/lexion-rte/lexion/issues"
23
+ "url": "https://github.com/dariusve/lexion/issues"
24
24
  },
25
25
  "keywords": [
26
26
  "lexion",
@@ -38,8 +38,8 @@
38
38
  "vue": "^3.4.0"
39
39
  },
40
40
  "dependencies": {
41
- "@lexion-rte/core": "0.1.0",
42
- "@lexion-rte/vue": "0.1.0"
41
+ "@lexion-rte/core": "0.1.2",
42
+ "@lexion-rte/vue": "0.1.2"
43
43
  },
44
44
  "scripts": {
45
45
  "build": "tsc -p tsconfig.json",