@pathscale/ui 1.6.0 → 2.0.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.
- package/README.md +37 -4
- package/dist/layouts.manifest.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,22 +11,44 @@ dark themes built in.
|
|
|
11
11
|
## Install
|
|
12
12
|
|
|
13
13
|
```sh
|
|
14
|
-
bun add @pathscale/ui
|
|
14
|
+
bun add @pathscale/ui solid-layouts
|
|
15
|
+
bun add -d rsbuild-plugin-solid-layouts
|
|
15
16
|
```
|
|
16
17
|
|
|
17
18
|
<details>
|
|
18
19
|
<summary>npm · pnpm · yarn</summary>
|
|
19
20
|
|
|
20
21
|
```sh
|
|
21
|
-
npm install @pathscale/ui
|
|
22
|
-
pnpm add @pathscale/ui
|
|
23
|
-
yarn add @pathscale/ui
|
|
22
|
+
npm install @pathscale/ui solid-layouts && npm install -D rsbuild-plugin-solid-layouts
|
|
23
|
+
pnpm add @pathscale/ui solid-layouts && pnpm add -D rsbuild-plugin-solid-layouts
|
|
24
|
+
yarn add @pathscale/ui solid-layouts && yarn add -D rsbuild-plugin-solid-layouts
|
|
24
25
|
```
|
|
25
26
|
|
|
26
27
|
</details>
|
|
27
28
|
|
|
28
29
|
## Setup
|
|
29
30
|
|
|
31
|
+
`@pathscale/ui` 2.x is a compiled Layout bundle. Configure the application compiler before
|
|
32
|
+
Solid transforms JSX:
|
|
33
|
+
|
|
34
|
+
```ts
|
|
35
|
+
import { pluginBabel } from "@rsbuild/plugin-babel";
|
|
36
|
+
import { pluginSolid } from "@rsbuild/plugin-solid";
|
|
37
|
+
import { defineConfig } from "@rsbuild/core";
|
|
38
|
+
import { pluginSolidLayoutsApplication } from "rsbuild-plugin-solid-layouts";
|
|
39
|
+
|
|
40
|
+
export default defineConfig({
|
|
41
|
+
plugins: [
|
|
42
|
+
pluginSolidLayoutsApplication({ layouts: ["@pathscale/ui"] }),
|
|
43
|
+
pluginBabel({ include: /\.(?:jsx|tsx|ts)$/ }),
|
|
44
|
+
pluginSolid(),
|
|
45
|
+
],
|
|
46
|
+
});
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
The Layout plugin must run before Solid. A missing package, manifest, recipe, compiler, or
|
|
50
|
+
runtime is an error; there is no uncompiled fallback.
|
|
51
|
+
|
|
30
52
|
Two imports. Everything comes from the root barrel, and **one stylesheet is all you need** —
|
|
31
53
|
`index.css` pulls in the base styles, both themes and the icon set:
|
|
32
54
|
|
|
@@ -102,8 +124,19 @@ from hooks. Both, with toasts, icons and dates, are covered in
|
|
|
102
124
|
## Requirements
|
|
103
125
|
|
|
104
126
|
- **SolidJS ^1.9**
|
|
127
|
+
- **solid-layouts** runtime
|
|
128
|
+
- **rsbuild-plugin-solid-layouts** application compiler integration
|
|
105
129
|
- **Tailwind v4** — optional, but required for the `@theme` token utilities
|
|
106
130
|
|
|
131
|
+
## Migrating from 1.x
|
|
132
|
+
|
|
133
|
+
`1.4.0` is the last pre-Layouts 1.x release. Layout-authored components begin at `2.0.0` and
|
|
134
|
+
require the setup above. Versions `1.5.0` and `1.6.0` were incorrectly published on the 1.x
|
|
135
|
+
line and must not be used.
|
|
136
|
+
|
|
137
|
+
The complete compiler contract, hard-error behavior, commands, and porting analyzer are
|
|
138
|
+
documented in [docs/layouts.md](docs/layouts.md).
|
|
139
|
+
|
|
107
140
|
Peers include `@solid-primitives/*`, `@tanstack/solid-form` and `@tanstack/solid-table`.
|
|
108
141
|
Two are optional and only needed for the features they back: `popmotion` (JS animation
|
|
109
142
|
driver) and `@standard-schema/spec` (schema validation).
|