@moda/om 19.1.0 → 19.3.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 +6 -6
- package/dist/index.cjs.js +343 -241
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +343 -241
- package/dist/index.esm.js.map +1 -1
- package/dist/src/components/SearchInput/SearchInput.d.ts +1 -0
- package/dist/src/components/SearchInput/SearchInput.stories.d.ts +1 -0
- package/dist/src/components/Select/Select.d.ts +1 -0
- package/dist/styles.css +1 -1
- package/package.json +89 -87
- package/src/components/SearchInput/SearchInput.scss +4 -0
- package/src/components/SearchInput/SearchInput.stories.tsx +6 -0
- package/src/components/SearchInput/SearchInput.tsx +5 -1
- package/src/components/Select/Select.tsx +1 -0
package/README.md
CHANGED
|
@@ -21,13 +21,13 @@ Clone this repository and install dependencies:
|
|
|
21
21
|
```
|
|
22
22
|
git clone git@github.com:ModaOperandi/om.git
|
|
23
23
|
cd om
|
|
24
|
-
|
|
24
|
+
npm install
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
This repo includes scaffolders for generating folder/file structure for: React Components, as well as SASS mixins and functions.
|
|
28
28
|
|
|
29
29
|
```
|
|
30
|
-
|
|
30
|
+
npm run scaffold:component FooBar
|
|
31
31
|
# => Wrote: ./src/components/FooBar/index.ts
|
|
32
32
|
# => Wrote: ./src/components/FooBar/FooBar.scss
|
|
33
33
|
# => Wrote: ./src/components/FooBar/FooBar.stories.tsx
|
|
@@ -42,7 +42,7 @@ This creates a folder in the correct place in addition to immediately runnable t
|
|
|
42
42
|
The SASS scaffolders functions in a similar manner.
|
|
43
43
|
|
|
44
44
|
```
|
|
45
|
-
|
|
45
|
+
npm run scaffold:mixin foobar
|
|
46
46
|
# => Wrote: ./src/mixins/foobar/_foobar.scss
|
|
47
47
|
# => Wrote: ./src/mixins/foobar/foobar.stories.scss
|
|
48
48
|
# => Wrote: ./src/mixins/foobar/foobar.stories.tsx
|
|
@@ -55,7 +55,7 @@ yarn scaffold:mixin foobar
|
|
|
55
55
|
Once you've scaffolded out the file structure, boot up Storybook to drive out the component's development.
|
|
56
56
|
|
|
57
57
|
```
|
|
58
|
-
|
|
58
|
+
npm run storybook
|
|
59
59
|
# => Local: http://localhost:6006/
|
|
60
60
|
```
|
|
61
61
|
|
|
@@ -65,7 +65,7 @@ You'll see your scaffolded story in the appropriate place in the story tree.
|
|
|
65
65
|
|
|
66
66
|
We are using [semantic release](https://github.com/semantic-release/semantic-release) to automate versioning and publishing the package, and [commitizen](https://github.com/commitizen/cz-cli) to assist with formatting commits conforming to [conventional changelog](https://github.com/conventional-changelog/conventional-changelog).
|
|
67
67
|
|
|
68
|
-
Once you want to commit something, `git add` it then run the commitizen CLI. If you have it installed globally (`
|
|
68
|
+
Once you want to commit something, `git add` it then run the commitizen CLI. If you have it installed globally (`npm install -g commitizen`), you can run `git cz` and it will walk you through the steps.
|
|
69
69
|
|
|
70
70
|
When you're happy push to a feature branch and once the code is in `master`, semantic release will detect how to version it and automatically publish it to NPM.
|
|
71
71
|
|
|
@@ -74,7 +74,7 @@ When you're happy push to a feature branch and once the code is in `master`, sem
|
|
|
74
74
|
### Getting Started
|
|
75
75
|
|
|
76
76
|
```
|
|
77
|
-
|
|
77
|
+
npm install --save @moda/om
|
|
78
78
|
```
|
|
79
79
|
|
|
80
80
|
Import the Component CSS in your global SCSS file:
|