@mmb-digital/design-system-web 0.1.339 → 0.1.340
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 +38 -0
- package/dist/index.cjs.js +31 -39
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +1460 -1386
- package/dist/index.esm.js +31 -39
- package/dist/index.esm.js.map +1 -1
- package/package.json +55 -57
- package/babel.config.js +0 -34
- package/hs_err_pid21560.log +0 -305
- package/readme.md +0 -59
- package/types/jest.config.d.ts +0 -7
package/README.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# design-system-web
|
|
2
|
+
|
|
3
|
+
Shared UI components and form utilities for NWP, DebtMarket and various Next.js applications in the NWP team/project.
|
|
4
|
+
|
|
5
|
+
## Prerequisities:
|
|
6
|
+
|
|
7
|
+
- Node 20.x
|
|
8
|
+
- Yarn 1.x
|
|
9
|
+
|
|
10
|
+
## Workspace Setup
|
|
11
|
+
|
|
12
|
+
Reuse the `.npmrc` file from `nwp/modules/javascript` (separate repository) either by copy-pasting it to `design-system-web`, or by putting it in the user (`~`) directory.
|
|
13
|
+
|
|
14
|
+
Run `yarn` to install dependencies.
|
|
15
|
+
|
|
16
|
+
## Running the Design System
|
|
17
|
+
|
|
18
|
+
`yarn sb`
|
|
19
|
+
|
|
20
|
+
## Publishing to npm registry
|
|
21
|
+
|
|
22
|
+
https://www.npmjs.com/package/@mmb-digital/design-system-web
|
|
23
|
+
|
|
24
|
+
You must be added to the @mmb-digital organization at npmjs.com (you will need to enable two-factor authentication on your npmjs.com account).
|
|
25
|
+
|
|
26
|
+
1. Ensure you are logged in via `npm login`
|
|
27
|
+
2. Upgrade version of package in `package.json`
|
|
28
|
+
3. `rm -rf dist/`
|
|
29
|
+
4. `yarn build`
|
|
30
|
+
5. `npm publish --access public`
|
|
31
|
+
|
|
32
|
+
## Styling rules
|
|
33
|
+
|
|
34
|
+
For each component, a corresponding `*.style.ts` file is created to manage its styles.
|
|
35
|
+
|
|
36
|
+
- Styling is done solely via `emotion`.
|
|
37
|
+
- All colors and other common values are in theme variables to ensure consistency throughout the project.
|
|
38
|
+
- All components have to be responsive, mobile-first.
|