@bcgov/design-system-react-components 0.0.5 → 0.0.7-rc1
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 +17 -8
- package/dist/cjs/index.cjs +4809 -4457
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/cjs/types/components/Button/Button.test.d.ts +1 -0
- package/dist/cjs/types/components/Footer/Footer.d.ts +28 -2
- package/dist/cjs/types/components/Footer/index.d.ts +2 -2
- package/dist/cjs/types/components/Header/Header.d.ts +1 -1
- package/dist/cjs/types/components/Tooltip/Tooltip.d.ts +5 -0
- package/dist/cjs/types/components/Tooltip/index.d.ts +2 -0
- package/dist/cjs/types/components/index.d.ts +2 -1
- package/dist/esm/index.js +3882 -3533
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/types/components/Button/Button.test.d.ts +1 -0
- package/dist/esm/types/components/Footer/Footer.d.ts +28 -2
- package/dist/esm/types/components/Footer/index.d.ts +2 -2
- package/dist/esm/types/components/Header/Header.d.ts +1 -1
- package/dist/esm/types/components/Tooltip/Tooltip.d.ts +5 -0
- package/dist/esm/types/components/Tooltip/index.d.ts +2 -0
- package/dist/esm/types/components/index.d.ts +2 -1
- package/dist/index.d.ts +34 -5
- package/package.json +49 -33
- package/dist/assets/BCSans-Bold-ZqE3sZik.woff +0 -0
- package/dist/assets/BCSans-Bold-onJZunl0.woff2 +0 -0
- package/dist/assets/BCSans-BoldItalic-4P_OlA2s.woff +0 -0
- package/dist/assets/BCSans-BoldItalic-GxGpSOWy.woff2 +0 -0
- package/dist/assets/BCSans-Italic-Pz_cGW4F.woff2 +0 -0
- package/dist/assets/BCSans-Italic-UhTyhoET.woff +0 -0
- package/dist/assets/BCSans-Light-A03rbYd1.woff2 +0 -0
- package/dist/assets/BCSans-Light-playkmYo.woff +0 -0
- package/dist/assets/BCSans-LightItalic-HTeW1g69.woff2 +0 -0
- package/dist/assets/BCSans-LightItalic-tgMWPWlK.woff +0 -0
- package/dist/assets/BCSans-Regular-jMf6NRx3.woff +0 -0
- package/dist/assets/BCSans-Regular-ysGfRp0T.woff2 +0 -0
- package/dist/assets/index-t1vEzjyT.css +0 -1
- package/dist/assets/index-yaBoZILt.js +0 -48
- package/dist/cjs/types/components/SelectItem/SelectItem.d.ts +0 -16
- package/dist/cjs/types/components/SelectItem/index.d.ts +0 -2
- package/dist/esm/types/components/SelectItem/SelectItem.d.ts +0 -16
- package/dist/esm/types/components/SelectItem/index.d.ts +0 -2
- package/dist/index.html +0 -14
- package/dist/vite.svg +0 -1
package/README.md
CHANGED
|
@@ -66,19 +66,20 @@ export default function App() {
|
|
|
66
66
|
|
|
67
67
|
## Component list
|
|
68
68
|
|
|
69
|
-
| Component
|
|
70
|
-
|
|
|
71
|
-
| Button
|
|
72
|
-
| Footer
|
|
73
|
-
| Header
|
|
74
|
-
| Select
|
|
75
|
-
| TagGroup, TagList, Tag
|
|
69
|
+
| Component | React Aria Components docs link |
|
|
70
|
+
| ----------------------- | --------------------------------------------------------- |
|
|
71
|
+
| Button | https://react-spectrum.adobe.com/react-aria/Button.html |
|
|
72
|
+
| Footer | N/A |
|
|
73
|
+
| Header | N/A |
|
|
74
|
+
| Select | https://react-spectrum.adobe.com/react-aria/Select.html |
|
|
75
|
+
| TagGroup, TagList, Tag | https://react-spectrum.adobe.com/react-aria/TagGroup.html |
|
|
76
|
+
| Tooltip, TooltipTrigger | https://react-spectrum.adobe.com/react-aria/Tooltip.html |
|
|
76
77
|
|
|
77
78
|
## Supported React versions
|
|
78
79
|
|
|
79
80
|
This package has a peer dependency on `react` and `react-dom` at these versions: `"^16.14.0 || ^17.0.0-rc.1 || ^18.0.0"`
|
|
80
81
|
|
|
81
|
-
By targeting v16.
|
|
82
|
+
By targeting v16.14.0 as a minimum, we get to use [React's modern JSX transformation](https://legacy.reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html) in `tsconfig.json`:
|
|
82
83
|
|
|
83
84
|
```json
|
|
84
85
|
"jsx": "react-jsx",
|
|
@@ -96,12 +97,20 @@ This project follows semantic versioning. See [CHANGELOG.md](./CHANGELOG.md) for
|
|
|
96
97
|
|
|
97
98
|
Components live in `./src/components` and are targeted by the build process with an export in `./src/index.ts`.
|
|
98
99
|
|
|
100
|
+
#### Testing components with Jest
|
|
101
|
+
|
|
102
|
+
Unit tests can be run with Jest using `npm run test`.
|
|
103
|
+
|
|
99
104
|
### Storybook
|
|
100
105
|
|
|
101
106
|
Storybook stories live in `./src/stories`.
|
|
102
107
|
|
|
103
108
|
Run `npm run storybook-dev` to access the Storybook instance for the component library.
|
|
104
109
|
|
|
110
|
+
#### Testing with Storybook Test Runner
|
|
111
|
+
|
|
112
|
+
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).
|
|
113
|
+
|
|
105
114
|
### Vite kitchen sink application
|
|
106
115
|
|
|
107
116
|
Vite uses the components code directly from `./src/components` in groups of content in `./src/pages`.
|