@carbon/layout 10.0.0-rc.0 → 10.2.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 (16) hide show
  1. package/CHANGELOG.md +464 -0
  2. package/LICENSE +2 -2
  3. package/README.md +23 -19
  4. package/docs/sass.md +1681 -0
  5. package/es/index.js +6 -3
  6. package/lib/index.js +8 -2
  7. package/package.json +4 -4
  8. package/scss/_breakpoint.scss +63 -25
  9. package/scss/_convert.scss +12 -5
  10. package/scss/_key-height.scss +14 -7
  11. package/scss/_mini-unit.scss +8 -3
  12. package/scss/_spacing.scss +274 -1
  13. package/scss/_utilities.scss +10 -8
  14. package/scss/index.scss +8 -0
  15. package/src/index.js +7 -1
  16. package/umd/index.js +8 -2
package/CHANGELOG.md ADDED
@@ -0,0 +1,464 @@
1
+ # Change Log
2
+
3
+ All notable changes to this project will be documented in this file.
4
+ See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
+
6
+ ## [10.1.1](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v10.1.0...v10.1.1) (2019-04-13)
7
+
8
+ **Note:** Version bump only for package @carbon/layout
9
+
10
+
11
+
12
+
13
+
14
+ # 10.1.0 (2019-04-12)
15
+
16
+
17
+ ### Bug Fixes
18
+
19
+ * update layout tokens to match IDL ([#470](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/470)) ([1ec8bfb](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/1ec8bfb))
20
+
21
+
22
+ ### Features
23
+
24
+ * **sassdoc:** render Sassdoc in markdown ([#462](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/462)) ([73cea35](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/73cea35)), closes [#470](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/470)
25
+
26
+
27
+
28
+ # 10.0.0 (2019-03-29)
29
+
30
+
31
+ ### Features
32
+
33
+ * **layout:** update spacing scale ([#458](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/458)) ([360c9eb](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/360c9eb))
34
+
35
+
36
+
37
+ # 10.0.0-rc.0 (2019-03-27)
38
+
39
+
40
+
41
+ ## 0.0.1-beta.5 (2019-03-25)
42
+
43
+
44
+
45
+ ## 0.0.1-beta.4 (2019-03-22)
46
+
47
+
48
+
49
+ ## 0.0.1-beta.3 (2019-03-22)
50
+
51
+
52
+
53
+ ## 0.0.1-beta.2 (2019-03-19)
54
+
55
+
56
+ ### Features
57
+
58
+ * **layout:** support number in breakpoint API ([#432](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/432)) ([0351868](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/0351868)), closes [#431](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/431)
59
+
60
+
61
+
62
+ ## 0.0.1-beta.1 (2019-03-13)
63
+
64
+
65
+ ### Features
66
+
67
+ * **grid:** update scss folder structure and mixins ([#396](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/396)) ([e336c1c](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/e336c1c))
68
+ * **layout:** add spacing scale ([#400](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/400)) ([bda696b](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/bda696b))
69
+
70
+
71
+
72
+ ## 0.0.1-beta.0 (2019-03-07)
73
+
74
+
75
+
76
+ ## 0.0.1-alpha.32 (2019-02-12)
77
+
78
+
79
+ ### Bug Fixes
80
+
81
+ * **layout:** update small margin to be a string ([#310](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/310)) ([3672c9e](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/3672c9e))
82
+
83
+
84
+ ### Features
85
+
86
+ * **project:** add carbon namespace to public API ([#300](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/300)) ([1ae6f33](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/1ae6f33))
87
+
88
+
89
+
90
+ ## 0.0.1-alpha.31 (2019-01-28)
91
+
92
+
93
+
94
+ ## 0.0.1-alpha.30 (2019-01-22)
95
+
96
+
97
+
98
+ ## 0.0.1-alpha.29 (2019-01-14)
99
+
100
+
101
+
102
+ ## 0.0.1-alpha.28 (2019-01-11)
103
+
104
+
105
+
106
+ ## 0.0.1-alpha.27 (2019-01-10)
107
+
108
+
109
+ ### Bug Fixes
110
+
111
+ * update jsdocs [@return](https://github.com/return) to [@returns](https://github.com/returns) ([#197](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/197)) ([79cb046](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/79cb046))
112
+
113
+
114
+ ### Features
115
+
116
+ * **grid:** add full width grid modifier ([#207](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/207)) ([5f72216](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/5f72216))
117
+
118
+
119
+
120
+ ## 0.0.1-alpha.26 (2018-12-13)
121
+
122
+
123
+
124
+ ## 0.0.1-alpha.25 (2018-12-11)
125
+
126
+
127
+
128
+ ## 0.0.1-alpha.24 (2018-12-07)
129
+
130
+
131
+
132
+ ## 0.0.1-alpha.23 (2018-12-06)
133
+
134
+
135
+ ### Bug Fixes
136
+
137
+ * **layout:** remove map-deep-get usage ([#122](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/122)) ([0d9fb71](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/0d9fb71))
138
+
139
+
140
+
141
+ ## 0.0.1-alpha.22 (2018-12-04)
142
+
143
+
144
+
145
+ ## 0.0.1-alpha.21 (2018-12-04)
146
+
147
+
148
+ ### Bug Fixes
149
+
150
+ * **grid:** update grid based on feedback ([#108](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/108)) ([c6c9882](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/c6c9882))
151
+
152
+
153
+
154
+ ## 0.0.1-alpha.20 (2018-11-29)
155
+
156
+
157
+
158
+ ## 0.0.1-alpha.19 (2018-11-29)
159
+
160
+
161
+
162
+ ## 0.0.1-alpha.18 (2018-11-28)
163
+
164
+
165
+
166
+ ## 0.0.1-alpha.17 (2018-11-25)
167
+
168
+
169
+
170
+ ## 0.0.1-alpha.16 (2018-11-21)
171
+
172
+
173
+
174
+ ## 0.0.1-alpha.15 (2018-11-21)
175
+
176
+
177
+
178
+ ## 0.0.1-alpha.14 (2018-11-20)
179
+
180
+
181
+
182
+ ## 0.0.1-alpha.13 (2018-11-19)
183
+
184
+
185
+
186
+ ## 0.0.1-alpha.12 (2018-11-18)
187
+
188
+
189
+
190
+ ## 0.0.1-alpha.11 (2018-11-18)
191
+
192
+
193
+
194
+ ## 0.0.1-alpha.10 (2018-11-18)
195
+
196
+
197
+
198
+ ## 0.0.1-alpha.9 (2018-11-18)
199
+
200
+
201
+
202
+ ## 0.0.1-alpha.8 (2018-11-18)
203
+
204
+
205
+ ### Features
206
+
207
+ * **grid:** add grid implementation ([#63](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/63)) ([cadc583](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/cadc583))
208
+ * add tokens alongside JavaScript output for certain packages ([#72](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/72)) ([6ca03e2](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/6ca03e2))
209
+
210
+
211
+
212
+ ## 0.0.1-alpha.7 (2018-11-14)
213
+
214
+
215
+
216
+ ## 0.0.1-alpha.5 (2018-11-14)
217
+
218
+
219
+
220
+ ## 0.0.1-alpha.4 (2018-11-09)
221
+
222
+
223
+
224
+ ## 0.0.1-alpha.3 (2018-11-09)
225
+
226
+
227
+ ### Features
228
+
229
+ * **type:** update type package ([#35](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/35)) ([85c68ea](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/85c68ea))
230
+
231
+
232
+
233
+ ## 0.0.1-alpha.2 (2018-10-02)
234
+
235
+
236
+ ### Bug Fixes
237
+
238
+ * **icons-react:** update build process and add storybook support ([#34](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/34)) ([c27dbbc](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/c27dbbc))
239
+
240
+
241
+ ### Features
242
+
243
+ * **layout:** add layout package ([#21](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/21)) ([7acc84d](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/7acc84d))
244
+
245
+
246
+
247
+
248
+
249
+ # [10.0.0](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v10.0.0-rc.0...v10.0.0) (2019-03-29)
250
+
251
+
252
+ ### Features
253
+
254
+ * **layout:** update spacing scale ([#458](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/458)) ([360c9eb](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/360c9eb))
255
+
256
+
257
+
258
+ # [10.0.0-rc.0](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-beta.5...v10.0.0-rc.0) (2019-03-27)
259
+
260
+
261
+
262
+ ## [0.0.1-beta.5](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-beta.4...v0.0.1-beta.5) (2019-03-25)
263
+
264
+
265
+
266
+ ## [0.0.1-beta.4](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-beta.3...v0.0.1-beta.4) (2019-03-22)
267
+
268
+
269
+
270
+ ## [0.0.1-beta.3](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-beta.2...v0.0.1-beta.3) (2019-03-22)
271
+
272
+
273
+
274
+ ## [0.0.1-beta.2](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-beta.1...v0.0.1-beta.2) (2019-03-19)
275
+
276
+
277
+ ### Features
278
+
279
+ * **layout:** support number in breakpoint API ([#432](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/432)) ([0351868](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/0351868)), closes [#431](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/431)
280
+
281
+
282
+
283
+ ## [0.0.1-beta.1](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-beta.0...v0.0.1-beta.1) (2019-03-13)
284
+
285
+
286
+ ### Features
287
+
288
+ * **grid:** update scss folder structure and mixins ([#396](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/396)) ([e336c1c](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/e336c1c))
289
+ * **layout:** add spacing scale ([#400](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/400)) ([bda696b](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/bda696b))
290
+
291
+
292
+
293
+ ## [0.0.1-beta.0](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.32...v0.0.1-beta.0) (2019-03-07)
294
+
295
+
296
+
297
+ ## [0.0.1-alpha.32](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.31...v0.0.1-alpha.32) (2019-02-12)
298
+
299
+
300
+ ### Bug Fixes
301
+
302
+ * **layout:** update small margin to be a string ([#310](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/310)) ([3672c9e](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/3672c9e))
303
+
304
+
305
+ ### Features
306
+
307
+ * **project:** add carbon namespace to public API ([#300](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/300)) ([1ae6f33](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/1ae6f33))
308
+
309
+
310
+
311
+ ## [0.0.1-alpha.31](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.30...v0.0.1-alpha.31) (2019-01-28)
312
+
313
+
314
+
315
+ ## [0.0.1-alpha.30](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.29...v0.0.1-alpha.30) (2019-01-22)
316
+
317
+
318
+
319
+ ## [0.0.1-alpha.29](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.28...v0.0.1-alpha.29) (2019-01-14)
320
+
321
+
322
+
323
+ ## [0.0.1-alpha.28](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.27...v0.0.1-alpha.28) (2019-01-11)
324
+
325
+
326
+
327
+ ## [0.0.1-alpha.27](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.26...v0.0.1-alpha.27) (2019-01-10)
328
+
329
+
330
+ ### Bug Fixes
331
+
332
+ * update jsdocs [@return](https://github.com/return) to [@returns](https://github.com/returns) ([#197](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/197)) ([79cb046](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/79cb046))
333
+
334
+
335
+ ### Features
336
+
337
+ * **grid:** add full width grid modifier ([#207](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/207)) ([5f72216](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/5f72216))
338
+
339
+
340
+
341
+ ## [0.0.1-alpha.26](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.25...v0.0.1-alpha.26) (2018-12-13)
342
+
343
+
344
+
345
+ ## [0.0.1-alpha.25](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.24...v0.0.1-alpha.25) (2018-12-11)
346
+
347
+
348
+
349
+ ## [0.0.1-alpha.24](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.23...v0.0.1-alpha.24) (2018-12-07)
350
+
351
+
352
+
353
+ ## [0.0.1-alpha.23](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.22...v0.0.1-alpha.23) (2018-12-06)
354
+
355
+
356
+ ### Bug Fixes
357
+
358
+ * **layout:** remove map-deep-get usage ([#122](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/122)) ([0d9fb71](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/0d9fb71))
359
+
360
+
361
+
362
+ ## [0.0.1-alpha.22](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.21...v0.0.1-alpha.22) (2018-12-04)
363
+
364
+
365
+
366
+ ## [0.0.1-alpha.21](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.20...v0.0.1-alpha.21) (2018-12-04)
367
+
368
+
369
+ ### Bug Fixes
370
+
371
+ * **grid:** update grid based on feedback ([#108](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/108)) ([c6c9882](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/c6c9882))
372
+
373
+
374
+
375
+ ## [0.0.1-alpha.20](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.19...v0.0.1-alpha.20) (2018-11-29)
376
+
377
+
378
+
379
+ ## [0.0.1-alpha.19](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.18...v0.0.1-alpha.19) (2018-11-29)
380
+
381
+
382
+
383
+ ## [0.0.1-alpha.18](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.17...v0.0.1-alpha.18) (2018-11-28)
384
+
385
+
386
+
387
+ ## [0.0.1-alpha.17](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.16...v0.0.1-alpha.17) (2018-11-25)
388
+
389
+
390
+
391
+ ## [0.0.1-alpha.16](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.15...v0.0.1-alpha.16) (2018-11-21)
392
+
393
+
394
+
395
+ ## [0.0.1-alpha.15](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.14...v0.0.1-alpha.15) (2018-11-21)
396
+
397
+
398
+
399
+ ## [0.0.1-alpha.14](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.13...v0.0.1-alpha.14) (2018-11-20)
400
+
401
+
402
+
403
+ ## [0.0.1-alpha.13](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.12...v0.0.1-alpha.13) (2018-11-19)
404
+
405
+
406
+
407
+ ## [0.0.1-alpha.12](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.11...v0.0.1-alpha.12) (2018-11-18)
408
+
409
+
410
+
411
+ ## [0.0.1-alpha.11](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.10...v0.0.1-alpha.11) (2018-11-18)
412
+
413
+
414
+
415
+ ## [0.0.1-alpha.10](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.9...v0.0.1-alpha.10) (2018-11-18)
416
+
417
+
418
+
419
+ ## [0.0.1-alpha.9](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.8...v0.0.1-alpha.9) (2018-11-18)
420
+
421
+
422
+
423
+ ## [0.0.1-alpha.8](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.7...v0.0.1-alpha.8) (2018-11-18)
424
+
425
+
426
+ ### Features
427
+
428
+ * **grid:** add grid implementation ([#63](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/63)) ([cadc583](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/cadc583))
429
+ * add tokens alongside JavaScript output for certain packages ([#72](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/72)) ([6ca03e2](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/6ca03e2))
430
+
431
+
432
+
433
+ ## [0.0.1-alpha.7](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.5...v0.0.1-alpha.7) (2018-11-14)
434
+
435
+
436
+
437
+ ## [0.0.1-alpha.5](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.4...v0.0.1-alpha.5) (2018-11-14)
438
+
439
+
440
+
441
+ ## [0.0.1-alpha.4](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.3...v0.0.1-alpha.4) (2018-11-09)
442
+
443
+
444
+
445
+ ## [0.0.1-alpha.3](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.2...v0.0.1-alpha.3) (2018-11-09)
446
+
447
+
448
+ ### Features
449
+
450
+ * **type:** update type package ([#35](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/35)) ([85c68ea](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/85c68ea))
451
+
452
+
453
+
454
+ ## [0.0.1-alpha.2](https://github.com/IBM/carbon-elements/tree/master/packages/layout/compare/v0.0.1-alpha.0...v0.0.1-alpha.2) (2018-10-02)
455
+
456
+
457
+ ### Bug Fixes
458
+
459
+ * **icons-react:** update build process and add storybook support ([#34](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/34)) ([c27dbbc](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/c27dbbc))
460
+
461
+
462
+ ### Features
463
+
464
+ * **layout:** add layout package ([#21](https://github.com/IBM/carbon-elements/tree/master/packages/layout/issues/21)) ([7acc84d](https://github.com/IBM/carbon-elements/tree/master/packages/layout/commit/7acc84d))
package/LICENSE CHANGED
@@ -178,7 +178,7 @@
178
178
  APPENDIX: How to apply the Apache License to your work.
179
179
 
180
180
  To apply the Apache License to your work, attach the following
181
- boilerplate notice, with the fields enclosed by brackets "[]"
181
+ boilerplate notice, with the fields enclosed by brackets "{}"
182
182
  replaced with your own identifying information. (Don't include
183
183
  the brackets!) The text should be enclosed in the appropriate
184
184
  comment syntax for the file format. We also recommend that a
@@ -186,7 +186,7 @@
186
186
  same "printed page" as the copyright notice for easier
187
187
  identification within third-party archives.
188
188
 
189
- Copyright 2018 IBM Corp.
189
+ Copyright 2015 IBM Corp.
190
190
 
191
191
  Licensed under the Apache License, Version 2.0 (the "License");
192
192
  you may not use this file except in compliance with the License.
package/README.md CHANGED
@@ -1,19 +1,19 @@
1
1
  # @carbon/layout
2
2
 
3
- > Layout helpers for digital and software products using the Carbon
4
- > Design System
3
+ > Layout helpers for digital and software products using the Carbon Design
4
+ > System
5
5
 
6
6
  ## Getting started
7
7
 
8
- To install `@carbon/layout` in your project, you will need to run the
9
- following command using [npm](https://www.npmjs.com/):
8
+ To install `@carbon/layout` in your project, you will need to run the following
9
+ command using [npm](https://www.npmjs.com/):
10
10
 
11
11
  ```bash
12
12
  npm install -S @carbon/layout
13
13
  ```
14
14
 
15
- If you prefer [Yarn](https://yarnpkg.com/en/), use the following
16
- command instead:
15
+ If you prefer [Yarn](https://yarnpkg.com/en/), use the following command
16
+ instead:
17
17
 
18
18
  ```bash
19
19
  yarn add @carbon/layout
@@ -22,8 +22,8 @@ yarn add @carbon/layout
22
22
  ## Usage
23
23
 
24
24
  `@carbon/layout` provides a couple of useful utilities alongside the
25
- specification for the grid system for the IBM Design Language. This
26
- package includes:
25
+ specification for the grid system for the IBM Design Language. This package
26
+ includes:
27
27
 
28
28
  | Feature | Description |
29
29
  | --------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
@@ -33,21 +33,25 @@ package includes:
33
33
  | Mini unit | Helpers for working in multiples of the mini-unit |
34
34
  | Spacing | Provides a spacing scale and helper for using steps in the scale |
35
35
 
36
- One important thing to remember is that `@carbon/layout` is not
37
- responsible for the grid itself. If you are looking for a grid
38
- implementation to use, definitely checkout the [`@carbon/grid`](../grid)
39
- package.
36
+ One important thing to remember is that `@carbon/layout` is not responsible for
37
+ the grid itself. If you are looking for a grid implementation to use, definitely
38
+ checkout the [`@carbon/grid`](../grid) package.
40
39
 
41
- `@carbon/layout` provides the above features in both Sass and
42
- JavaScript. If you're looking for support in a different language,
43
- feel free to file an issue proposing the new addition!
40
+ `@carbon/layout` provides the above features in both Sass and JavaScript. If
41
+ you're looking for support in a different language, feel free to file an issue
42
+ proposing the new addition!
43
+
44
+ ## 📖 API Documentation
45
+
46
+ If you're looking for `@carbon/layout` API documentation, check out:
47
+
48
+ - [Sass](./docs/sass.md)
44
49
 
45
50
  ## 🙌 Contributing
46
51
 
47
- We're always looking for contributors to help us fix bugs, build new
48
- features, or help us improve the project documentation. If you're
49
- interested, definitely check out our [Contributing Guide](/.github/CONTRIBUTING.md)
50
- ! 👀
52
+ We're always looking for contributors to help us fix bugs, build new features,
53
+ or help us improve the project documentation. If you're interested, definitely
54
+ check out our [Contributing Guide](/.github/CONTRIBUTING.md) ! 👀
51
55
 
52
56
  ## 📝 License
53
57