@raspberrypifoundation/design-system-react 2.10.4 → 2.11.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 +4 -25
- package/dist/design-system-react.js +1289 -1312
- package/dist/design-system-react.umd.cjs +14 -14
- package/dist/types/src/components/Accordion/index.d.ts +1 -1
- package/dist/types/src/components/Accordion/index.d.ts.map +1 -1
- package/dist/types/src/components/Alert/index.d.ts +1 -1
- package/dist/types/src/components/Alert/index.d.ts.map +1 -1
- package/dist/types/src/components/Button/index.d.ts +2 -1
- package/dist/types/src/components/Button/index.d.ts.map +1 -1
- package/dist/types/src/components/Form/CheckboxInput/index.d.ts +1 -1
- package/dist/types/src/components/Form/CheckboxInput/index.d.ts.map +1 -1
- package/dist/types/src/components/Form/Fieldset/index.d.ts +1 -1
- package/dist/types/src/components/Form/Fieldset/index.d.ts.map +1 -1
- package/dist/types/src/components/Form/InputField/index.d.ts +1 -1
- package/dist/types/src/components/Form/InputField/index.d.ts.map +1 -1
- package/dist/types/src/components/Form/InputLabel/index.d.ts +1 -1
- package/dist/types/src/components/Form/InputLabel/index.d.ts.map +1 -1
- package/dist/types/src/components/Form/PasswordInput/index.d.ts +1 -1
- package/dist/types/src/components/Form/PasswordInput/index.d.ts.map +1 -1
- package/dist/types/src/components/Form/RadioInput/index.d.ts +1 -1
- package/dist/types/src/components/Form/RadioInput/index.d.ts.map +1 -1
- package/dist/types/src/components/Form/SearchInput/index.d.ts +1 -1
- package/dist/types/src/components/Form/SearchInput/index.d.ts.map +1 -1
- package/dist/types/src/components/Form/SelectInput/index.d.ts +1 -1
- package/dist/types/src/components/Form/SelectInput/index.d.ts.map +1 -1
- package/dist/types/src/components/Form/TextInput/index.d.ts +1 -1
- package/dist/types/src/components/Form/TextInput/index.d.ts.map +1 -1
- package/dist/types/src/components/Form/TextareaInput/index.d.ts +1 -1
- package/dist/types/src/components/Form/TextareaInput/index.d.ts.map +1 -1
- package/dist/types/src/components/Menu/MenuButton/index.d.ts +1 -1
- package/dist/types/src/components/Menu/MenuButton/index.d.ts.map +1 -1
- package/dist/types/src/components/Menu/MenuItem/index.d.ts +1 -1
- package/dist/types/src/components/Menu/MenuItem/index.d.ts.map +1 -1
- package/dist/types/src/components/Menu/MenuTitle/index.d.ts +1 -1
- package/dist/types/src/components/Menu/MenuTitle/index.d.ts.map +1 -1
- package/dist/types/src/components/Menu/index.d.ts +1 -1
- package/dist/types/src/components/Menu/index.d.ts.map +1 -1
- package/dist/types/src/components/Modal/index.d.ts +1 -1
- package/dist/types/src/components/Modal/index.d.ts.map +1 -1
- package/dist/types/src/components/ProgressBar/index.d.ts +1 -1
- package/dist/types/src/components/ProgressBar/index.d.ts.map +1 -1
- package/dist/types/src/components/Squiggle/Squiggle.spec.d.ts +2 -0
- package/dist/types/src/components/Squiggle/Squiggle.spec.d.ts.map +1 -0
- package/dist/types/src/components/Squiggle/index.d.ts +4 -0
- package/dist/types/src/components/Squiggle/index.d.ts.map +1 -0
- package/dist/types/src/components/Table/BodyCell/index.d.ts +1 -1
- package/dist/types/src/components/Table/BodyCell/index.d.ts.map +1 -1
- package/dist/types/src/components/Table/HeaderCell/index.d.ts +1 -1
- package/dist/types/src/components/Table/HeaderCell/index.d.ts.map +1 -1
- package/dist/types/src/components/Table/Table/index.d.ts +1 -1
- package/dist/types/src/components/Table/Table/index.d.ts.map +1 -1
- package/dist/types/src/components/Tag/index.d.ts +1 -1
- package/dist/types/src/components/Tag/index.d.ts.map +1 -1
- package/dist/types/src/stories/Accordion.stories.d.ts +1 -1
- package/dist/types/src/stories/Accordion.stories.d.ts.map +1 -1
- package/dist/types/src/stories/Button.stories.d.ts +3 -3
- package/dist/types/src/stories/Modal/ExampleModal/ExampleModal.d.ts +2 -1
- package/dist/types/src/stories/Modal/ExampleModal/ExampleModal.d.ts.map +1 -1
- package/dist/types/src/stories/Modal/Modal.stories.d.ts +1 -1
- package/dist/types/src/stories/Modal/Modal.stories.helpers.d.ts +2 -2
- package/dist/types/src/stories/Modal/Modal.stories.helpers.d.ts.map +1 -1
- package/dist/types/src/stories/ProgressBar.stories.d.ts +3 -3
- package/dist/types/src/stories/Squiggle.stories.d.ts +8 -0
- package/dist/types/src/stories/Squiggle.stories.d.ts.map +1 -0
- package/dist/types/src/stories/forms/CheckboxInput.stories.d.ts +1 -1
- package/dist/types/src/stories/forms/CheckboxInput.stories.d.ts.map +1 -1
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
# RPF Design System - React
|
|
2
2
|
|
|
3
|
+
> [!TIP]
|
|
4
|
+
> This package lives in the [design-system monorepo](../../README.md). Read the main README first. It explains how to work within the npm workspace.
|
|
5
|
+
|
|
3
6
|
The React implementation of the **Raspberry Pi Foundation Design System**
|
|
4
7
|
|
|
5
8
|
<a href="https://design-system-react.rpf-internal.org/?path=/docs/documentation-introduction--documentation">-label?style=for-the-badge&color=hsla(223%2C%209%25%2C%2085%25%2C%201)&labelColor=00AECE>)</a>
|
|
@@ -184,28 +187,4 @@ During the migration period you may see a mix of `propTypes` and TypeScript in d
|
|
|
184
187
|
|
|
185
188
|
## Releasing a version
|
|
186
189
|
|
|
187
|
-
|
|
188
|
-
2. The workflow creates a branch and opens a draft pull request that:
|
|
189
|
-
- bumps the version in `package.json`; and
|
|
190
|
-
- changes the `Unreleased` heading in `CHANGELOG.md` to the new version and release date.
|
|
191
|
-
3. Review the generated changes, mark the pull request ready for review, and merge it into `main`.
|
|
192
|
-
4. Create a matching tag. The tag must start with `v`, for example `v2.10.4`. You can do this in either of these ways:
|
|
193
|
-
|
|
194
|
-
- **Using the command line:** pull the merged commit, then create and push the tag:
|
|
195
|
-
|
|
196
|
-
```sh
|
|
197
|
-
git checkout main
|
|
198
|
-
git pull
|
|
199
|
-
git tag v2.10.4
|
|
200
|
-
git push origin v2.10.4
|
|
201
|
-
```
|
|
202
|
-
|
|
203
|
-
- **Using the GitHub UI:**
|
|
204
|
-
1. Open the [new release page](https://github.com/RaspberryPiFoundation/design-system-react/releases/new).
|
|
205
|
-
2. Select **Choose a tag** and enter the new version, including the `v` prefix.
|
|
206
|
-
3. Select **Create new tag on publish**.
|
|
207
|
-
4. Confirm that the tag will target the `main` branch.
|
|
208
|
-
|
|
209
|
-
5. On the [new release page](https://github.com/RaspberryPiFoundation/design-system-react/releases/new), select the matching tag, generate the default release notes, and publish the release. If you chose to create the tag through the GitHub UI, publishing the release creates the tag at the same time.
|
|
210
|
-
|
|
211
|
-
Publishing the GitHub release triggers GitHub Actions to build the package and publish it to npm using npm Trusted Publishing. Releases do not require an `NPM_TOKEN` or `NODE_AUTH_TOKEN` repository secret.
|
|
190
|
+
This monorepo uses release-please to publish releases. See [Releases (release-please)](../../README.md#releases-release-please) in the main README.
|