@gxp-dev/mod-ui 2.0.4 → 2.0.8

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 (8) hide show
  1. package/README.md +29 -9
  2. package/dist/index.d.ts +0 -25
  3. package/dist/index.d.ts.map +1 -1
  4. package/dist/index.js +481 -480
  5. package/dist/index.js.map +1 -1
  6. package/dist/styles/mod-ui.css +1 -1
  7. package/package.json +2 -2
  8. package/src/index.ts +3 -0
package/README.md CHANGED
@@ -116,26 +116,46 @@ managers (pnpm 9+, npm 7+, yarn 3+) auto-install them, so the single
116
116
  command above is usually enough. If your manager warns about
117
117
  unresolved peers, add them explicitly: `pnpm add vue pinia reka-ui`.
118
118
 
119
- ## Themes
119
+ ## Styles
120
120
 
121
- ```html
122
- <!-- Activate dark mode anywhere in the tree. -->
123
- <body class="dark">
121
+ Import the library's stylesheet once in your app entry (e.g. `main.ts` or `app.js`):
122
+
123
+ ```ts
124
+ import "@gxp-dev/mod-ui/styles"
125
+ ```
126
+
127
+ This loads the Tailwind theme — CSS custom properties for color, radius, shadow, etc. Without it every component will be unstyled.
128
+
129
+ ### Themes
130
+
131
+ The library ships three built-in themes:
132
+
133
+ | File | Class | Description |
134
+ | --- | --- | --- |
135
+ | (default, included in `styles`) | — | Light theme |
136
+ | `@gxp-dev/mod-ui/styles/themes/dark.css` | `.dark` | Dark theme |
137
+ | `@gxp-dev/mod-ui/styles/themes/kiosk.css` | `.kiosk` | High-contrast kiosk theme |
138
+
139
+ To use dark or kiosk mode, import the extra stylesheet and add the class to a parent element:
140
+
141
+ ```ts
142
+ import "@gxp-dev/mod-ui/styles"
143
+ import "@gxp-dev/mod-ui/styles/themes/dark.css"
144
+ ```
124
145
 
125
- <!-- Activate the kiosk theme. -->
126
- <body class="kiosk">
146
+ ```html
147
+ <body class="dark">...</body>
127
148
  ```
128
149
 
150
+ To override individual design tokens:
151
+
129
152
  ```css
130
- /* Override individual tokens. */
131
153
  :root {
132
154
  --primary: oklch(0.5 0.2 270);
133
155
  --radius: 1rem;
134
156
  }
135
157
  ```
136
158
 
137
- Default, dark, and kiosk themes ship in `dist/styles/themes/`.
138
-
139
159
  ## Develop
140
160
 
141
161
  ```bash
package/dist/index.d.ts CHANGED
@@ -1,28 +1,3 @@
1
- /**
2
- * @gxp-dev/mod-ui — public entry point.
3
- *
4
- * Layered exports:
5
- *
6
- * - `definitions/` TypeScript schema (types, defaults, metadata,
7
- * EditConfig) for every element and card.
8
- * - `components/ui/` shadcn-vue primitives built on reka-ui.
9
- * - `engine/` Runtime renderers, loaders, condition evaluator,
10
- * form-data binding.
11
- * - `pages/` IndexPage / ShowPage — top-level JSON consumers.
12
- * - `adapters/` v1 ↔ v2 schema translation. ShowPage / IndexPage
13
- * apply this automatically.
14
- * - `stores/` Pinia stores (form data + form builder state).
15
- * - `lib/` cn(), assertNever(), hasKey().
16
- *
17
- * Per-cardType DisplayCard components and per-(type, style) element
18
- * renderers under `cards/` and `elements/` are NOT re-exported here —
19
- * the engine resolves them dynamically via `import.meta.glob`, which
20
- * is how consumers consume them. Direct sub-path imports work for
21
- * advanced cases:
22
- *
23
- * import Button from "@gxp-dev/mod-ui/components/ui/button"
24
- * import TextInput from "@gxp-dev/mod-ui/elements/input/TextInput.vue"
25
- */
26
1
  export * from './definitions';
27
2
  export * from './components/ui';
28
3
  export { CardRenderer, ElementRenderer, FORM_ID_KEY, cardRegistry, elementDefaultStyle, elementRegistry, getCardComponent, getElementComponent, preloadCard, preloadElement, provideFormId, resolveCardPath, resolveElementPath, shouldRender, useFormData, type CardPath, type ElementPath, type ElementRegistry, type EvaluationContext, type UseFormDataBindings, } from './engine';
package/dist/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAGH,cAAc,eAAe,CAAA;AAG7B,cAAc,iBAAiB,CAAA;AAG/B,OAAO,EACL,YAAY,EACZ,eAAe,EACf,WAAW,EACX,YAAY,EACZ,mBAAmB,EACnB,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,WAAW,EACX,cAAc,EACd,aAAa,EACb,eAAe,EACf,kBAAkB,EAClB,YAAY,EACZ,WAAW,EACX,KAAK,QAAQ,EACb,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,GACzB,MAAM,UAAU,CAAA;AAGjB,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAC5D,YAAY,EACV,UAAU,IAAI,mBAAmB,EACjC,eAAe,EACf,cAAc,GACf,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,EACL,uBAAuB,EACvB,KAAK,UAAU,IAAI,kBAAkB,EACrC,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,SAAS,GACf,MAAM,sBAAsB,CAAA;AAG7B,OAAO,EAAE,gBAAgB,EAAE,KAAK,SAAS,EAAE,MAAM,wBAAwB,CAAA;AACzE,OAAO,EACL,mBAAmB,EACnB,cAAc,EACd,2BAA2B,EAC3B,KAAK,aAAa,EAClB,KAAK,gBAAgB,GACtB,MAAM,2BAA2B,CAAA;AAClC,OAAO,EACL,qBAAqB,EACrB,gBAAgB,EAChB,6BAA6B,EAC7B,mBAAmB,EACnB,cAAc,EACd,QAAQ,EACR,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,GAC5B,MAAM,6BAA6B,CAAA;AACpC,OAAO,EACL,0BAA0B,EAC1B,qBAAqB,EACrB,kCAAkC,EAClC,KAAK,wBAAwB,EAC7B,KAAK,2BAA2B,GACjC,MAAM,kCAAkC,CAAA;AACzC,OAAO,EACL,mBAAmB,EACnB,cAAc,EACd,2BAA2B,EAC3B,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,GAC1B,MAAM,2BAA2B,CAAA;AAClC,OAAO,EACL,mBAAmB,EACnB,cAAc,EACd,2BAA2B,EAC3B,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,gBAAgB,GACtB,MAAM,2BAA2B,CAAA;AAClC,OAAO,EACL,qBAAqB,EACrB,gBAAgB,EAChB,6BAA6B,EAC7B,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,GACxB,MAAM,6BAA6B,CAAA;AACpC,OAAO,EACL,6BAA6B,EAC7B,wBAAwB,EACxB,qCAAqC,EACrC,qBAAqB,EACrB,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,2BAA2B,EAChC,KAAK,8BAA8B,EACnC,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,sBAAsB,GAC5B,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EACL,6BAA6B,EAC7B,wBAAwB,EACxB,qCAAqC,EACrC,2BAA2B,EAC3B,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,2BAA2B,EAChC,KAAK,8BAA8B,GACpC,MAAM,qCAAqC,CAAA;AAG5C,OAAO,EACL,MAAM,EACN,MAAM,EACN,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,aAAa,EACb,aAAa,EACb,eAAe,EACf,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAClB,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,eAAe,GACrB,MAAM,YAAY,CAAA;AAGnB,OAAO,EAAE,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAGH,OAAO,uBAAuB,CAAA;AAG9B,cAAc,eAAe,CAAA;AAG7B,cAAc,iBAAiB,CAAA;AAG/B,OAAO,EACL,YAAY,EACZ,eAAe,EACf,WAAW,EACX,YAAY,EACZ,mBAAmB,EACnB,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,WAAW,EACX,cAAc,EACd,aAAa,EACb,eAAe,EACf,kBAAkB,EAClB,YAAY,EACZ,WAAW,EACX,KAAK,QAAQ,EACb,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,GACzB,MAAM,UAAU,CAAA;AAGjB,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAC5D,YAAY,EACV,UAAU,IAAI,mBAAmB,EACjC,eAAe,EACf,cAAc,GACf,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,EACL,uBAAuB,EACvB,KAAK,UAAU,IAAI,kBAAkB,EACrC,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,SAAS,GACf,MAAM,sBAAsB,CAAA;AAG7B,OAAO,EAAE,gBAAgB,EAAE,KAAK,SAAS,EAAE,MAAM,wBAAwB,CAAA;AACzE,OAAO,EACL,mBAAmB,EACnB,cAAc,EACd,2BAA2B,EAC3B,KAAK,aAAa,EAClB,KAAK,gBAAgB,GACtB,MAAM,2BAA2B,CAAA;AAClC,OAAO,EACL,qBAAqB,EACrB,gBAAgB,EAChB,6BAA6B,EAC7B,mBAAmB,EACnB,cAAc,EACd,QAAQ,EACR,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,GAC5B,MAAM,6BAA6B,CAAA;AACpC,OAAO,EACL,0BAA0B,EAC1B,qBAAqB,EACrB,kCAAkC,EAClC,KAAK,wBAAwB,EAC7B,KAAK,2BAA2B,GACjC,MAAM,kCAAkC,CAAA;AACzC,OAAO,EACL,mBAAmB,EACnB,cAAc,EACd,2BAA2B,EAC3B,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,GAC1B,MAAM,2BAA2B,CAAA;AAClC,OAAO,EACL,mBAAmB,EACnB,cAAc,EACd,2BAA2B,EAC3B,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,gBAAgB,GACtB,MAAM,2BAA2B,CAAA;AAClC,OAAO,EACL,qBAAqB,EACrB,gBAAgB,EAChB,6BAA6B,EAC7B,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,GACxB,MAAM,6BAA6B,CAAA;AACpC,OAAO,EACL,6BAA6B,EAC7B,wBAAwB,EACxB,qCAAqC,EACrC,qBAAqB,EACrB,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,2BAA2B,EAChC,KAAK,8BAA8B,EACnC,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,sBAAsB,GAC5B,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EACL,6BAA6B,EAC7B,wBAAwB,EACxB,qCAAqC,EACrC,2BAA2B,EAC3B,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,2BAA2B,EAChC,KAAK,8BAA8B,GACpC,MAAM,qCAAqC,CAAA;AAG5C,OAAO,EACL,MAAM,EACN,MAAM,EACN,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,aAAa,EACb,aAAa,EACb,eAAe,EACf,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAClB,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,eAAe,GACrB,MAAM,YAAY,CAAA;AAGnB,OAAO,EAAE,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA"}