quilt-react 0.2.0 → 0.2.2

package/README.md

@@ -5,10 +5,18 @@ React components and hooks over the shared Quilt engine and DOM renderer. React
 ## Install
 
 ```sh
-npm install quilt-react react react-dom
+npm install quilt-react
 ```
 
-Core and DOM are installed automatically. TypeScript apps also need matching `@types/react` and `@types/react-dom`. Use an ESM-capable bundler with CSS imports. For local archives, see [packaging instructions](https://github.com/niko-dellic/quilt/blob/main/docs/packaging.md).
+`quilt-core` and `quilt-vanilla` are installed automatically.
+
+Requires React and React DOM 18.3 or 19. They are peer dependencies so Quilt shares
+your application’s React instance. In an existing React application, no additional
+install command is needed. When creating a new application, configure React and
+React DOM as application dependencies; npm 7 and newer also resolve missing peers
+automatically unless peer installation is disabled.
+
+TypeScript apps also need matching `@types/react` and `@types/react-dom`. Use an ESM-capable bundler with CSS imports. For local archives, see [packaging instructions](https://github.com/niko-dellic/quilt/blob/main/docs/packaging.md).
 
 ## Use
 
@@ -27,8 +35,7 @@ const store = new LayoutStore(
 );
 const data = { text: 'Hello' };
 const getPaneState = () => data;
-function Notes({ state }: PaneProps) {
-  const model = state as typeof data;
+function Notes({ state: model }: PaneProps<typeof data>) {
   return (
     <textarea
       defaultValue={model.text}
@@ -41,7 +48,7 @@ function Notes({ state }: PaneProps) {
 const components = { notes: Notes };
 const root = createRoot(document.getElementById('app')!);
 root.render(
-  <Layout
+  <Layout<typeof data>
     store={store}
     components={components}
     getPaneState={getPaneState}
@@ -58,6 +65,6 @@ function disposeWorkspace() {
 
 Keep the store stable. Component maps and adapter callbacks can change identity without rebuilding the workspace. Declarative panes inherit application providers through portals. `useLayoutSnapshot(store)` observes layout changes. The model type is `LayoutSnapshot`; `Layout` is the component. `MountedLayout`, `TabRegistry`, theme presets, and DOM configuration types are available here too. Attach a `MountedLayout` ref to call `popout` from a user gesture; before mounting completes, popout/requestClose resolve false; workspace configuration methods throw a clear not-mounted error.
 
-Declarative panes inherit your app's context providers. Only standalone `reactRenderer` creates separate roots requiring explicit provider wrappers. React-local state does not survive crossing documents: retain data in an application-owned store, and subscribe inside each view when live synchronization is needed. Companion windows are same-origin and depend on the main session.
+Only standalone `reactRenderer` creates separate roots requiring explicit provider wrappers. React-local state does not survive crossing documents: retain data in an application-owned store, and subscribe inside each view when live synchronization is needed. Companion windows are same-origin and depend on the main session.
 
 The stylesheet is identical to `quilt-vanilla/styles.css`; import either once. See [API](https://github.com/niko-dellic/quilt/blob/main/docs/api.md), [lifecycle](https://github.com/niko-dellic/quilt/blob/main/docs/lifecycle.md), and [migration](https://github.com/niko-dellic/quilt/blob/main/docs/migration.md).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quilt-react",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "React split panes and tabs with shared DOM chrome and browser window popouts",
   "type": "module",
   "license": "MIT",
@@ -30,8 +30,8 @@
     "prepack": "node ../../scripts/build-package.mjs react --dependencies"
   },
   "dependencies": {
-    "quilt-core": "0.2.0",
-    "quilt-vanilla": "0.2.0"
+    "quilt-core": "0.2.2",
+    "quilt-vanilla": "0.2.2"
   },
   "sideEffects": [
     "**/*.css"