@cratis/components.mui 4.13.1 → 4.14.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 +12 -7
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -8,10 +8,9 @@ The package shares the Components repository release version while the renderer
8
8
  versioned separately. It exports one stable `CratisPresentationUiLibrary` manifest, `muiUiLibrary`. This certifies nine-slot primitive
9
9
  adaptation, never full-catalog replacement.
10
10
 
11
- > **Publication status:** The install example targets the owner-authorized 4.0.0 npm release. When
12
- > reading this README from repository source before that release, verify availability with
13
- > `npm view @cratis/components.mui@4.0.0 version`; source contributors use the workspace in this
14
- > checkout.
11
+ > **Versions:** each release of `@cratis/components.mui` is published at the same version as
12
+ > `@cratis/components` and declares a peer on exactly that version. Install and upgrade the two
13
+ > packages together at the same version.
15
14
 
16
15
  ## Install
17
16
 
@@ -35,6 +34,9 @@ export const Application = () => (
35
34
  );
36
35
  ```
37
36
 
37
+ Components that execute commands or run queries also need Arc's `<Arc>` provider from
38
+ `@cratis/arc.react` around this tree; neither the adapter nor `CratisComponentsProvider` replaces it.
39
+
38
40
  The adapter covers Button, IconButton, TextInput, TextArea, Checkbox, Radio, Switch,
39
41
  ProgressBar, and Surface. It deliberately excludes MUI X and does not implement the five atomic
40
42
  interaction slots.
@@ -46,7 +48,8 @@ An outer non-variable theme is converted to an equivalent CSS-variable theme so
46
48
  other values remain in force. Without an outer provider, MUI's default theme becomes a sane
47
49
  CSS-variable-enabled theme. The conversion is memoized and deterministic during server rendering.
48
50
 
49
- Put application customization outside `CratisComponentsProvider`:
51
+ Put application customization in an MUI `ThemeProvider` (from `@mui/material/styles`) outside
52
+ `CratisComponentsProvider`. In this excerpt, `applicationTheme` is the application's `createTheme` result:
50
53
 
51
54
  ```tsx
52
55
  <ThemeProvider theme={applicationTheme}>
@@ -71,8 +74,10 @@ MUI Core is bounded to `>=9 <10`, `@emotion/react` to `>=11.5 <12`,
71
74
  The repository's packed-consumer matrix proves both these effective lower boundaries and the
72
75
  current-highest compatible boundary; exact current versions remain dev dependencies only.
73
76
 
74
- The adapter requires `@cratis/components >=4 <5`. This range is intentionally bounded to the
75
- Components major whose renderer ABI and stable presentation profile it implements.
77
+ The source manifest declares `@cratis/components >=4 <5`, the Components major whose renderer ABI
78
+ and stable presentation profile the adapter implements. The release step replaces that range with
79
+ the exact release version, so a published adapter requires the `@cratis/components` release it
80
+ shipped with.
76
81
 
77
82
  See [CONFORMANCE.md](./CONFORMANCE.md) for the bounded evidence and
78
83
  [THIRD_PARTY_NOTICES.md](./THIRD_PARTY_NOTICES.md) for upstream licenses.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cratis/components.mui",
3
- "version": "4.13.1",
3
+ "version": "4.14.1",
4
4
  "description": "Material UI presentation adapter for Cratis Components renderer ABI v1.",
5
5
  "author": "Cratis",
6
6
  "license": "MIT",
@@ -98,7 +98,7 @@
98
98
  "ci": "yarn clean && yarn lint && yarn build && yarn typecheck-specs && yarn test && yarn verify-package"
99
99
  },
100
100
  "peerDependencies": {
101
- "@cratis/components": "4.13.1",
101
+ "@cratis/components": "4.14.1",
102
102
  "@emotion/react": ">=11.5 <12",
103
103
  "@emotion/styled": ">=11.11 <12",
104
104
  "@mui/material": ">=9 <10",
@@ -108,8 +108,8 @@
108
108
  "devDependencies": {
109
109
  "@cratis/arc": "22.16.0",
110
110
  "@cratis/arc.react": "22.16.0",
111
- "@cratis/components": "4.13.1",
112
- "@cratis/components.conformance": "4.13.1",
111
+ "@cratis/components": "4.14.1",
112
+ "@cratis/components.conformance": "4.14.1",
113
113
  "@cratis/fundamentals": "7.19.2",
114
114
  "@emotion/react": "11.14.0",
115
115
  "@emotion/styled": "11.14.1",