@texaryn/vue 0.4.1 → 0.4.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @texaryn/vue
 
+## 0.4.2
+
+### Patch Changes
+
+- 609ad71: The README quick start creates the adapter in `main.ts` and passes it to `App`
+  as a prop, so the example renders as the root component without a `<Suspense>`
+  boundary. No code changes.
+
 ## 0.4.1
 
 ### Patch Changes

package/README.md

@@ -15,20 +15,42 @@ pnpm add @texaryn/core @texaryn/schema-json @texaryn/vue vue
 
 ## Quick start
 
-```vue
-<script setup lang="ts">
-import { createJsonSchemaAdapter } from '@texaryn/schema-json'
-import { ErrorSummary, FormRoot, useForm, provideFormRuntime, createDefaultRegistry } from '@texaryn/vue'
-
-const schema = {
+`main.ts` creates the adapter before mounting and passes it to `App` as a prop,
+because awaiting `createJsonSchemaAdapter` inside `<script setup>` would make
+`App` an async component, which renders nothing as the root without a
+`<Suspense>` boundary.
+
+```ts
+// schema.ts
+export const schema = {
   $schema: 'https://json-schema.org/draft/2020-12/schema',
   type: 'object',
   properties: { name: { type: 'string', title: 'Name' } },
   required: ['name'],
 }
+```
+
+```ts
+// main.ts
+import { createApp } from 'vue'
+import { createJsonSchemaAdapter } from '@texaryn/schema-json'
+import App from './App.vue'
+import { schema } from './schema'
+
+const adapter = await createJsonSchemaAdapter(schema)
+
+createApp(App, { adapter }).mount('#app')
+```
+
+```vue
+<!-- App.vue -->
+<script setup lang="ts">
+import type { SchemaEvaluationPort } from '@texaryn/core'
+import { ErrorSummary, FormRoot, createDefaultRegistry, provideFormRuntime, useForm } from '@texaryn/vue'
+
+const props = defineProps<{ adapter: SchemaEvaluationPort }>()
 
-const port = await createJsonSchemaAdapter(schema)
-const form = useForm(port, { initialData: { name: '' } })
+const form = useForm(props.adapter, { initialData: { name: '' } })
 provideFormRuntime(form.runtime)
 
 const registry = createDefaultRegistry()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@texaryn/vue",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "Vue 3 bindings, composables, and default widgets for Texaryn",
   "keywords": [
     "vue",
@@ -55,7 +55,7 @@
     "jsdom": "^25.0.0",
     "vue": "^3.5.0",
     "@texaryn/examples": "0.0.0",
-    "@texaryn/schema-json": "0.6.2"
+    "@texaryn/schema-json": "0.6.3"
   },
   "scripts": {
     "build": "tsc --build"