@vincentt-xr/sdk 2.0.0-alpha.11 → 2.0.0-alpha.12

package/GROUNDING.md

@@ -190,17 +190,22 @@ that is not on an exported component.
 
 ### Live preview of unsaved editor changes
 
-In the console's visual editor, an unsaved change to `color` on `<ScreenText>`
-or `<TextLabel>` shows in the running app at once. Its other changes show after
-Save, which rebuilds the app. The editor's build defines a small override store
-on the page, and those two components read it for `color`. Published and
+In the console's visual editor, an unsaved change to one of these settings
+shows in the running app at once: `<ScreenText>` colour, font size and screen
+placement; `<ScreenImage>` screen placement; `<ScreenShape>` screen placement
+and fill colour; `<TextLabel>` colour. Other changes show after Save, which
+rebuilds the app. The editor's build defines a small override store on the
+page, and those components read it for those settings. Published and
 preview builds have no store, so they render the props exactly as written.
 App code does nothing for this and must not define or read
 `__VCT_EDIT_OVERRIDES__`.
 
-SDK authors: to make another prop live, add its name to the component's
-`LIVE_EDITABLE` list (`lib/components/ScreenText/index.tsx`,
-`lib/components/TextLabel/TextLabel.tsx`). The hook is
+SDK authors: to make another prop live, add its key to the component's
+`LIVE_EDITABLE` list (in `ScreenText`, `ScreenImage`, `ScreenShape` and
+`TextLabel`). A key is the prop name or a dotted path into an object prop
+(`settings.fillColor`, `transform.position`), the same key as in
+`settings.json`. A dotted key replaces only that leaf, copying the objects
+around it, and is skipped when the parent object is not written. The hook is
 `useEditOverrides(props, keys)` in `lib/utils/useEditOverrides.ts`. Call it with
 the component's own props object, before destructuring.