@oxide/design-system 3.2.0--canary.151.18510956047.0 → 4.0.2--canary.135.18526331516.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 +19 -14
- package/package.json +3 -11
package/README.md
CHANGED
|
@@ -71,24 +71,33 @@ Subsequently, you can use it as follows:
|
|
|
71
71
|
|
|
72
72
|
This is type-checked, and will throw an error if the corresponding icon doesn't exist.
|
|
73
73
|
|
|
74
|
-
##
|
|
74
|
+
## Usage
|
|
75
75
|
|
|
76
|
-
This
|
|
77
|
-
[`@oxide/react-asciidoc`](https://github.com/oxidecomputer/react-asciidoc) components that
|
|
78
|
-
are reused across multiple internal sites such as docs.oxide.computer, oxide.computer, and
|
|
79
|
-
eventually the rfd.shared.oxide.computer (when its conversion to `react-asciidoc` is
|
|
80
|
-
complete). The associated stylesheet `asciidoc.css` is also included.
|
|
76
|
+
This package provides two main entry points:
|
|
81
77
|
|
|
82
|
-
|
|
78
|
+
### UI Components (`@oxide/design-system/ui`)
|
|
79
|
+
|
|
80
|
+
Basic UI components like Badge, Button, Checkbox, Listbox, Spinner, and Tabs. These are
|
|
81
|
+
lightweight components without dependencies on AsciiDoc processing.
|
|
83
82
|
|
|
84
83
|
```ts
|
|
85
|
-
import {
|
|
84
|
+
import { Button, Badge } from '@oxide/design-system/ui'
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### AsciiDoc Components (`@oxide/design-system/asciidoc`)
|
|
88
|
+
|
|
89
|
+
[`@oxide/react-asciidoc`](https://github.com/oxidecomputer/react-asciidoc) components for
|
|
90
|
+
rendering AsciiDoc content, reused across docs.oxide.computer, oxide.computer, and
|
|
91
|
+
rfd.shared.oxide.computer. The associated stylesheet `asciidoc.css` is also included.
|
|
92
|
+
|
|
93
|
+
```ts
|
|
94
|
+
import { AsciiDocBlocks } from '@oxide/design-system/asciidoc'
|
|
86
95
|
|
|
87
96
|
export const opts: Options = {
|
|
88
97
|
overrides: {
|
|
89
98
|
admonition: AsciiDocBlocks.Admonition,
|
|
90
99
|
table: AsciiDocBlocks.Table,
|
|
91
|
-
|
|
100
|
+
section: AsciiDocBlocks.Section,
|
|
92
101
|
},
|
|
93
102
|
}
|
|
94
103
|
```
|
|
@@ -97,11 +106,7 @@ export const opts: Options = {
|
|
|
97
106
|
<Asciidoc content={document} options={opts} />
|
|
98
107
|
```
|
|
99
108
|
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
The full UI library is housed within the web console repo. The components included in this
|
|
103
|
-
package are those reused across other Oxide sites. When using them, remember to also import
|
|
104
|
-
their associated stylesheets.
|
|
109
|
+
When using these components, remember to also import their associated stylesheets.
|
|
105
110
|
|
|
106
111
|
Be sure to add the components path to the `tailwind.config.js` to ensure the appropriate
|
|
107
112
|
styles are included. For example:
|
package/package.json
CHANGED
|
@@ -1,24 +1,16 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@oxide/design-system",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "4.0.2--canary.135.18526331516.0",
|
|
4
4
|
"description": "Home of reusable design assets and token for oxide internal sites",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"sideEffects": false,
|
|
7
|
-
"typings": "./dist/components/src/asciidoc/index.d.ts",
|
|
8
|
-
"module": "./dist/components/src/asciidoc/index.js",
|
|
9
7
|
"exports": {
|
|
10
8
|
"./styles/*": "./styles/dist/*",
|
|
11
9
|
"./components/*.css": "./dist/*.css",
|
|
12
10
|
"./asciidoc": "./dist/components/src/asciidoc/index.js",
|
|
13
11
|
"./ui": "./dist/components/src/ui/index.js",
|
|
14
12
|
"./icons": "./dist/icons/index.js",
|
|
15
|
-
"./icons/react": "./dist/icons/react/index.js"
|
|
16
|
-
".": {
|
|
17
|
-
"import": {
|
|
18
|
-
"types": "./dist/components/src/asciidoc/index.d.ts",
|
|
19
|
-
"default": "./dist/components/src/asciidoc/index.js"
|
|
20
|
-
}
|
|
21
|
-
}
|
|
13
|
+
"./icons/react": "./dist/icons/react/index.js"
|
|
22
14
|
},
|
|
23
15
|
"scripts": {
|
|
24
16
|
"export-icons": "npx zx ./scripts/export-icons.md && npm run fmt",
|
|
@@ -63,7 +55,7 @@
|
|
|
63
55
|
"token-transformer": "^0.0.33",
|
|
64
56
|
"tsup": "^8.5.0",
|
|
65
57
|
"tsx": "^4.20.5",
|
|
66
|
-
"typescript": "^5.9.
|
|
58
|
+
"typescript": "^5.9.3",
|
|
67
59
|
"vite-tsconfig-paths": "^5.1.4",
|
|
68
60
|
"vitest": "^3.2.4",
|
|
69
61
|
"zx": "^8.8.3"
|