@entifix/react-controls 0.1.0-0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +29 -3
  2. package/package.json +6 -5
package/README.md CHANGED
@@ -1,7 +1,33 @@
1
1
  # @entifix/react-controls
2
2
 
3
- This library was generated with [Nx](https://nx.dev).
3
+ The React UI. `EntityTable`, `EntityForm`, `FilterBuilder`, `SortBuilder`, `Wizard` and `CommandPalette` render from an entity's own metadata, so a column, a field or a filter operator comes from the `@entity()` class rather than from a prop list. Beside them sit the layout primitives (`Stack`, `Cluster`, `Sidebar`, `Switcher`, …) and the atoms they are built from.
4
4
 
5
- ## Running unit tests
5
+ Styling is Tailwind utilities over the token names in `@entifix/style`.
6
6
 
7
- Run `nx test @entifix/react-controls` to execute the unit tests via [Jest](https://jestjs.io).
7
+ ## Install
8
+
9
+ ```sh
10
+ pnpm add @entifix/react-controls effect react
11
+ ```
12
+
13
+ ## Entry points
14
+
15
+ | Import | What it holds |
16
+ | ------------------------------------ | ----------------------------------------------------------------------------------------- |
17
+ | `@entifix/react-controls` | Everything: entity organisms, layout primitives, atoms, theme and UI-preference providers |
18
+ | `@entifix/react-controls/primitives` | Layout primitives and atoms only — no entity metadata |
19
+ | `@entifix/react-controls/i18next` | `I18nProvider`, binding the controls to i18next |
20
+
21
+ ## Optional peers
22
+
23
+ Install these only if you use what needs them.
24
+
25
+ | Peer | Needed by |
26
+ | ------------------------------------------- | --------------------------------- |
27
+ | `i18next`, `react-i18next`, `@entifix/i18n` | `@entifix/react-controls/i18next` |
28
+
29
+ A table does not arrive with i18next attached: without the `i18next` subpath the controls translate through the `Translator` you provide.
30
+
31
+ ---
32
+
33
+ Tier 3 (ui) of entifix — a package depends only on its own tier or below. See [the tiers](https://github.com/r10c-technologies/entifix#the-tiers-and-what-you-are-allowed-to-install). MIT licensed.
package/package.json CHANGED
@@ -1,6 +1,7 @@
1
1
  {
2
2
  "name": "@entifix/react-controls",
3
- "version": "0.1.0-0",
3
+ "version": "0.1.1",
4
+ "description": "Entity-agnostic React UI — table, form, filters, wizard, command palette — rendered from entity metadata, plus layout primitives.",
4
5
  "license": "MIT",
5
6
  "repository": {
6
7
  "type": "git",
@@ -18,7 +19,7 @@
18
19
  "@headlessui/react": "^2.2.10",
19
20
  "class-variance-authority": "^0.7.1",
20
21
  "idb": "^8.0.3",
21
- "@entifix/core": "0.1.0-0"
22
+ "@entifix/core": "0.1.1"
22
23
  },
23
24
  "exports": {
24
25
  "./package.json": "./package.json",
@@ -55,8 +56,8 @@
55
56
  "react": "19.2.8",
56
57
  "react-i18next": "17.0.11",
57
58
  "storybook": "^10.5.3",
58
- "@entifix/style": "0.1.0-0",
59
- "@entifix/i18n": "0.1.0-0"
59
+ "@entifix/style": "0.1.1",
60
+ "@entifix/i18n": "0.1.1"
60
61
  },
61
62
  "nx": {
62
63
  "tags": [
@@ -102,7 +103,7 @@
102
103
  "i18next": ">=26 <27",
103
104
  "react": ">=19 <20",
104
105
  "react-i18next": ">=17 <18",
105
- "@entifix/i18n": "0.1.0-0"
106
+ "@entifix/i18n": "0.1.1"
106
107
  },
107
108
  "peerDependenciesMeta": {
108
109
  "@entifix/i18n": {