@accelint/design-system 0.3.2 → 0.3.3
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 +11 -7
- package/dist/chunk-4ZUGQMUD.js.map +1 -1
- package/dist/index.d.ts +21 -12
- package/dist/index.js +43 -26
- package/dist/index.js.map +1 -1
- package/dist/{vanilla-Ibcop5d3.d.ts → vanilla-oo0eN2ya.d.ts} +4 -3
- package/dist/vanilla.d.ts +5 -4
- package/package.json +29 -22
package/README.md
CHANGED
|
@@ -12,13 +12,13 @@ This design system, which we've designated C2DS for simplicity, was born of thre
|
|
|
12
12
|
|
|
13
13
|
From an engineering perspective, we also want to future-proof our investment by switching to an approach more natively compatible with React Server Components. This is the future of React and getting out ahead of that transition is valuable before it becomes a significant pain point inhibiting rapid feature development.
|
|
14
14
|
|
|
15
|
-
Developed by the Core team, C2DS is a shared platform that all engineers can -- and are encouraged -- to contribute to.
|
|
15
|
+
Developed by the Core team at Accelint, C2DS is a shared platform that all engineers can -- and are encouraged -- to contribute to. This system is published as open source to invite collaboration across our partners and the engineering community in general.
|
|
16
16
|
|
|
17
17
|
### Performance
|
|
18
18
|
|
|
19
19
|
The runtime performance of our applications is an enduring central concern. Our applications place a high performance demand on the browser client, primarily due to the sheer data throughput and intensive rendering requirements. Therefore, it makes sense to move away from a runtime CSS-in-JS solution in favor of a build/compile time styling solution.
|
|
20
20
|
|
|
21
|
-
[Advantages >](./documentation/concepts.md#build
|
|
21
|
+
[Advantages >](./documentation/concepts.md#build-and-runtime)
|
|
22
22
|
|
|
23
23
|
### Flexibility and control
|
|
24
24
|
|
|
@@ -44,20 +44,24 @@ This design system is built on a number of concepts with which you may not be fa
|
|
|
44
44
|
|
|
45
45
|
## Getting started
|
|
46
46
|
|
|
47
|
-
Check out what exists:
|
|
47
|
+
Check out what exists. You can review the components, tokens and primitives available in the system using the Ladle stories for each element: [C2DS Stories](https://gohypergiant.github.io/standard-toolkit).
|
|
48
|
+
|
|
49
|
+
From the root of the standard toolkit project, run:
|
|
48
50
|
|
|
49
51
|
```bash
|
|
50
|
-
|
|
52
|
+
pnpm i
|
|
51
53
|
|
|
52
|
-
|
|
54
|
+
pnpm --filter=@accelint/design-system preview
|
|
53
55
|
```
|
|
54
56
|
|
|
57
|
+
If you run into errors, try running
|
|
58
|
+
`pnpm build` after you install the dependencies and then run the preview command again. If you don't have pnpm enabled then you can enable it with the command
|
|
59
|
+
[`corepack enable pnpm`](https://pnpm.io/installation#using-corepack) .
|
|
60
|
+
|
|
55
61
|
### Implementation
|
|
56
62
|
|
|
57
63
|
[Learn](./documentation/implementation.md) how to get your app up and running.
|
|
58
64
|
|
|
59
|
-
<!-- TODO - documentation around build systems -->
|
|
60
|
-
|
|
61
65
|
### Contribution
|
|
62
66
|
|
|
63
67
|
[Learn](./documentation/contribution.md) how to craft components for this design system.
|