@mittwald/flow-react-components 1.5.0-next.47 → 1.5.0-next.49

package/AGENTS.md

@@ -471,6 +471,43 @@ Checklist beyond the component itself:
   drops characters under fast typing
   ([docs/remote-ui.md](https://github.com/mittwald/flow/blob/main/docs/remote-ui.md)).
 
+## Every remote binding reads this package
+
+An extension can be written in React or in another framework, and each one has a
+binding of its own in this repository — `remote-react-components` as the
+reference, `remote-vue-components` as the second. Only part of what you change
+here reaches the others by itself.
+
+- **A `@flr-generate` component is free.** Props, events and slots are generated
+  for every binding — regenerate and commit, and each wrapper is current.
+- **A `flr-universal` composition is not.** `Modal`, `Popover`, `LightBox`,
+  `Action`, `List` and their triggers are React compositions over remote
+  elements, so every other binding rebuilds them by hand (Vue's are in
+  `packages/remote-vue-components/src/{components,overlays,list}`). While the
+  Vue binding is beta, bring its rebuild along where you can; where you cannot,
+  record the divergence with its reason in
+  `packages/remote-vue-components/e2e/react-parity/knownGaps.ts`. The `List` has
+  no such list: `e2e/list-parity` needs every scenario from every binding, so a
+  `List` change brings the Vue `List` along.
+- **Their class names and UI strings are a contract.** The rebuilds pass
+  `flow--modal`, `flow--list--…` to the host and carry their own copies of the
+  UI text they show (the `List`'s, `confirmOnClose`'s, the `LightBox` close
+  label), because neither is importable from a published entry point. A rename
+  fails lint (`flow/no-unknown-flow-class`), a rewording fails
+  `src/tests/CopiedTexts.test.ts` in the Vue package — update the binding's copy
+  in the same change.
+- **Behaviour that is not rendering belongs in
+  `@mittwald/flow-components-base`**, where every binding runs the same code —
+  that is where the `List`'s loader state, filters, sorting, search, view mode
+  and table live. Beware of writing React's lifecycle into it: a cache that a
+  per-render model refreshes for free is a permanent one for a binding that
+  keeps its model.
+
+The gate is `pnpm nx test:parity remote-vue-components`, which renders the
+visual corpus through React and Vue and compares the host's DOM, overlays
+included. It only sees what the corpus renders — a scenario is the cheapest way
+to make a rule stick.
+
 ## Public API surfaces
 
 | Export                                                          | Contents                                                                                                                                                                                                                                            |