@ceedcv-maya/shared-layout-react 0.2.0 → 0.3.0

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 +20 -0
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -26,6 +26,26 @@ This package expects the following sibling packages to be installed by the consu
26
26
  - `@ceedcv-maya/shared-auth-react`
27
27
  - `@ceedcv-maya/shared-ui-react`
28
28
 
29
+ ## Styling — required setup
30
+
31
+ This package uses Tailwind v4 utility classes and design tokens (`bg-odoo-purple`, `bg-ui-card`, `text-text-primary`, …) defined in [`@ceedcv-maya/shared-styles`](https://www.npmjs.com/package/@ceedcv-maya/shared-styles). Without it the components will render unstyled.
32
+
33
+ ```bash
34
+ npm install @ceedcv-maya/shared-styles
35
+ ```
36
+
37
+ ```css
38
+ /* src/index.css */
39
+ @import "tailwindcss";
40
+ @import "@ceedcv-maya/shared-styles";
41
+
42
+ /* Tailwind v4 must scan the package source so it generates the
43
+ utility classes used inside this library. */
44
+ @source "../node_modules/@ceedcv-maya/shared-layout-react/src/**/*.{ts,tsx}";
45
+ ```
46
+
47
+ If you also consume other `@ceedcv-maya/shared-*-react` packages, add an `@source` line for each of them.
48
+
29
49
  ## TypeScript / build notes
30
50
  This package ships TypeScript source (`src/index.ts` as entry). Consumers using Vite or Webpack with `ts-loader` work out of the box. Next.js consumers must add this package to `transpilePackages` in `next.config.js`.
31
51
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ceedcv-maya/shared-layout-react",
3
- "version": "0.2.0",
3
+ "version": "0.3.0",
4
4
  "type": "module",
5
5
  "main": "src/index.ts",
6
6
  "types": "src/index.ts",
@@ -9,8 +9,8 @@
9
9
  "react-dom": "^18.0.0 || ^19.0.0",
10
10
  "react-router-dom": "^6.0.0 || ^7.0.0",
11
11
  "react-i18next": "^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0",
12
- "@ceedcv-maya/shared-auth-react": "^0.2.0",
13
- "@ceedcv-maya/shared-ui-react": "^0.2.0"
12
+ "@ceedcv-maya/shared-auth-react": "^0.3.0",
13
+ "@ceedcv-maya/shared-ui-react": "^0.3.0"
14
14
  },
15
15
  "devDependencies": {
16
16
  "@types/react": "^19.0.0",