engie-fluid-material-theme 0.3.1 → 0.3.2
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 +30 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@ This library provides a Material Theme giving to an application an appearance si
|
|
|
6
6
|
|
|
7
7
|
## Pre requisite
|
|
8
8
|
|
|
9
|
-
Assuming that you have installed
|
|
9
|
+
Assuming that you have installed Material components (^18) and the Fluid Design System:
|
|
10
10
|
|
|
11
11
|
```cmd
|
|
12
12
|
@engie-group/fluid-design-system
|
|
@@ -69,3 +69,32 @@ body {
|
|
|
69
69
|
{ provide: MAT_FORM_FIELD_DEFAULT_OPTIONS, useValue: {appearance: 'outline', subscriptSizing: 'dynamic'}}
|
|
70
70
|
```
|
|
71
71
|
|
|
72
|
+
# Usage Guide
|
|
73
|
+
|
|
74
|
+
Theme's code source is located in src folder.
|
|
75
|
+
|
|
76
|
+
1. Generate a dist folder with packaged css file.
|
|
77
|
+
```cmd
|
|
78
|
+
npm run build
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
2. Publish package on public NPM, don't forget to increment version in package.json:
|
|
82
|
+
```cmd
|
|
83
|
+
npm run publish
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
3. Run linter
|
|
87
|
+
```cmd
|
|
88
|
+
npm run qa:scss
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
On Test folder, you can find an Angular web app which allow to test the package.
|
|
92
|
+
You can edit the theme, regenerate the build and test it directly on the web app.
|
|
93
|
+
|
|
94
|
+
```cmd
|
|
95
|
+
C:\Users\GAIA\source\repos\fluid-material-theme>npm run build
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
```cmd
|
|
99
|
+
C:\Users\GAIA\source\repos\fluid-material-theme\test>npm start
|
|
100
|
+
```
|