@povio/ui 5.0.0-rc.11 → 5.0.0-rc.13

package/src/configurator/README.md

@@ -74,4 +74,21 @@ The configurator window can be moved using the six-dot grip beside the preview s
 
 The pop-out control opens a separate browser window with `window.open`. It shares the provider state with the host application, so edits remain live in both windows. Docking or closing the pop-out returns the editor to the page and preserves the draft; Apply and Cancel close the pop-out. A blocked popup leaves the in-page editor open with retry guidance. The popup remembers its own size and screen position for the next pop-out; placement remains subject to browser window rules. The popup uses its browser window for resizing and switches to the compact Live preview tab below 800px.
 
-Minimize turns the configurator into a movable **Povio UI** floating launcher without discarding its draft. Click the launcher to restore the previous window mode, size and position; drag it or use the arrow keys to move it. A minimized pop-out reopens as a separate browser window. After Apply or Cancel, the launcher remains available to start a new editing session. Geometry is remembered for the mounted session, not across page reloads.
+Drag the pill on the window's top edge (or the header) to move it; focus the pill and use the arrow keys to move it by keyboard. The close button (×) closes the configurator and keeps the live edits. Window geometry is remembered for the mounted session, not across page reloads.
+
+### Theme versions
+
+The menu in the configurator's title row switches between named theme versions; **+** creates a copy of the selected version and the pencil renames or deletes it. Every edit is recorded in the selected version. With the `uiConfigurator` Vite plugin, versions save automatically to `povio.themes.json` in the app's Vite root (configure with `themeVersionsFile`, or disable with `themeVersionsFile: false`); without it, they stay in browser storage. No Git commands run.
+
+**Apply theme** in the footer makes the repository match the selected version. Theme tokens go to the app's theme CSS (`themeFile`); component settings and variant overrides go to `ui-configuration.json` beside it (`configurationFile`, or `false` to disable). Only the files that differ are written, and the button is enabled only while one does. Theme versions keep full token values, so applying one never changes another's theme; component settings are stored as edits, so a version that leaves a setting alone follows the applied one.
+
+Load the component settings in the app's root, layered over its code-level overrides:
+
+```tsx
+import { resolveUIConfiguration } from "@povio/ui/ui-configurator";
+import uiConfigurationFile from "@/styles/ui-configuration.json";
+
+const uiConfiguration = resolveUIConfiguration(uiConfigurationFile, uiOverrides);
+// <UIConfig.Provider config={uiConfiguration.config}>
+//   <UIOverrides.Provider config={uiConfiguration.overrides}>…
+```