@narmi/design_system 6.36.0 → 6.37.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 +8 -1
- package/dist/index.js +29 -29
- package/dist/index.js.map +1 -1
- package/dist/style.css +1 -1
- package/dist/style.css.map +1 -1
- package/dist/types/Field/Date/dateUtils.d.ts +33 -0
- package/dist/types/Field/Date/dateUtils.d.ts.map +1 -0
- package/dist/types/Field/Date/index.d.ts +41 -0
- package/dist/types/Field/Date/index.d.ts.map +1 -0
- package/dist/types/Field/Date/useFieldDate.d.ts +110 -0
- package/dist/types/Field/Date/useFieldDate.d.ts.map +1 -0
- package/dist/types/Field/index.d.ts +4 -0
- package/dist/types/Field/index.d.ts.map +1 -1
- package/dist/types/index.d.ts +1 -0
- package/dist/types/index.d.ts.map +1 -1
- package/package.json +9 -3
package/README.md
CHANGED
|
@@ -100,7 +100,8 @@ Install settings are in [`pnpm-workspace.yaml`](./pnpm-workspace.yaml). If an in
|
|
|
100
100
|
| `build:tokens` | builds all distributions of design tokens to `dist/` |
|
|
101
101
|
| `build:components` | builds all components and base stylesheet to `dist/` |
|
|
102
102
|
| `build` | builds everything |
|
|
103
|
-
| `test` | runs all
|
|
103
|
+
| `test` | runs all unit tests (Vitest, jsdom) |
|
|
104
|
+
| `test:storybook` | renders every story in Chromium and runs axe a11y |
|
|
104
105
|
| `storybook` | starts storybook in dev server mode on `:6006` |
|
|
105
106
|
| `watch` | watches `src` dir, triggering `build` on changes |
|
|
106
107
|
| `dev` | **Start storybook and watch for all `src` changes** |
|
|
@@ -278,6 +279,12 @@ For a detailed step-by-step guide on resolving failing Chromatic checks, see the
|
|
|
278
279
|
**🔑 Authentication Required:**
|
|
279
280
|
While the Storybook preview is public, you must log into [Chromatic](chromatic.com/start) with Narmi engineering credentials to view details on the build and approve or deny snapshot changes.
|
|
280
281
|
|
|
282
|
+
#### ♿ Working with accessibility tests
|
|
283
|
+
|
|
284
|
+
The workflow that runs accessibility testing is "Storybook Accessibility"/`run-storybook-a11y`. It renders every story in headless Chromium and fails on any axe violation reported by the Storybook a11y addon. All pull requests will block merging until this workflow passes.
|
|
285
|
+
|
|
286
|
+
Run it locally with `pnpm run test:storybook` (after a one-time `pnpm exec playwright install chromium`). Violations that predate the check are tolerated through `.storybook/a11y-baseline.json`, which can only shrink. For how to read a failure, fix it, and update the baseline, see the [Accessibility Tests](//github.com/narmi/design_system/tree/main/contributing/accessibility-tests.md) contributing guide.
|
|
287
|
+
|
|
281
288
|
### Manual publishing (Narmi only)
|
|
282
289
|
|
|
283
290
|
In rare circumstances, you may need to manually publish a version of NDS outside of the normal automated release process.
|