@bcgov/design-system-react-components 0.8.0-pr756 → 0.8.0-pr758
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 +13 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,14 +1,17 @@
|
|
|
1
1
|
# @bcgov/design-system-react-components
|
|
2
2
|
|
|
3
|
-
This package contains a library of React components built using
|
|
3
|
+
This package contains a library of React components, built using React Aria, as part of the B.C. Design System.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
To use these components, install this package and import the components you need into your application.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
- GitHub: https://github.com/bcgov/design-system/
|
|
8
|
+
- Storybook: https://designsystem.gov.bc.ca/react-components/
|
|
9
|
+
- Documentation: https://gov.bc.ca/designsystem/
|
|
8
10
|
|
|
9
|
-
|
|
11
|
+
If you have questions, you can:
|
|
10
12
|
|
|
11
|
-
|
|
13
|
+
- <a href="mailto:DesignSystem@gov.bc.ca">Email designsystem@gov.bc.ca</a>
|
|
14
|
+
- <a href="https://github.com/bcgov/design-system/issues">Open an issue on GitHub</a>
|
|
12
15
|
|
|
13
16
|
## Install
|
|
14
17
|
|
|
@@ -66,6 +69,8 @@ export default function App() {
|
|
|
66
69
|
|
|
67
70
|
## Component list
|
|
68
71
|
|
|
72
|
+
Most components are based on <a href="https://react-aria.adobe.com">React Aria</a> primitives.
|
|
73
|
+
|
|
69
74
|
| Component | React Aria docs link |
|
|
70
75
|
| --------------------------------------------------------------------------- | ---------------------------------------------- |
|
|
71
76
|
| AlertBanner | N/A |
|
|
@@ -198,14 +203,14 @@ Prettier is used for formatting. See configuration file `prettier.config.js` and
|
|
|
198
203
|
|
|
199
204
|
#### npm package
|
|
200
205
|
|
|
201
|
-
Publishing new versions of the package
|
|
206
|
+
Publishing new versions of the package is done via GitHub Actions.
|
|
202
207
|
|
|
203
208
|
GitHub Actions are located in `/.github/workflows` in the project root. Actions are included to:
|
|
204
209
|
|
|
205
210
|
- Build the Storybook and Vite applications on merge to `main`
|
|
206
211
|
- Test (Vitest and Playwright) on pull request
|
|
207
|
-
- Publish new versions of the library
|
|
208
|
-
- Publish new versions of the library
|
|
212
|
+
- Publish new versions of the library to npm (`next` tag) and GitHub Packages on merge to `main`
|
|
213
|
+
- Publish new production versions of the library to npm (`latest` tag) and GitHub Packages when a GitHub release is published
|
|
209
214
|
|
|
210
215
|
#### GitHub release
|
|
211
216
|
|