@narmi/design_system 6.32.0 → 6.33.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 +12 -7
- package/dist/index.js +55 -46
- package/dist/index.js.map +1 -1
- package/dist/style.css +1 -1
- package/dist/style.css.map +1 -1
- package/dist/types/AutocompleteModal/Item.d.ts +3 -4
- package/dist/types/AutocompleteModal/Item.d.ts.map +1 -1
- package/dist/types/AutocompleteModal/index.d.ts +3 -3
- package/dist/types/Combobox/ComboboxAction.d.ts +2 -3
- package/dist/types/Combobox/ComboboxAction.d.ts.map +1 -1
- package/dist/types/Combobox/ComboboxCategory.d.ts +2 -3
- package/dist/types/Combobox/ComboboxCategory.d.ts.map +1 -1
- package/dist/types/Combobox/ComboboxHeading.d.ts +2 -3
- package/dist/types/Combobox/ComboboxHeading.d.ts.map +1 -1
- package/dist/types/Combobox/ComboboxItem.d.ts +3 -4
- package/dist/types/Combobox/ComboboxItem.d.ts.map +1 -1
- package/dist/types/Combobox/index.d.ts +9 -9
- package/dist/types/DisabledShim/index.d.ts +2 -3
- package/dist/types/DisabledShim/index.d.ts.map +1 -1
- package/dist/types/Error/index.d.ts +2 -3
- package/dist/types/Error/index.d.ts.map +1 -1
- package/dist/types/FormSection/index.d.ts +2 -3
- package/dist/types/FormSection/index.d.ts.map +1 -1
- package/dist/types/IconButton/index.d.ts +10 -11
- package/dist/types/IconButton/index.d.ts.map +1 -1
- package/dist/types/LoadingShim/index.d.ts +4 -5
- package/dist/types/LoadingShim/index.d.ts.map +1 -1
- package/dist/types/MenuButton/MenuButtonItem.d.ts +4 -5
- package/dist/types/MenuButton/MenuButtonItem.d.ts.map +1 -1
- package/dist/types/MenuButton/index.d.ts +4 -4
- package/dist/types/MenuButton/index.d.ts.map +1 -1
- package/dist/types/MultiSelect/MultiSelectItem.d.ts +4 -5
- package/dist/types/MultiSelect/MultiSelectItem.d.ts.map +1 -1
- package/dist/types/MultiSelect/index.d.ts +4 -4
- package/dist/types/Pagination/index.d.ts +5 -6
- package/dist/types/Pagination/index.d.ts.map +1 -1
- package/dist/types/ResponsiveFlex/index.d.ts +6 -7
- package/dist/types/ResponsiveFlex/index.d.ts.map +1 -1
- package/dist/types/Select/SelectAction.d.ts +2 -3
- package/dist/types/Select/SelectAction.d.ts.map +1 -1
- package/dist/types/Select/SelectCategory.d.ts +4 -5
- package/dist/types/Select/SelectCategory.d.ts.map +1 -1
- package/dist/types/Select/SelectItem.d.ts +3 -4
- package/dist/types/Select/SelectItem.d.ts.map +1 -1
- package/dist/types/Select/index.d.ts +9 -9
- package/dist/types/TextInput/index.d.ts +1 -0
- package/dist/types/TextInput/index.d.ts.map +1 -1
- package/dist/types/TimelineEvent/index.d.ts +8 -12
- package/dist/types/TimelineEvent/index.d.ts.map +1 -1
- package/dist/types/hooks/useMediaQuery/index.d.ts +7 -0
- package/dist/types/hooks/useMediaQuery/index.d.ts.map +1 -0
- package/dist/types/hooks/useOnClickOutside/index.d.ts +6 -0
- package/dist/types/hooks/useOnClickOutside/index.d.ts.map +1 -0
- package/dist/types/util/AsElement.d.ts +2 -3
- package/dist/types/util/AsElement.d.ts.map +1 -1
- package/package.json +17 -16
package/README.md
CHANGED
|
@@ -70,8 +70,8 @@ Refer to the [**Changelog**](https://github.com/narmi/design_system/blob/main/CH
|
|
|
70
70
|
|
|
71
71
|
### Browser Support
|
|
72
72
|
|
|
73
|
-
See [`.browserslistrc`](https://github.com/narmi/design_system/blob/main/.
|
|
74
|
-
run `
|
|
73
|
+
See [`.browserslistrc`](https://github.com/narmi/design_system/blob/main/.browserslistrc) for officially supported browsers or
|
|
74
|
+
run `pnpm exec browserslist` in this project locally to see a full list of targeted browsers.
|
|
75
75
|
|
|
76
76
|
This project does not support any version of Internet Explorer.
|
|
77
77
|
|
|
@@ -79,17 +79,22 @@ This project does not support any version of Internet Explorer.
|
|
|
79
79
|
|
|
80
80
|
### Local development
|
|
81
81
|
|
|
82
|
+
This project uses [pnpm](https://pnpm.io). With [Corepack](https://nodejs.org/api/corepack.html) enabled (`corepack enable`), the pinned version is used automatically.
|
|
83
|
+
|
|
82
84
|
To run project locally:
|
|
83
85
|
|
|
84
86
|
```
|
|
85
87
|
git clone git@github.com:narmi/design_system.git
|
|
86
88
|
cd design_system
|
|
87
|
-
|
|
89
|
+
pnpm install
|
|
90
|
+
pnpm run dev
|
|
88
91
|
```
|
|
89
92
|
|
|
90
|
-
|
|
93
|
+
Install settings are in [`pnpm-workspace.yaml`](./pnpm-workspace.yaml). If an install fails because a new dependency wants to run a build script, review it and configure it with `pnpm approve-builds`.
|
|
94
|
+
|
|
95
|
+
### Package scripts
|
|
91
96
|
|
|
92
|
-
| `
|
|
97
|
+
| `pnpm run` command | Description |
|
|
93
98
|
| ------------------ | ---------------------------------------------------- |
|
|
94
99
|
| `build:jsdoc` | builds jsDoc documentation to `dist/` |
|
|
95
100
|
| `build:tokens` | builds all distributions of design tokens to `dist/` |
|
|
@@ -248,7 +253,7 @@ In rare circumstances, you may need to manually publish a version of NDS outside
|
|
|
248
253
|
|
|
249
254
|
#### Publishing a beta version
|
|
250
255
|
|
|
251
|
-
1. Rebuild NDS (`
|
|
256
|
+
1. Rebuild NDS (`pnpm run build`)
|
|
252
257
|
2. Update the `version` field of package.json to be a beta of the next minor.
|
|
253
258
|
For example, you would change `2.35.2` to `2.36.0-beta.0`.
|
|
254
259
|
DO NOT COMMIT THIS CHANGE.
|
|
@@ -257,7 +262,7 @@ In rare circumstances, you may need to manually publish a version of NDS outside
|
|
|
257
262
|
|
|
258
263
|
If you need to make additional changes after the beta is published...
|
|
259
264
|
|
|
260
|
-
1. Rebuild NDS (`
|
|
265
|
+
1. Rebuild NDS (`pnpm run build`)
|
|
261
266
|
2. Bump the beta version number in package.json (`2.36.0-beta.0` -> `2.36.0-beta.1`)
|
|
262
267
|
3. Install the new beta version in your consuming application.
|
|
263
268
|
|