@texaryn/vue 0.1.0 → 0.1.1

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/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # @texaryn/vue
2
2
 
3
+ ## 0.1.1
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies [ffae9f1]
8
+ - @texaryn/core@0.4.0
9
+
3
10
  ## 0.1.0
4
11
 
5
12
  ### Minor Changes
package/README.md CHANGED
@@ -3,13 +3,22 @@
3
3
  Vue 3 bindings for Texaryn: composables, provide/inject context, a renderer
4
4
  and a small set of native widgets.
5
5
 
6
- A `0.0.0` placeholder exists on npm to reserve the name. The first usable
7
- release will be `0.1.0`.
6
+ > Status: pre-1.0. Public APIs may change before 1.0.
7
+
8
+ ## Install
9
+
10
+ ```bash
11
+ pnpm add @texaryn/core @texaryn/schema-json @texaryn/vue vue
12
+ ```
13
+
14
+ `@texaryn/vue` requires Vue 3.4 or newer.
15
+
16
+ ## Quick start
8
17
 
9
18
  ```vue
10
19
  <script setup lang="ts">
11
20
  import { createJsonSchemaAdapter } from '@texaryn/schema-json'
12
- import { useForm, provideFormRuntime, createDefaultRegistry } from '@texaryn/vue'
21
+ import { FormRoot, useForm, provideFormRuntime, createDefaultRegistry } from '@texaryn/vue'
13
22
 
14
23
  const schema = {
15
24
  $schema: 'https://json-schema.org/draft/2020-12/schema',
@@ -18,7 +27,7 @@ const schema = {
18
27
  required: ['name'],
19
28
  }
20
29
 
21
- const port = await createJsonSchemaAdapter(schema, {})
30
+ const port = await createJsonSchemaAdapter(schema)
22
31
  const form = useForm(port, { initialData: { name: '' } })
23
32
  provideFormRuntime(form.runtime)
24
33
 
@@ -89,3 +98,15 @@ The package ships plain TypeScript with render functions, so it builds with
89
98
  the same `tsc --build` as every other package in the workspace and needs no
90
99
  Vue-specific toolchain to compile. Consumers are free to use SFCs; nothing
91
100
  here requires them to.
101
+
102
+ ## Related packages
103
+
104
+ - [`@texaryn/core`](../core/README.md), runtime and renderer contracts
105
+ - [`@texaryn/schema-json`](../schema-json/README.md), JSON Schema adapter
106
+ - [`@texaryn/react`](../react/README.md), the React binding over the same runtime
107
+
108
+ See the [repository README](../../README.md) for the complete architecture.
109
+
110
+ ## License
111
+
112
+ Apache-2.0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@texaryn/vue",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Vue 3 bindings, composables, and default widgets for Texaryn",
5
5
  "keywords": [
6
6
  "vue",
@@ -44,7 +44,7 @@
44
44
  "CHANGELOG.md"
45
45
  ],
46
46
  "dependencies": {
47
- "@texaryn/core": "^0.3.0"
47
+ "@texaryn/core": "^0.4.0"
48
48
  },
49
49
  "peerDependencies": {
50
50
  "vue": ">=3.4.0"
@@ -53,8 +53,8 @@
53
53
  "@vue/test-utils": "^2.4.6",
54
54
  "jsdom": "^25.0.0",
55
55
  "vue": "^3.5.0",
56
- "@texaryn/examples": "0.0.0",
57
- "@texaryn/schema-json": "0.2.2"
56
+ "@texaryn/schema-json": "0.2.3",
57
+ "@texaryn/examples": "0.0.0"
58
58
  },
59
59
  "scripts": {
60
60
  "build": "tsc --build"