@cfpb/design-system-react 1.0.4 → 1.0.5
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 +4 -2
- package/dist/index.css +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +7 -7
- package/dist/index.mjs +82 -85
- package/dist/src/components/Alert/alert.stories.d.ts +5 -4
- package/dist/src/components/Breadcrumb/breadcrumb.stories.d.ts +2 -1
- package/dist/src/components/Expandable/expandable.stories.d.ts +4 -2
- package/dist/src/components/Hero/hero.stories.d.ts +1 -1
- package/dist/src/components/TextIntroduction/test-helpers.d.ts +3 -3
- package/dist/src/components/TextIntroduction/text-introduction.stories.d.ts +1 -9
- package/dist/src/components/Well/well.stories.d.ts +3 -2
- package/package.json +30 -29
package/README.md
CHANGED
|
@@ -12,12 +12,14 @@ Current components: https://cfpb.github.io/design-system-react
|
|
|
12
12
|
|
|
13
13
|
The `@cfpb/design-system-react` library is released as an [NPM package](https://www.npmjs.com/package/@cfpb/design-system-react).
|
|
14
14
|
|
|
15
|
-
To install the package:
|
|
15
|
+
To install the package and its peer dependencies:
|
|
16
16
|
|
|
17
17
|
```
|
|
18
|
-
yarn add @cfpb/design-system-react
|
|
18
|
+
yarn add @cfpb/design-system-react @cfpb/cfpb-design-system lit react react-dom react-router
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
+
`lit` is required because `@cfpb/cfpb-design-system` web components (for example `<cfpb-tagline>` in `Banner`) are built with [Lit](https://lit.dev/).
|
|
22
|
+
|
|
21
23
|
## Usage
|
|
22
24
|
|
|
23
25
|
```ts
|