@bcgov/design-system-react-components 0.0.10-rc2 → 0.0.10
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 +28 -10
- package/package.json +10 -10
package/README.md
CHANGED
|
@@ -2,11 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
|
|
4
4
|
|
|
5
|
-
This package contains a library of React components built using [React Aria Components](https://react-spectrum.adobe.com/react-aria/
|
|
5
|
+
This package contains a library of React components built using [React Aria Components](https://react-spectrum.adobe.com/react-aria/components.html) to implement the [B.C. Design System](https://gov.bc.ca/designsystem).
|
|
6
6
|
|
|
7
7
|
Questions? Please email the <a href="mailto:DesignSystem@gov.bc.ca">GDX OSS Design Team</a>.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Storybook: https://designsystem.gov.bc.ca/react-components/
|
|
10
|
+
|
|
11
|
+
GitHub Repository: https://github.com/bcgov/design-system
|
|
10
12
|
|
|
11
13
|
To use, install this package and import the components into your application.
|
|
12
14
|
|
|
@@ -66,14 +68,16 @@ export default function App() {
|
|
|
66
68
|
|
|
67
69
|
## Component list
|
|
68
70
|
|
|
69
|
-
| Component | React Aria Components docs link
|
|
70
|
-
| ----------------------- |
|
|
71
|
-
| Button | https://react-spectrum.adobe.com/react-aria/Button.html
|
|
72
|
-
| Footer | N/A
|
|
73
|
-
|
|
|
74
|
-
|
|
|
75
|
-
|
|
|
76
|
-
|
|
|
71
|
+
| Component | React Aria Components docs link |
|
|
72
|
+
| ----------------------- | ---------------------------------------------------------- |
|
|
73
|
+
| Button | https://react-spectrum.adobe.com/react-aria/Button.html |
|
|
74
|
+
| Footer | N/A |
|
|
75
|
+
| Form | https://react-spectrum.adobe.com/react-aria/Form.html |
|
|
76
|
+
| Header | N/A |
|
|
77
|
+
| Select | https://react-spectrum.adobe.com/react-aria/Select.html |
|
|
78
|
+
| TagGroup, TagList, Tag | https://react-spectrum.adobe.com/react-aria/TagGroup.html |
|
|
79
|
+
| TextArea, TextField | https://react-spectrum.adobe.com/react-aria/TextField.html |
|
|
80
|
+
| Tooltip, TooltipTrigger | https://react-spectrum.adobe.com/react-aria/Tooltip.html |
|
|
77
81
|
|
|
78
82
|
## Supported React versions
|
|
79
83
|
|
|
@@ -107,6 +111,18 @@ Storybook stories live in `./src/stories`.
|
|
|
107
111
|
|
|
108
112
|
Run `npm run storybook-dev` to access the Storybook instance for the component library.
|
|
109
113
|
|
|
114
|
+
New versions of Storybook are automatically built in a GitHub Actions workflow and deployed in the `-dev` namespace in the OpenShift Silver cluster. See `.github/build_react_component_library_apps.yaml`.
|
|
115
|
+
|
|
116
|
+
To deploy a new version of Storybook into `-test` or `-prod`, log in to the OpenShift CLI and run:
|
|
117
|
+
|
|
118
|
+
```sh
|
|
119
|
+
# Create a new layer in the `test` ImageStream from the latest `develop` image:
|
|
120
|
+
oc tag ed91fb-tools/design-system-react-components-storybook:develop ed91fb-tools/design-system-react-components-storybook:test
|
|
121
|
+
|
|
122
|
+
# `develop` to `production`
|
|
123
|
+
oc tag ed91fb-tools/design-system-react-components-storybook:develop ed91fb-tools/design-system-react-components-storybook:production
|
|
124
|
+
```
|
|
125
|
+
|
|
110
126
|
#### Testing with Storybook Test Runner
|
|
111
127
|
|
|
112
128
|
With Storybook running locally, use the `npm run test-storybook` script to run `@storybook/test-runner` using the configuration defined in `./.storybook/test-runner.ts`. [Learn more about Storybook Test Runner](https://storybook.js.org/docs/writing-tests/test-runner).
|
|
@@ -124,3 +140,5 @@ To generate an updated copy of the package for distribution, run the included Ro
|
|
|
124
140
|
This will place artifacts in the `dist` folder, which is targeted for publishing in `package.json` with the [`files` field](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#files).
|
|
125
141
|
|
|
126
142
|
Update the package version in `package.json` and run `npm publish` to push a new version.
|
|
143
|
+
|
|
144
|
+
To publish a beta/release candidate version, use `npm publish --tag next`.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bcgov/design-system-react-components",
|
|
3
|
-
"version": "0.0.10
|
|
3
|
+
"version": "0.0.10",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"rollup": "rm -rf dist && rollup -c --bundleConfigAsCjs",
|
|
@@ -37,14 +37,14 @@
|
|
|
37
37
|
"@rollup/plugin-json": "6.1.0",
|
|
38
38
|
"@rollup/plugin-node-resolve": "15.2.3",
|
|
39
39
|
"@rollup/plugin-typescript": "11.1.6",
|
|
40
|
-
"@storybook/addon-a11y": "8.2.
|
|
41
|
-
"@storybook/addon-essentials": "8.2.
|
|
42
|
-
"@storybook/addon-interactions": "8.2.
|
|
43
|
-
"@storybook/addon-links": "8.2.
|
|
44
|
-
"@storybook/blocks": "8.2.
|
|
45
|
-
"@storybook/react": "8.2.
|
|
46
|
-
"@storybook/react-vite": "8.2.
|
|
47
|
-
"@storybook/test": "8.2.
|
|
40
|
+
"@storybook/addon-a11y": "8.2.5",
|
|
41
|
+
"@storybook/addon-essentials": "8.2.5",
|
|
42
|
+
"@storybook/addon-interactions": "8.2.5",
|
|
43
|
+
"@storybook/addon-links": "8.2.5",
|
|
44
|
+
"@storybook/blocks": "8.2.5",
|
|
45
|
+
"@storybook/react": "8.2.5",
|
|
46
|
+
"@storybook/react-vite": "8.2.5",
|
|
47
|
+
"@storybook/test": "8.2.5",
|
|
48
48
|
"@storybook/test-runner": "0.19.1",
|
|
49
49
|
"@testing-library/jest-dom": "6.4.5",
|
|
50
50
|
"@testing-library/react": "16.0.0",
|
|
@@ -66,7 +66,7 @@
|
|
|
66
66
|
"rollup-plugin-dts": "6.1.1",
|
|
67
67
|
"rollup-plugin-peer-deps-external": "2.2.4",
|
|
68
68
|
"rollup-plugin-postcss": "4.0.2",
|
|
69
|
-
"storybook": "8.2.
|
|
69
|
+
"storybook": "8.2.5",
|
|
70
70
|
"ts-jest": "29.1.4",
|
|
71
71
|
"ts-node": "10.9.2",
|
|
72
72
|
"tslib": "2.6.2",
|