@nuskin/nextgen-header 1.13.0 → 1.15.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.
Files changed (2) hide show
  1. package/package.json +1 -2
  2. package/readme.md +22 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nuskin/nextgen-header",
3
- "version": "1.13.0",
3
+ "version": "1.15.0",
4
4
  "description": "Header micro-frontend and npm component library",
5
5
  "main": "package-dist/index.js",
6
6
  "module": "package-dist/index.mjs",
@@ -72,7 +72,6 @@
72
72
  "@loadable/babel-plugin": "^5.13.2",
73
73
  "@loadable/component": "^5.16.4",
74
74
  "@loadable/server": "^5.16.5",
75
- "@mui/base": "5.0.0-beta.70",
76
75
  "@mui/icons-material": "^5.15.0",
77
76
  "@mui/material": "^5.15.0",
78
77
  "@mui/system": "^5.15.0",
package/readme.md CHANGED
@@ -104,6 +104,28 @@ For the **webpack / MFE** build, dotenv files are loaded per build via `CMS_ENV`
104
104
  | `yarn test` | Jest + coverage |
105
105
  | `yarn lint` | ESLint on `src/` |
106
106
 
107
+ ## Storybook
108
+
109
+ Storybook in this repo is used to develop and review isolated UI components for both the shared component library and header/top-navigation work.
110
+
111
+ ### What is covered
112
+
113
+ - **Header view and regions** stories under `src/header/components/`
114
+ - **Shared UI components** stories under `src/components/` (for example tabs, top-navigation, jump-to, sub-category, and label-icon)
115
+ - **Component states and variants** for visual QA and interaction checks without running the full MFE shell
116
+
117
+ ### How to run and build
118
+
119
+ - **Dev flow:** run `yarn start`, then open `http://localhost:3000/storybook/`
120
+ - **preproduction environments:** open https://dev.nuskin.com/static/header-mfe/storybook/ or https://test.nuskin.com/static/header-mfe/storybook/
121
+ - **production environments:** STORYBOOK IS NOT INCLUDED IN PRODUCTION BUILDS
122
+
123
+ ### Notes for CI and deploys
124
+
125
+ - Storybook is intended for local/non-prod review workflows.
126
+ - `build-prod` does not include Storybook output.
127
+ - Keep `dist/storybook/` out of production CDN/static deploy targets
128
+
107
129
  ## Host integration (Module Federation)
108
130
 
109
131
  | Item | Value |