@primer/css 0.0.0-2021102434653 → 0.0.0-2021102434749
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/CHANGELOG.md +1 -1
- package/DEVELOP.md +15 -0
- package/dist/meta.json +22 -22
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/DEVELOP.md
CHANGED
|
@@ -41,6 +41,20 @@ The [docs directory](../docs/) contains all of the documentation files in our do
|
|
|
41
41
|
### Code blocks
|
|
42
42
|
All `html` fenced code blocks in `src/**/*.md` will be rendered as stories and listed under the relevant module's name in the left-hand nav. File changes should trigger a live reload automatically (after a brief delay).
|
|
43
43
|
|
|
44
|
+
## Storybook
|
|
45
|
+
|
|
46
|
+
Primer CSS Storybook is used for designing and prototyping components. Stories are written in HTML and leverage the Storybook API for configuring conditional logic.
|
|
47
|
+
|
|
48
|
+
```sh
|
|
49
|
+
npm storybook
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### The Storybook directory
|
|
53
|
+
Storybook configuration files live in [.storybook](../docs/.storybook). Addons and additional global config can be added to [main.js](../docs/.storybook/main.js) or [preview.js](../docs/.storybook/preview.js)
|
|
54
|
+
|
|
55
|
+
### Stories
|
|
56
|
+
Stories are individual `.jsx` or `.mdx` files that contain component HTML for prototyping, typically showcasing all possible variations of a component. Stories can be found in the [stories directory](../docs/src/stories/components) and are organized by component. Storybook will build and deploy a preview on any open Pull Request.
|
|
57
|
+
|
|
44
58
|
## Scripts
|
|
45
59
|
Our [`package.json`](package.json) houses a collection of [run-scripts] that we use to maintain, test, build, and publish Primer CSS. Run `npm run <script>` with any of the following values for `<script>`:
|
|
46
60
|
|
|
@@ -51,6 +65,7 @@ Our [`package.json`](package.json) houses a collection of [run-scripts] that we
|
|
|
51
65
|
* `now-build` and `now-start` are run on [Now] to build and start the docs site server. `now-test` runs them both in order.
|
|
52
66
|
* `start` runs the documentation site locally (alias: `dev`).
|
|
53
67
|
* `test` runs our test suite.
|
|
68
|
+
* `storybook` runs storybook local development server.
|
|
54
69
|
|
|
55
70
|
The above list may not always be up-to-date. You can list all of the available scripts by calling `npm run` with no other arguments.
|
|
56
71
|
|
package/dist/meta.json
CHANGED
|
@@ -143,6 +143,17 @@
|
|
|
143
143
|
"legacy": "primer-alerts/index.scss",
|
|
144
144
|
"imports": []
|
|
145
145
|
},
|
|
146
|
+
"toasts": {
|
|
147
|
+
"name": "toasts",
|
|
148
|
+
"source": "src/toasts/index.scss",
|
|
149
|
+
"sass": "@primer/css/toasts/index.scss",
|
|
150
|
+
"css": "dist/toasts.css",
|
|
151
|
+
"map": "dist/toasts.css.map",
|
|
152
|
+
"js": "dist/toasts.js",
|
|
153
|
+
"stats": "dist/stats/toasts.json",
|
|
154
|
+
"legacy": "primer-toasts/index.scss",
|
|
155
|
+
"imports": []
|
|
156
|
+
},
|
|
146
157
|
"popover": {
|
|
147
158
|
"name": "popover",
|
|
148
159
|
"source": "src/popover/index.scss",
|
|
@@ -154,6 +165,17 @@
|
|
|
154
165
|
"legacy": "primer-popover/index.scss",
|
|
155
166
|
"imports": []
|
|
156
167
|
},
|
|
168
|
+
"tooltips": {
|
|
169
|
+
"name": "tooltips",
|
|
170
|
+
"source": "src/tooltips/index.scss",
|
|
171
|
+
"sass": "@primer/css/tooltips/index.scss",
|
|
172
|
+
"css": "dist/tooltips.css",
|
|
173
|
+
"map": "dist/tooltips.css.map",
|
|
174
|
+
"js": "dist/tooltips.js",
|
|
175
|
+
"stats": "dist/stats/tooltips.json",
|
|
176
|
+
"legacy": "primer-tooltips/index.scss",
|
|
177
|
+
"imports": []
|
|
178
|
+
},
|
|
157
179
|
"dropdown": {
|
|
158
180
|
"name": "dropdown",
|
|
159
181
|
"source": "src/dropdown/index.scss",
|
|
@@ -187,28 +209,6 @@
|
|
|
187
209
|
"legacy": "primer-truncate/index.scss",
|
|
188
210
|
"imports": []
|
|
189
211
|
},
|
|
190
|
-
"toasts": {
|
|
191
|
-
"name": "toasts",
|
|
192
|
-
"source": "src/toasts/index.scss",
|
|
193
|
-
"sass": "@primer/css/toasts/index.scss",
|
|
194
|
-
"css": "dist/toasts.css",
|
|
195
|
-
"map": "dist/toasts.css.map",
|
|
196
|
-
"js": "dist/toasts.js",
|
|
197
|
-
"stats": "dist/stats/toasts.json",
|
|
198
|
-
"legacy": "primer-toasts/index.scss",
|
|
199
|
-
"imports": []
|
|
200
|
-
},
|
|
201
|
-
"tooltips": {
|
|
202
|
-
"name": "tooltips",
|
|
203
|
-
"source": "src/tooltips/index.scss",
|
|
204
|
-
"sass": "@primer/css/tooltips/index.scss",
|
|
205
|
-
"css": "dist/tooltips.css",
|
|
206
|
-
"map": "dist/tooltips.css.map",
|
|
207
|
-
"js": "dist/tooltips.js",
|
|
208
|
-
"stats": "dist/stats/tooltips.json",
|
|
209
|
-
"legacy": "primer-tooltips/index.scss",
|
|
210
|
-
"imports": []
|
|
211
|
-
},
|
|
212
212
|
"marketing-support": {
|
|
213
213
|
"name": "marketing-support",
|
|
214
214
|
"source": "src/marketing/support/index.scss",
|
package/package.json
CHANGED