@carbon/layout 10.16.0 → 10.18.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/docs/sass.md DELETED
@@ -1,1904 +0,0 @@
1
- # Sass API
2
-
3
- | Mark | Description |
4
- | ---- | ---------------------------------------------------------- |
5
- | ✅ | Public functions, mixins, placeholders, and variables |
6
- | ❌ | Private items - not supported outside package's build |
7
- | ⚠️ | Deprecated items - may not be available in future releases |
8
-
9
- <!-- toc -->
10
-
11
- - [@carbon/layout](#carbonlayout)
12
- - [✅carbon--grid-gutter [variable]](#carbon--grid-gutter-variable)
13
- - [✅carbon--grid-gutter--condensed [variable]](#carbon--grid-gutter--condensed-variable)
14
- - [✅carbon--grid-breakpoints [variable]](#carbon--grid-breakpoints-variable)
15
- - [✅carbon--breakpoint-next [function]](#carbon--breakpoint-next-function)
16
- - [✅carbon--breakpoint-prev [function]](#carbon--breakpoint-prev-function)
17
- - [✅carbon--is-smallest-breakpoint [function]](#carbon--is-smallest-breakpoint-function)
18
- - [✅carbon--largest-breakpoint-name [function]](#carbon--largest-breakpoint-name-function)
19
- - [✅carbon--breakpoint-infix [function]](#carbon--breakpoint-infix-function)
20
- - [✅carbon--breakpoint-up [mixin]](#carbon--breakpoint-up-mixin)
21
- - [✅carbon--breakpoint-down [mixin]](#carbon--breakpoint-down-mixin)
22
- - [✅carbon--breakpoint-between [mixin]](#carbon--breakpoint-between-mixin)
23
- - [✅carbon--largest-breakpoint [mixin]](#carbon--largest-breakpoint-mixin)
24
- - [✅carbon--breakpoint [mixin]](#carbon--breakpoint-mixin)
25
- - [✅carbon--container-01 [variable]](#carbon--container-01-variable)
26
- - [✅carbon--container-02 [variable]](#carbon--container-02-variable)
27
- - [✅carbon--container-03 [variable]](#carbon--container-03-variable)
28
- - [✅carbon--container-04 [variable]](#carbon--container-04-variable)
29
- - [✅carbon--container-05 [variable]](#carbon--container-05-variable)
30
- - [✅carbon--container [variable]](#carbon--container-variable)
31
- - [✅container-01 [variable]](#container-01-variable)
32
- - [✅container-02 [variable]](#container-02-variable)
33
- - [✅container-03 [variable]](#container-03-variable)
34
- - [✅container-04 [variable]](#container-04-variable)
35
- - [✅container-05 [variable]](#container-05-variable)
36
- - [✅carbon--base-font-size [variable]](#carbon--base-font-size-variable)
37
- - [✅carbon--rem [function]](#carbon--rem-function)
38
- - [✅carbon--em [function]](#carbon--em-function)
39
- - [✅carbon--fluid-spacing-01 [variable]](#carbon--fluid-spacing-01-variable)
40
- - [✅carbon--fluid-spacing-02 [variable]](#carbon--fluid-spacing-02-variable)
41
- - [✅carbon--fluid-spacing-03 [variable]](#carbon--fluid-spacing-03-variable)
42
- - [✅carbon--fluid-spacing-04 [variable]](#carbon--fluid-spacing-04-variable)
43
- - [✅carbon--fluid-spacing [variable]](#carbon--fluid-spacing-variable)
44
- - [✅fluid-spacing-01 [variable]](#fluid-spacing-01-variable)
45
- - [✅fluid-spacing-02 [variable]](#fluid-spacing-02-variable)
46
- - [✅fluid-spacing-03 [variable]](#fluid-spacing-03-variable)
47
- - [✅fluid-spacing-04 [variable]](#fluid-spacing-04-variable)
48
- - [✅carbon--icon-size-01 [variable]](#carbon--icon-size-01-variable)
49
- - [✅carbon--icon-size-02 [variable]](#carbon--icon-size-02-variable)
50
- - [✅carbon--icon-size [variable]](#carbon--icon-size-variable)
51
- - [✅icon-size-01 [variable]](#icon-size-01-variable)
52
- - [✅icon-size-02 [variable]](#icon-size-02-variable)
53
- - [✅carbon--get-column-width [function]](#carbon--get-column-width-function)
54
- - [✅carbon--key-height-scales [variable]](#carbon--key-height-scales-variable)
55
- - [✅carbon--key-height [function]](#carbon--key-height-function)
56
- - [✅carbon--layout-01 [variable]](#carbon--layout-01-variable)
57
- - [✅carbon--layout-02 [variable]](#carbon--layout-02-variable)
58
- - [✅carbon--layout-03 [variable]](#carbon--layout-03-variable)
59
- - [✅carbon--layout-04 [variable]](#carbon--layout-04-variable)
60
- - [✅carbon--layout-05 [variable]](#carbon--layout-05-variable)
61
- - [✅carbon--layout-06 [variable]](#carbon--layout-06-variable)
62
- - [✅carbon--layout-07 [variable]](#carbon--layout-07-variable)
63
- - [✅carbon--layout [variable]](#carbon--layout-variable)
64
- - [✅layout-01 [variable]](#layout-01-variable)
65
- - [✅layout-02 [variable]](#layout-02-variable)
66
- - [✅layout-03 [variable]](#layout-03-variable)
67
- - [✅layout-04 [variable]](#layout-04-variable)
68
- - [✅layout-05 [variable]](#layout-05-variable)
69
- - [✅layout-06 [variable]](#layout-06-variable)
70
- - [✅layout-07 [variable]](#layout-07-variable)
71
- - [✅carbon--mini-unit-size [variable]](#carbon--mini-unit-size-variable)
72
- - [✅carbon--mini-units [function]](#carbon--mini-units-function)
73
- - [✅carbon--spacing-01 [variable]](#carbon--spacing-01-variable)
74
- - [✅carbon--spacing-02 [variable]](#carbon--spacing-02-variable)
75
- - [✅carbon--spacing-03 [variable]](#carbon--spacing-03-variable)
76
- - [✅carbon--spacing-04 [variable]](#carbon--spacing-04-variable)
77
- - [✅carbon--spacing-05 [variable]](#carbon--spacing-05-variable)
78
- - [✅carbon--spacing-06 [variable]](#carbon--spacing-06-variable)
79
- - [✅carbon--spacing-07 [variable]](#carbon--spacing-07-variable)
80
- - [✅carbon--spacing-08 [variable]](#carbon--spacing-08-variable)
81
- - [✅carbon--spacing-09 [variable]](#carbon--spacing-09-variable)
82
- - [✅carbon--spacing-10 [variable]](#carbon--spacing-10-variable)
83
- - [✅carbon--spacing-11 [variable]](#carbon--spacing-11-variable)
84
- - [✅carbon--spacing-12 [variable]](#carbon--spacing-12-variable)
85
- - [✅carbon--spacing [variable]](#carbon--spacing-variable)
86
- - [✅spacing-01 [variable]](#spacing-01-variable)
87
- - [✅spacing-02 [variable]](#spacing-02-variable)
88
- - [✅spacing-03 [variable]](#spacing-03-variable)
89
- - [✅spacing-04 [variable]](#spacing-04-variable)
90
- - [✅spacing-05 [variable]](#spacing-05-variable)
91
- - [✅spacing-06 [variable]](#spacing-06-variable)
92
- - [✅spacing-07 [variable]](#spacing-07-variable)
93
- - [✅spacing-08 [variable]](#spacing-08-variable)
94
- - [✅spacing-09 [variable]](#spacing-09-variable)
95
- - [✅spacing-10 [variable]](#spacing-10-variable)
96
- - [✅spacing-11 [variable]](#spacing-11-variable)
97
- - [✅spacing-12 [variable]](#spacing-12-variable)
98
- - [✅map-deep-get [function]](#map-deep-get-function)
99
- - [✅carbon--key-by-index [function]](#carbon--key-by-index-function)
100
- - [✅last-map-item [function]](#last-map-item-function)
101
-
102
- <!-- tocstop -->
103
-
104
- ## @carbon/layout
105
-
106
- ### ✅carbon--grid-gutter [variable]
107
-
108
- Carbon gutter size in rem
109
-
110
- <details>
111
- <summary>Source code</summary>
112
-
113
- ```scss
114
- $carbon--grid-gutter: carbon--rem(32px);
115
- ```
116
-
117
- </details>
118
-
119
- - **Group**: [@carbon/layout](#carbonlayout)
120
- - **Type**: `Number`
121
-
122
- ### ✅carbon--grid-gutter--condensed [variable]
123
-
124
- Carbon condensed gutter size in rem
125
-
126
- <details>
127
- <summary>Source code</summary>
128
-
129
- ```scss
130
- $carbon--grid-gutter--condensed: carbon--rem(1px);
131
- ```
132
-
133
- </details>
134
-
135
- - **Group**: [@carbon/layout](#carbonlayout)
136
- - **Type**: `Number`
137
-
138
- ### ✅carbon--grid-breakpoints [variable]
139
-
140
- <details>
141
- <summary>Source code</summary>
142
-
143
- ```scss
144
- $carbon--grid-breakpoints: (
145
- sm: (
146
- columns: 4,
147
- margin: 0,
148
- width: carbon--rem(320px),
149
- ),
150
- md: (
151
- columns: 8,
152
- margin: carbon--rem(16px),
153
- width: carbon--rem(672px),
154
- ),
155
- lg: (
156
- columns: 16,
157
- margin: carbon--rem(16px),
158
- width: carbon--rem(1056px),
159
- ),
160
- xlg: (
161
- columns: 16,
162
- margin: carbon--rem(16px),
163
- width: carbon--rem(1312px),
164
- ),
165
- max: (
166
- columns: 16,
167
- margin: carbon--rem(24px),
168
- width: carbon--rem(1584px),
169
- ),
170
- );
171
- ```
172
-
173
- </details>
174
-
175
- - **Group**: [@carbon/layout](#carbonlayout)
176
- - **Type**: `Map`
177
-
178
- ### ✅carbon--breakpoint-next [function]
179
-
180
- Get the value of the next breakpoint, or null for the last breakpoint
181
-
182
- <details>
183
- <summary>Source code</summary>
184
-
185
- ```scss
186
- @function carbon--breakpoint-next(
187
- $name,
188
- $breakpoints: $carbon--grid-breakpoints,
189
- $breakpoint-names: map-keys($breakpoints)
190
- ) {
191
- $n: index($breakpoint-names, $name);
192
- @if $n != null and $n < length($breakpoint-names) {
193
- @return nth($breakpoint-names, $n + 1);
194
- }
195
- @return null;
196
- }
197
- ```
198
-
199
- </details>
200
-
201
- - **Parameters**:
202
-
203
- | Name | Description | Type | Default value |
204
- | ------------------- | --------------------------------------------------------------------------------------------------------------- | -------- | --------------------------- |
205
- | `$name` | The name of the brekapoint | `String` | — |
206
- | `$breakpoints` | A map of breakpoints where the key is the name of the breakpoint and the value is the values for the breakpoint | `Map` | `$carbon--grid-breakpoints` |
207
- | `$breakpoint-names` | A list of names from the `$breakpoints` map | `List` | `map-keys($breakpoints)` |
208
-
209
- - **Group**: [@carbon/layout](#carbonlayout)
210
- - **Returns**: `String`
211
-
212
- ### ✅carbon--breakpoint-prev [function]
213
-
214
- Get the value of the previous breakpoint, or null for the first breakpoint
215
-
216
- <details>
217
- <summary>Source code</summary>
218
-
219
- ```scss
220
- @function carbon--breakpoint-prev(
221
- $name,
222
- $breakpoints: $carbon--grid-breakpoints,
223
- $breakpoint-names: map-keys($breakpoints)
224
- ) {
225
- $n: index($breakpoint-names, $name);
226
- @if $n != null and $n > 1 {
227
- @return nth($breakpoint-names, $n - 1);
228
- }
229
- @return null;
230
- }
231
- ```
232
-
233
- </details>
234
-
235
- - **Parameters**:
236
-
237
- | Name | Description | Type | Default value |
238
- | ------------------- | --------------------------------------------------------------------------------------------------------------- | -------- | --------------------------- |
239
- | `$name` | The name of the brekapoint | `String` | — |
240
- | `$breakpoints` | A map of breakpoints where the key is the name of the breakpoint and the value is the values for the breakpoint | `Map` | `$carbon--grid-breakpoints` |
241
- | `$breakpoint-names` | A list of names from the `$breakpoints` map | `List` | `map-keys($breakpoints)` |
242
-
243
- - **Group**: [@carbon/layout](#carbonlayout)
244
- - **Returns**: `String`
245
-
246
- ### ✅carbon--is-smallest-breakpoint [function]
247
-
248
- Check to see if the given breakpoint name
249
-
250
- <details>
251
- <summary>Source code</summary>
252
-
253
- ```scss
254
- @function carbon--is-smallest-breakpoint(
255
- $name,
256
- $breakpoints: $carbon--grid-breakpoints
257
- ) {
258
- @return index(map-keys($breakpoints), $name) == 1;
259
- }
260
- ```
261
-
262
- </details>
263
-
264
- - **Parameters**:
265
-
266
- | Name | Description | Type | Default value |
267
- | -------------- | --------------------------------------------------------------------------------------------------------------- | -------- | --------------------------- |
268
- | `$name` | The name of the brekapoint | `String` | — |
269
- | `$breakpoints` | A map of breakpoints where the key is the name of the breakpoint and the value is the values for the breakpoint | `Map` | `$carbon--grid-breakpoints` |
270
-
271
- - **Group**: [@carbon/layout](#carbonlayout)
272
- - **Returns**: `Bool`
273
- - **Used by**:
274
- - [carbon--breakpoint-up [mixin]](#carbon--breakpoint-up-mixin)
275
-
276
- ### ✅carbon--largest-breakpoint-name [function]
277
-
278
- Returns the largest breakpoint name
279
-
280
- <details>
281
- <summary>Source code</summary>
282
-
283
- ```scss
284
- @function carbon--largest-breakpoint-name(
285
- $breakpoints: $carbon--grid-breakpoints
286
- ) {
287
- $total-breakpoints: length($breakpoints);
288
- @return carbon--key-by-index($breakpoints, $total-breakpoints);
289
- }
290
- ```
291
-
292
- </details>
293
-
294
- - **Parameters**:
295
-
296
- | Name | Description | Type | Default value |
297
- | -------------- | ---------------------------------------------- | ----- | --------------------------- |
298
- | `$breakpoints` | A map of breakpoints where the key is the name | `Map` | `$carbon--grid-breakpoints` |
299
-
300
- - **Group**: [@carbon/layout](#carbonlayout)
301
- - **Returns**: `String`
302
- - **Requires**:
303
- - [carbon--key-by-index [function]](#carbon--key-by-index-function)
304
- - **Used by**:
305
- - [carbon--largest-breakpoint [mixin]](#carbon--largest-breakpoint-mixin)
306
-
307
- ### ✅carbon--breakpoint-infix [function]
308
-
309
- Get the infix for a given breakpoint in a list of breakpoints. Usesful for
310
- generate the size part in a selector, for example: `.prefix--col-sm-2`.
311
-
312
- <details>
313
- <summary>Source code</summary>
314
-
315
- ```scss
316
- @function carbon--breakpoint-infix($name) {
317
- @return '-#{$name}';
318
- }
319
- ```
320
-
321
- </details>
322
-
323
- - **Parameters**:
324
-
325
- | Name | Description | Type | Default value |
326
- | ------- | -------------------------- | -------- | ------------- |
327
- | `$name` | The name of the breakpoint | `String` | — |
328
-
329
- - **Group**: [@carbon/layout](#carbonlayout)
330
- - **Returns**: `String`
331
-
332
- ### ✅carbon--breakpoint-up [mixin]
333
-
334
- Generate a media query from the width of the given breakpoint to infinity
335
-
336
- <details>
337
- <summary>Source code</summary>
338
-
339
- ```scss
340
- @mixin carbon--breakpoint-up($name, $breakpoints: $carbon--grid-breakpoints) {
341
- @if type-of($name) == 'number' {
342
- @media (min-width: $name) {
343
- @content;
344
- }
345
- } @else if map-has-key($breakpoints, $name) {
346
- $breakpoint: map-get($breakpoints, $name);
347
- $width: map-get($breakpoint, width);
348
- @if carbon--is-smallest-breakpoint($name, $breakpoints) {
349
- @content;
350
- } @else {
351
- @media (min-width: $width) {
352
- @content;
353
- }
354
- }
355
- } @else {
356
- @error 'Unable to find a breakpoint with name `#{$name}`. Expected one of: (#{map-keys($breakpoints)})';
357
- }
358
- }
359
- ```
360
-
361
- </details>
362
-
363
- - **Parameters**:
364
-
365
- | Name | Description | Type | Default value |
366
- | -------------- | ---------------------------------------------- | ------------------ | --------------------------- |
367
- | `$name` | — | `String \| Number` | — |
368
- | `$breakpoints` | A map of breakpoints where the key is the name | `Map` | `$carbon--grid-breakpoints` |
369
-
370
- - **Group**: [@carbon/layout](#carbonlayout)
371
- - **Requires**:
372
- - [carbon--is-smallest-breakpoint [function]](#carbon--is-smallest-breakpoint-function)
373
- - **Used by**:
374
- - [carbon--breakpoint-between [mixin]](#carbon--breakpoint-between-mixin)
375
- - [carbon--breakpoint [mixin]](#carbon--breakpoint-mixin)
376
-
377
- ### ✅carbon--breakpoint-down [mixin]
378
-
379
- Generate a media query for the maximum width of the given styles
380
-
381
- <details>
382
- <summary>Source code</summary>
383
-
384
- ```scss
385
- @mixin carbon--breakpoint-down($name, $breakpoints: $carbon--grid-breakpoints) {
386
- @if type-of($name) == 'number' {
387
- @media (max-width: $name) {
388
- @content;
389
- }
390
- } @else if map-has-key($breakpoints, $name) {
391
- // We borrow this logic from bootstrap for specifying the value of the
392
- // max-width. The maximum width is calculated by finding the breakpoint and
393
- // subtracting .02 from its value. This value is used instead of .01 to
394
- // avoid rounding issues in Safari
395
- // https://github.com/twbs/bootstrap/blob/c5b1919deaf5393fcca9e9b9d7ce9c338160d99d/scss/mixins/_breakpoints.scss#L34-L46
396
- $breakpoint: map-get($breakpoints, $name);
397
- $width: map-get($breakpoint, width) - 0.02;
398
- @media (max-width: $width) {
399
- @content;
400
- }
401
- } @else {
402
- @error 'Unable to find a breakpoint with name `#{$name}`. Expected one of: (#{map-keys($breakpoints)})';
403
- }
404
- }
405
- ```
406
-
407
- </details>
408
-
409
- - **Parameters**:
410
-
411
- | Name | Description | Type | Default value |
412
- | -------------- | ---------------------------------------------- | ------------------ | --------------------------- |
413
- | `$name` | — | `String \| Number` | — |
414
- | `$breakpoints` | A map of breakpoints where the key is the name | `Map` | `$carbon--grid-breakpoints` |
415
-
416
- - **Group**: [@carbon/layout](#carbonlayout)
417
- - **Used by**:
418
- - [carbon--breakpoint-between [mixin]](#carbon--breakpoint-between-mixin)
419
-
420
- ### ✅carbon--breakpoint-between [mixin]
421
-
422
- Generate a media query for the range between the lower and upper breakpoints
423
-
424
- <details>
425
- <summary>Source code</summary>
426
-
427
- ```scss
428
- @mixin carbon--breakpoint-between(
429
- $lower,
430
- $upper,
431
- $breakpoints: $carbon--grid-breakpoints
432
- ) {
433
- $is-number-lower: type-of($lower) == 'number';
434
- $is-number-upper: type-of($upper) == 'number';
435
- $min: if($is-number-lower, $lower, map-get($breakpoints, $lower));
436
- $max: if($is-number-upper, $upper, map-get($breakpoints, $upper));
437
-
438
- @if $min and $max {
439
- $min-width: if(not $is-number-lower and $min, map-get($min, width), $min);
440
- $max-width: if(not $is-number-upper and $max, map-get($max, width), $max);
441
- @media (min-width: $min-width) and (max-width: $max-width) {
442
- @content;
443
- }
444
- } @else if $min != null and $max == null {
445
- @include carbon--breakpoint-up($lower) {
446
- @content;
447
- }
448
- } @else if $min == null and $max != null {
449
- @include carbon--breakpoint-down($upper) {
450
- @content;
451
- }
452
- } @else {
453
- @error 'Unable to find a breakpoint to satisfy: (#{$lower},#{$upper}). Expected both to be one of (#{map-keys($breakpoints)}).';
454
- }
455
- }
456
- ```
457
-
458
- </details>
459
-
460
- - **Parameters**:
461
-
462
- | Name | Description | Type | Default value |
463
- | -------------- | ---------------------------------------------- | ------------------ | --------------------------- |
464
- | `$lower` | — | `String \| Number` | — |
465
- | `$upper` | — | `String \| Number` | — |
466
- | `$breakpoints` | A map of breakpoints where the key is the name | `Map` | `$carbon--grid-breakpoints` |
467
-
468
- - **Group**: [@carbon/layout](#carbonlayout)
469
- - **Requires**:
470
- - [carbon--breakpoint-up [mixin]](#carbon--breakpoint-up-mixin)
471
- - [carbon--breakpoint-down [mixin]](#carbon--breakpoint-down-mixin)
472
-
473
- ### ✅carbon--largest-breakpoint [mixin]
474
-
475
- Generate media query for the largest breakpoint
476
-
477
- <details>
478
- <summary>Source code</summary>
479
-
480
- ```scss
481
- @mixin carbon--largest-breakpoint($breakpoints: $carbon--grid-breakpoints) {
482
- @include carbon--breakpoint(carbon--largest-breakpoint-name()) {
483
- @content;
484
- }
485
- }
486
- ```
487
-
488
- </details>
489
-
490
- - **Parameters**:
491
-
492
- | Name | Description | Type | Default value |
493
- | -------------- | ---------------------------------------------- | ----- | --------------------------- |
494
- | `$breakpoints` | A map of breakpoints where the key is the name | `Map` | `$carbon--grid-breakpoints` |
495
-
496
- - **Group**: [@carbon/layout](#carbonlayout)
497
- - **Requires**:
498
- - [carbon--breakpoint [mixin]](#carbon--breakpoint-mixin)
499
- - [carbon--largest-breakpoint-name [function]](#carbon--largest-breakpoint-name-function)
500
-
501
- ### ✅carbon--breakpoint [mixin]
502
-
503
- Generate a media query for a given breakpoint
504
-
505
- <details>
506
- <summary>Source code</summary>
507
-
508
- ```scss
509
- @mixin carbon--breakpoint($name, $breakpoints: $carbon--grid-breakpoints) {
510
- @include carbon--breakpoint-up($name, $breakpoints) {
511
- @content;
512
- }
513
- }
514
- ```
515
-
516
- </details>
517
-
518
- - **Parameters**:
519
-
520
- | Name | Description | Type | Default value |
521
- | -------------- | ---------------------------------------------- | ------------------ | --------------------------- |
522
- | `$name` | — | `String \| Number` | — |
523
- | `$breakpoints` | A map of breakpoints where the key is the name | `Map` | `$carbon--grid-breakpoints` |
524
-
525
- - **Group**: [@carbon/layout](#carbonlayout)
526
- - **Requires**:
527
- - [carbon--breakpoint-up [mixin]](#carbon--breakpoint-up-mixin)
528
- - **Used by**:
529
- - [carbon--largest-breakpoint [mixin]](#carbon--largest-breakpoint-mixin)
530
-
531
- ### ✅carbon--container-01 [variable]
532
-
533
- <details>
534
- <summary>Source code</summary>
535
-
536
- ```scss
537
- $carbon--container-01: 1.5rem;
538
- ```
539
-
540
- </details>
541
-
542
- - **Group**: [@carbon/layout](#carbonlayout)
543
- - **Type**: `Number`
544
- - **Aliased**:
545
- - `container-01`
546
-
547
- ### ✅carbon--container-02 [variable]
548
-
549
- <details>
550
- <summary>Source code</summary>
551
-
552
- ```scss
553
- $carbon--container-02: 2rem;
554
- ```
555
-
556
- </details>
557
-
558
- - **Group**: [@carbon/layout](#carbonlayout)
559
- - **Type**: `Number`
560
- - **Aliased**:
561
- - `container-02`
562
-
563
- ### ✅carbon--container-03 [variable]
564
-
565
- <details>
566
- <summary>Source code</summary>
567
-
568
- ```scss
569
- $carbon--container-03: 2.5rem;
570
- ```
571
-
572
- </details>
573
-
574
- - **Group**: [@carbon/layout](#carbonlayout)
575
- - **Type**: `Number`
576
- - **Aliased**:
577
- - `container-03`
578
-
579
- ### ✅carbon--container-04 [variable]
580
-
581
- <details>
582
- <summary>Source code</summary>
583
-
584
- ```scss
585
- $carbon--container-04: 3rem;
586
- ```
587
-
588
- </details>
589
-
590
- - **Group**: [@carbon/layout](#carbonlayout)
591
- - **Type**: `Number`
592
- - **Aliased**:
593
- - `container-04`
594
-
595
- ### ✅carbon--container-05 [variable]
596
-
597
- <details>
598
- <summary>Source code</summary>
599
-
600
- ```scss
601
- $carbon--container-05: 4rem;
602
- ```
603
-
604
- </details>
605
-
606
- - **Group**: [@carbon/layout](#carbonlayout)
607
- - **Type**: `Number`
608
- - **Aliased**:
609
- - `container-05`
610
-
611
- ### ✅carbon--container [variable]
612
-
613
- <details>
614
- <summary>Source code</summary>
615
-
616
- ```scss
617
- $carbon--container: (
618
- $carbon--container-01,
619
- $carbon--container-02,
620
- $carbon--container-03,
621
- $carbon--container-04,
622
- $carbon--container-05
623
- );
624
- ```
625
-
626
- </details>
627
-
628
- - **Group**: [@carbon/layout](#carbonlayout)
629
- - **Type**: `List`
630
-
631
- ### ✅container-01 [variable]
632
-
633
- <details>
634
- <summary>Source code</summary>
635
-
636
- ```scss
637
- $container-01: $carbon--container-01;
638
- ```
639
-
640
- </details>
641
-
642
- - **Group**: [@carbon/layout](#carbonlayout)
643
- - **Type**: `Number`
644
- - **Alias**: `carbon--container-01`
645
-
646
- ### ✅container-02 [variable]
647
-
648
- <details>
649
- <summary>Source code</summary>
650
-
651
- ```scss
652
- $container-02: $carbon--container-02;
653
- ```
654
-
655
- </details>
656
-
657
- - **Group**: [@carbon/layout](#carbonlayout)
658
- - **Type**: `Number`
659
- - **Alias**: `carbon--container-02`
660
-
661
- ### ✅container-03 [variable]
662
-
663
- <details>
664
- <summary>Source code</summary>
665
-
666
- ```scss
667
- $container-03: $carbon--container-03;
668
- ```
669
-
670
- </details>
671
-
672
- - **Group**: [@carbon/layout](#carbonlayout)
673
- - **Type**: `Number`
674
- - **Alias**: `carbon--container-03`
675
-
676
- ### ✅container-04 [variable]
677
-
678
- <details>
679
- <summary>Source code</summary>
680
-
681
- ```scss
682
- $container-04: $carbon--container-04;
683
- ```
684
-
685
- </details>
686
-
687
- - **Group**: [@carbon/layout](#carbonlayout)
688
- - **Type**: `Number`
689
- - **Alias**: `carbon--container-04`
690
-
691
- ### ✅container-05 [variable]
692
-
693
- <details>
694
- <summary>Source code</summary>
695
-
696
- ```scss
697
- $container-05: $carbon--container-05;
698
- ```
699
-
700
- </details>
701
-
702
- - **Group**: [@carbon/layout](#carbonlayout)
703
- - **Type**: `Number`
704
- - **Alias**: `carbon--container-05`
705
-
706
- ### ✅carbon--base-font-size [variable]
707
-
708
- Default font size
709
-
710
- <details>
711
- <summary>Source code</summary>
712
-
713
- ```scss
714
- $carbon--base-font-size: 16px;
715
- ```
716
-
717
- </details>
718
-
719
- - **Group**: [@carbon/layout](#carbonlayout)
720
- - **Type**: `Number`
721
- - **Used by**:
722
- - [carbon--rem [function]](#carbon--rem-function)
723
- - [carbon--em [function]](#carbon--em-function)
724
-
725
- ### ✅carbon--rem [function]
726
-
727
- Convert a given px unit to a rem unit
728
-
729
- <details>
730
- <summary>Source code</summary>
731
-
732
- ```scss
733
- @function carbon--rem($px) {
734
- @if unit($px) != 'px' {
735
- // TODO: update to @error in v11
736
- @warn "Expected argument $px to be of type `px`, instead received: `#{unit($px)}`";
737
- }
738
-
739
- @return ($px / $carbon--base-font-size) * 1rem;
740
- }
741
- ```
742
-
743
- </details>
744
-
745
- - **Parameters**:
746
-
747
- | Name | Description | Type | Default value |
748
- | ----- | ------------------- | -------- | ------------- |
749
- | `$px` | Number with px unit | `Number` | — |
750
-
751
- - **Group**: [@carbon/layout](#carbonlayout)
752
- - **Returns**: `Number` Number with rem unit
753
- - **Requires**:
754
- - [carbon--base-font-size [variable]](#carbon--base-font-size-variable)
755
- - **Used by**:
756
- - [carbon--mini-units [function]](#carbon--mini-units-function)
757
-
758
- ### ✅carbon--em [function]
759
-
760
- Convert a given px unit to a em unit
761
-
762
- <details>
763
- <summary>Source code</summary>
764
-
765
- ```scss
766
- @function carbon--em($px) {
767
- @if unit($px) != 'px' {
768
- // TODO: update to @error in v11
769
- @warn "Expected argument $px to be of type `px`, instead received: `#{unit($px)}`";
770
- }
771
-
772
- @return ($px / $carbon--base-font-size) * 1em;
773
- }
774
- ```
775
-
776
- </details>
777
-
778
- - **Parameters**:
779
-
780
- | Name | Description | Type | Default value |
781
- | ----- | ------------------- | -------- | ------------- |
782
- | `$px` | Number with px unit | `Number` | — |
783
-
784
- - **Group**: [@carbon/layout](#carbonlayout)
785
- - **Returns**: `Number` Number with em unit
786
- - **Requires**:
787
- - [carbon--base-font-size [variable]](#carbon--base-font-size-variable)
788
-
789
- ### ✅carbon--fluid-spacing-01 [variable]
790
-
791
- <details>
792
- <summary>Source code</summary>
793
-
794
- ```scss
795
- $carbon--fluid-spacing-01: 0;
796
- ```
797
-
798
- </details>
799
-
800
- - **Group**: [@carbon/layout](#carbonlayout)
801
- - **Type**: `Number`
802
- - **Aliased**:
803
- - `fluid-spacing-01`
804
-
805
- ### ✅carbon--fluid-spacing-02 [variable]
806
-
807
- <details>
808
- <summary>Source code</summary>
809
-
810
- ```scss
811
- $carbon--fluid-spacing-02: 2vw;
812
- ```
813
-
814
- </details>
815
-
816
- - **Group**: [@carbon/layout](#carbonlayout)
817
- - **Type**: `Number`
818
- - **Aliased**:
819
- - `fluid-spacing-02`
820
-
821
- ### ✅carbon--fluid-spacing-03 [variable]
822
-
823
- <details>
824
- <summary>Source code</summary>
825
-
826
- ```scss
827
- $carbon--fluid-spacing-03: 5vw;
828
- ```
829
-
830
- </details>
831
-
832
- - **Group**: [@carbon/layout](#carbonlayout)
833
- - **Type**: `Number`
834
- - **Aliased**:
835
- - `fluid-spacing-03`
836
-
837
- ### ✅carbon--fluid-spacing-04 [variable]
838
-
839
- <details>
840
- <summary>Source code</summary>
841
-
842
- ```scss
843
- $carbon--fluid-spacing-04: 10vw;
844
- ```
845
-
846
- </details>
847
-
848
- - **Group**: [@carbon/layout](#carbonlayout)
849
- - **Type**: `Number`
850
- - **Aliased**:
851
- - `fluid-spacing-04`
852
-
853
- ### ✅carbon--fluid-spacing [variable]
854
-
855
- <details>
856
- <summary>Source code</summary>
857
-
858
- ```scss
859
- $carbon--fluid-spacing: (
860
- $carbon--fluid-spacing-01,
861
- $carbon--fluid-spacing-02,
862
- $carbon--fluid-spacing-03,
863
- $carbon--fluid-spacing-04
864
- );
865
- ```
866
-
867
- </details>
868
-
869
- - **Group**: [@carbon/layout](#carbonlayout)
870
- - **Type**: `List`
871
-
872
- ### ✅fluid-spacing-01 [variable]
873
-
874
- <details>
875
- <summary>Source code</summary>
876
-
877
- ```scss
878
- $fluid-spacing-01: $carbon--fluid-spacing-01;
879
- ```
880
-
881
- </details>
882
-
883
- - **Group**: [@carbon/layout](#carbonlayout)
884
- - **Type**: `Number`
885
- - **Alias**: `carbon--fluid-spacing-01`
886
-
887
- ### ✅fluid-spacing-02 [variable]
888
-
889
- <details>
890
- <summary>Source code</summary>
891
-
892
- ```scss
893
- $fluid-spacing-02: $carbon--fluid-spacing-02;
894
- ```
895
-
896
- </details>
897
-
898
- - **Group**: [@carbon/layout](#carbonlayout)
899
- - **Type**: `Number`
900
- - **Alias**: `carbon--fluid-spacing-02`
901
-
902
- ### ✅fluid-spacing-03 [variable]
903
-
904
- <details>
905
- <summary>Source code</summary>
906
-
907
- ```scss
908
- $fluid-spacing-03: $carbon--fluid-spacing-03;
909
- ```
910
-
911
- </details>
912
-
913
- - **Group**: [@carbon/layout](#carbonlayout)
914
- - **Type**: `Number`
915
- - **Alias**: `carbon--fluid-spacing-03`
916
-
917
- ### ✅fluid-spacing-04 [variable]
918
-
919
- <details>
920
- <summary>Source code</summary>
921
-
922
- ```scss
923
- $fluid-spacing-04: $carbon--fluid-spacing-04;
924
- ```
925
-
926
- </details>
927
-
928
- - **Group**: [@carbon/layout](#carbonlayout)
929
- - **Type**: `Number`
930
- - **Alias**: `carbon--fluid-spacing-04`
931
-
932
- ### ✅carbon--icon-size-01 [variable]
933
-
934
- <details>
935
- <summary>Source code</summary>
936
-
937
- ```scss
938
- $carbon--icon-size-01: 1rem;
939
- ```
940
-
941
- </details>
942
-
943
- - **Group**: [@carbon/layout](#carbonlayout)
944
- - **Type**: `Number`
945
- - **Aliased**:
946
- - `icon-size-01`
947
-
948
- ### ✅carbon--icon-size-02 [variable]
949
-
950
- <details>
951
- <summary>Source code</summary>
952
-
953
- ```scss
954
- $carbon--icon-size-02: 1.25rem;
955
- ```
956
-
957
- </details>
958
-
959
- - **Group**: [@carbon/layout](#carbonlayout)
960
- - **Type**: `Number`
961
- - **Aliased**:
962
- - `icon-size-02`
963
-
964
- ### ✅carbon--icon-size [variable]
965
-
966
- <details>
967
- <summary>Source code</summary>
968
-
969
- ```scss
970
- $carbon--icon-size: ($carbon--icon-size-01, $carbon--icon-size-02);
971
- ```
972
-
973
- </details>
974
-
975
- - **Group**: [@carbon/layout](#carbonlayout)
976
- - **Type**: `List`
977
-
978
- ### ✅icon-size-01 [variable]
979
-
980
- <details>
981
- <summary>Source code</summary>
982
-
983
- ```scss
984
- $icon-size-01: $carbon--icon-size-01;
985
- ```
986
-
987
- </details>
988
-
989
- - **Group**: [@carbon/layout](#carbonlayout)
990
- - **Type**: `Number`
991
- - **Alias**: `carbon--icon-size-01`
992
-
993
- ### ✅icon-size-02 [variable]
994
-
995
- <details>
996
- <summary>Source code</summary>
997
-
998
- ```scss
999
- $icon-size-02: $carbon--icon-size-02;
1000
- ```
1001
-
1002
- </details>
1003
-
1004
- - **Group**: [@carbon/layout](#carbonlayout)
1005
- - **Type**: `Number`
1006
- - **Alias**: `carbon--icon-size-02`
1007
-
1008
- ### ✅carbon--get-column-width [function]
1009
-
1010
- Get the column width for a given breakpoint
1011
-
1012
- <details>
1013
- <summary>Source code</summary>
1014
-
1015
- ```scss
1016
- @function carbon--get-column-width(
1017
- $breakpoint,
1018
- $breakpoints: $carbon--grid-breakpoints
1019
- ) {
1020
- @if map-has-key($breakpoints, $breakpoint) {
1021
- $values: map-get($breakpoints, $breakpoint);
1022
- $width: map-get($values, width);
1023
- $margin: map-get($values, margin);
1024
- $columns: map-get($values, columns);
1025
-
1026
- @return ($width - (2 * $margin)) / $columns;
1027
- } @else {
1028
- @warn 'Breakpoint: `#{$breakpoint}` is not a valid breakpoint.';
1029
- }
1030
- }
1031
- ```
1032
-
1033
- </details>
1034
-
1035
- - **Parameters**:
1036
-
1037
- | Name | Description | Type | Default value |
1038
- | -------------- | ----------- | -------- | --------------------------- |
1039
- | `$breakpoint` | — | `String` | — |
1040
- | `$breakpoints` | — | `Map` | `$carbon--grid-breakpoints` |
1041
-
1042
- - **Group**: [@carbon/layout](#carbonlayout)
1043
- - **Returns**: `Number` In rem
1044
-
1045
- ### ✅carbon--key-height-scales [variable]
1046
-
1047
- <details>
1048
- <summary>Source code</summary>
1049
-
1050
- ```scss
1051
- $carbon--key-height-scales: (
1052
- sm: (
1053
- carbon--get-column-width(sm),
1054
- carbon--get-column-width(sm) * 2,
1055
- carbon--get-column-width(sm) * 3,
1056
- carbon--get-column-width(sm) * 4,
1057
- carbon--get-column-width(sm) * 5,
1058
- carbon--get-column-width(sm) * 6,
1059
- ),
1060
- md: (
1061
- carbon--get-column-width(md),
1062
- carbon--get-column-width(md) * 2,
1063
- carbon--get-column-width(md) * 3,
1064
- carbon--get-column-width(md) * 4,
1065
- carbon--get-column-width(md) * 5,
1066
- carbon--get-column-width(md) * 6,
1067
- ),
1068
- lg: (
1069
- carbon--get-column-width(lg),
1070
- carbon--get-column-width(lg) * 2,
1071
- carbon--get-column-width(lg) * 3,
1072
- carbon--get-column-width(lg) * 4,
1073
- carbon--get-column-width(lg) * 5,
1074
- carbon--get-column-width(lg) * 6,
1075
- carbon--get-column-width(lg) * 7,
1076
- carbon--get-column-width(lg) * 8,
1077
- ),
1078
- xlg: (
1079
- carbon--get-column-width(xlg),
1080
- carbon--get-column-width(xlg) * 2,
1081
- carbon--get-column-width(xlg) * 3,
1082
- carbon--get-column-width(xlg) * 4,
1083
- carbon--get-column-width(xlg) * 5,
1084
- carbon--get-column-width(xlg) * 6,
1085
- carbon--get-column-width(xlg) * 7,
1086
- carbon--get-column-width(xlg) * 8,
1087
- ),
1088
- max: (
1089
- carbon--get-column-width(max),
1090
- carbon--get-column-width(max) * 2,
1091
- carbon--get-column-width(max) * 3,
1092
- carbon--get-column-width(max) * 4,
1093
- carbon--get-column-width(max) * 5,
1094
- carbon--get-column-width(max) * 6,
1095
- carbon--get-column-width(max) * 7,
1096
- carbon--get-column-width(max) * 8,
1097
- ),
1098
- );
1099
- ```
1100
-
1101
- </details>
1102
-
1103
- - **Group**: [@carbon/layout](#carbonlayout)
1104
- - **Type**: `Map`
1105
- - **Used by**:
1106
- - [carbon--key-height [function]](#carbon--key-height-function)
1107
-
1108
- ### ✅carbon--key-height [function]
1109
-
1110
- Get the value of a key height step at a given breakpoint
1111
-
1112
- <details>
1113
- <summary>Source code</summary>
1114
-
1115
- ```scss
1116
- @function carbon--key-height($breakpoint, $step) {
1117
- @if map-has-key($carbon--key-height-scales, $breakpoint) {
1118
- @return nth(map-get($carbon--key-height-scales, $breakpoint), $step);
1119
- } @else {
1120
- @warn 'Breakpoint: `#{$breakpoint}` is not a valid breakpoint.';
1121
- }
1122
- }
1123
- ```
1124
-
1125
- </details>
1126
-
1127
- - **Parameters**:
1128
-
1129
- | Name | Description | Type | Default value |
1130
- | ------------- | ----------- | -------- | ------------- |
1131
- | `$breakpoint` | — | `String` | — |
1132
- | `$step` | — | `Number` | — |
1133
-
1134
- - **Group**: [@carbon/layout](#carbonlayout)
1135
- - **Returns**: `Number` In rem
1136
- - **Requires**:
1137
- - [carbon--key-height-scales [variable]](#carbon--key-height-scales-variable)
1138
-
1139
- ### ✅carbon--layout-01 [variable]
1140
-
1141
- <details>
1142
- <summary>Source code</summary>
1143
-
1144
- ```scss
1145
- $carbon--layout-01: 1rem;
1146
- ```
1147
-
1148
- </details>
1149
-
1150
- - **Group**: [@carbon/layout](#carbonlayout)
1151
- - **Type**: `Number`
1152
- - **Aliased**:
1153
- - `layout-01`
1154
-
1155
- ### ✅carbon--layout-02 [variable]
1156
-
1157
- <details>
1158
- <summary>Source code</summary>
1159
-
1160
- ```scss
1161
- $carbon--layout-02: 1.5rem;
1162
- ```
1163
-
1164
- </details>
1165
-
1166
- - **Group**: [@carbon/layout](#carbonlayout)
1167
- - **Type**: `Number`
1168
- - **Aliased**:
1169
- - `layout-02`
1170
-
1171
- ### ✅carbon--layout-03 [variable]
1172
-
1173
- <details>
1174
- <summary>Source code</summary>
1175
-
1176
- ```scss
1177
- $carbon--layout-03: 2rem;
1178
- ```
1179
-
1180
- </details>
1181
-
1182
- - **Group**: [@carbon/layout](#carbonlayout)
1183
- - **Type**: `Number`
1184
- - **Aliased**:
1185
- - `layout-03`
1186
-
1187
- ### ✅carbon--layout-04 [variable]
1188
-
1189
- <details>
1190
- <summary>Source code</summary>
1191
-
1192
- ```scss
1193
- $carbon--layout-04: 3rem;
1194
- ```
1195
-
1196
- </details>
1197
-
1198
- - **Group**: [@carbon/layout](#carbonlayout)
1199
- - **Type**: `Number`
1200
- - **Aliased**:
1201
- - `layout-04`
1202
-
1203
- ### ✅carbon--layout-05 [variable]
1204
-
1205
- <details>
1206
- <summary>Source code</summary>
1207
-
1208
- ```scss
1209
- $carbon--layout-05: 4rem;
1210
- ```
1211
-
1212
- </details>
1213
-
1214
- - **Group**: [@carbon/layout](#carbonlayout)
1215
- - **Type**: `Number`
1216
- - **Aliased**:
1217
- - `layout-05`
1218
-
1219
- ### ✅carbon--layout-06 [variable]
1220
-
1221
- <details>
1222
- <summary>Source code</summary>
1223
-
1224
- ```scss
1225
- $carbon--layout-06: 6rem;
1226
- ```
1227
-
1228
- </details>
1229
-
1230
- - **Group**: [@carbon/layout](#carbonlayout)
1231
- - **Type**: `Number`
1232
- - **Aliased**:
1233
- - `layout-06`
1234
-
1235
- ### ✅carbon--layout-07 [variable]
1236
-
1237
- <details>
1238
- <summary>Source code</summary>
1239
-
1240
- ```scss
1241
- $carbon--layout-07: 10rem;
1242
- ```
1243
-
1244
- </details>
1245
-
1246
- - **Group**: [@carbon/layout](#carbonlayout)
1247
- - **Type**: `Number`
1248
- - **Aliased**:
1249
- - `layout-07`
1250
-
1251
- ### ✅carbon--layout [variable]
1252
-
1253
- <details>
1254
- <summary>Source code</summary>
1255
-
1256
- ```scss
1257
- $carbon--layout: (
1258
- $carbon--layout-01,
1259
- $carbon--layout-02,
1260
- $carbon--layout-03,
1261
- $carbon--layout-04,
1262
- $carbon--layout-05,
1263
- $carbon--layout-06,
1264
- $carbon--layout-07
1265
- );
1266
- ```
1267
-
1268
- </details>
1269
-
1270
- - **Group**: [@carbon/layout](#carbonlayout)
1271
- - **Type**: `List`
1272
-
1273
- ### ✅layout-01 [variable]
1274
-
1275
- <details>
1276
- <summary>Source code</summary>
1277
-
1278
- ```scss
1279
- $layout-01: $carbon--layout-01;
1280
- ```
1281
-
1282
- </details>
1283
-
1284
- - **Group**: [@carbon/layout](#carbonlayout)
1285
- - **Type**: `Number`
1286
- - **Alias**: `carbon--layout-01`
1287
-
1288
- ### ✅layout-02 [variable]
1289
-
1290
- <details>
1291
- <summary>Source code</summary>
1292
-
1293
- ```scss
1294
- $layout-02: $carbon--layout-02;
1295
- ```
1296
-
1297
- </details>
1298
-
1299
- - **Group**: [@carbon/layout](#carbonlayout)
1300
- - **Type**: `Number`
1301
- - **Alias**: `carbon--layout-02`
1302
-
1303
- ### ✅layout-03 [variable]
1304
-
1305
- <details>
1306
- <summary>Source code</summary>
1307
-
1308
- ```scss
1309
- $layout-03: $carbon--layout-03;
1310
- ```
1311
-
1312
- </details>
1313
-
1314
- - **Group**: [@carbon/layout](#carbonlayout)
1315
- - **Type**: `Number`
1316
- - **Alias**: `carbon--layout-03`
1317
-
1318
- ### ✅layout-04 [variable]
1319
-
1320
- <details>
1321
- <summary>Source code</summary>
1322
-
1323
- ```scss
1324
- $layout-04: $carbon--layout-04;
1325
- ```
1326
-
1327
- </details>
1328
-
1329
- - **Group**: [@carbon/layout](#carbonlayout)
1330
- - **Type**: `Number`
1331
- - **Alias**: `carbon--layout-04`
1332
-
1333
- ### ✅layout-05 [variable]
1334
-
1335
- <details>
1336
- <summary>Source code</summary>
1337
-
1338
- ```scss
1339
- $layout-05: $carbon--layout-05;
1340
- ```
1341
-
1342
- </details>
1343
-
1344
- - **Group**: [@carbon/layout](#carbonlayout)
1345
- - **Type**: `Number`
1346
- - **Alias**: `carbon--layout-05`
1347
-
1348
- ### ✅layout-06 [variable]
1349
-
1350
- <details>
1351
- <summary>Source code</summary>
1352
-
1353
- ```scss
1354
- $layout-06: $carbon--layout-06;
1355
- ```
1356
-
1357
- </details>
1358
-
1359
- - **Group**: [@carbon/layout](#carbonlayout)
1360
- - **Type**: `Number`
1361
- - **Alias**: `carbon--layout-06`
1362
-
1363
- ### ✅layout-07 [variable]
1364
-
1365
- <details>
1366
- <summary>Source code</summary>
1367
-
1368
- ```scss
1369
- $layout-07: $carbon--layout-07;
1370
- ```
1371
-
1372
- </details>
1373
-
1374
- - **Group**: [@carbon/layout](#carbonlayout)
1375
- - **Type**: `Number`
1376
- - **Alias**: `carbon--layout-07`
1377
-
1378
- ### ✅carbon--mini-unit-size [variable]
1379
-
1380
- Default mini-unit value
1381
-
1382
- <details>
1383
- <summary>Source code</summary>
1384
-
1385
- ```scss
1386
- $carbon--mini-unit-size: 8px;
1387
- ```
1388
-
1389
- </details>
1390
-
1391
- - **Group**: [@carbon/layout](#carbonlayout)
1392
- - **Type**: `Number`
1393
- - **Used by**:
1394
- - [carbon--mini-units [function]](#carbon--mini-units-function)
1395
-
1396
- ### ✅carbon--mini-units [function]
1397
-
1398
- Get the value of the corresponding number of units
1399
-
1400
- <details>
1401
- <summary>Source code</summary>
1402
-
1403
- ```scss
1404
- @function carbon--mini-units($count) {
1405
- @return carbon--rem($carbon--mini-unit-size * $count);
1406
- }
1407
- ```
1408
-
1409
- </details>
1410
-
1411
- - **Parameters**:
1412
-
1413
- | Name | Description | Type | Default value |
1414
- | -------- | ---------------------------------------- | -------- | ------------- |
1415
- | `$count` | The number of units to get the value for | `Number` | — |
1416
-
1417
- - **Group**: [@carbon/layout](#carbonlayout)
1418
- - **Returns**: `Number` In rem units
1419
- - **Requires**:
1420
- - [carbon--rem [function]](#carbon--rem-function)
1421
- - [carbon--mini-unit-size [variable]](#carbon--mini-unit-size-variable)
1422
-
1423
- ### ✅carbon--spacing-01 [variable]
1424
-
1425
- <details>
1426
- <summary>Source code</summary>
1427
-
1428
- ```scss
1429
- $carbon--spacing-01: 0.125rem;
1430
- ```
1431
-
1432
- </details>
1433
-
1434
- - **Group**: [@carbon/layout](#carbonlayout)
1435
- - **Type**: `Number`
1436
- - **Aliased**:
1437
- - `spacing-01`
1438
-
1439
- ### ✅carbon--spacing-02 [variable]
1440
-
1441
- <details>
1442
- <summary>Source code</summary>
1443
-
1444
- ```scss
1445
- $carbon--spacing-02: 0.25rem;
1446
- ```
1447
-
1448
- </details>
1449
-
1450
- - **Group**: [@carbon/layout](#carbonlayout)
1451
- - **Type**: `Number`
1452
- - **Aliased**:
1453
- - `spacing-02`
1454
-
1455
- ### ✅carbon--spacing-03 [variable]
1456
-
1457
- <details>
1458
- <summary>Source code</summary>
1459
-
1460
- ```scss
1461
- $carbon--spacing-03: 0.5rem;
1462
- ```
1463
-
1464
- </details>
1465
-
1466
- - **Group**: [@carbon/layout](#carbonlayout)
1467
- - **Type**: `Number`
1468
- - **Aliased**:
1469
- - `spacing-03`
1470
-
1471
- ### ✅carbon--spacing-04 [variable]
1472
-
1473
- <details>
1474
- <summary>Source code</summary>
1475
-
1476
- ```scss
1477
- $carbon--spacing-04: 0.75rem;
1478
- ```
1479
-
1480
- </details>
1481
-
1482
- - **Group**: [@carbon/layout](#carbonlayout)
1483
- - **Type**: `Number`
1484
- - **Aliased**:
1485
- - `spacing-04`
1486
-
1487
- ### ✅carbon--spacing-05 [variable]
1488
-
1489
- <details>
1490
- <summary>Source code</summary>
1491
-
1492
- ```scss
1493
- $carbon--spacing-05: 1rem;
1494
- ```
1495
-
1496
- </details>
1497
-
1498
- - **Group**: [@carbon/layout](#carbonlayout)
1499
- - **Type**: `Number`
1500
- - **Aliased**:
1501
- - `spacing-05`
1502
-
1503
- ### ✅carbon--spacing-06 [variable]
1504
-
1505
- <details>
1506
- <summary>Source code</summary>
1507
-
1508
- ```scss
1509
- $carbon--spacing-06: 1.5rem;
1510
- ```
1511
-
1512
- </details>
1513
-
1514
- - **Group**: [@carbon/layout](#carbonlayout)
1515
- - **Type**: `Number`
1516
- - **Aliased**:
1517
- - `spacing-06`
1518
-
1519
- ### ✅carbon--spacing-07 [variable]
1520
-
1521
- <details>
1522
- <summary>Source code</summary>
1523
-
1524
- ```scss
1525
- $carbon--spacing-07: 2rem;
1526
- ```
1527
-
1528
- </details>
1529
-
1530
- - **Group**: [@carbon/layout](#carbonlayout)
1531
- - **Type**: `Number`
1532
- - **Aliased**:
1533
- - `spacing-07`
1534
-
1535
- ### ✅carbon--spacing-08 [variable]
1536
-
1537
- <details>
1538
- <summary>Source code</summary>
1539
-
1540
- ```scss
1541
- $carbon--spacing-08: 2.5rem;
1542
- ```
1543
-
1544
- </details>
1545
-
1546
- - **Group**: [@carbon/layout](#carbonlayout)
1547
- - **Type**: `Number`
1548
- - **Aliased**:
1549
- - `spacing-08`
1550
-
1551
- ### ✅carbon--spacing-09 [variable]
1552
-
1553
- <details>
1554
- <summary>Source code</summary>
1555
-
1556
- ```scss
1557
- $carbon--spacing-09: 3rem;
1558
- ```
1559
-
1560
- </details>
1561
-
1562
- - **Group**: [@carbon/layout](#carbonlayout)
1563
- - **Type**: `Number`
1564
- - **Aliased**:
1565
- - `spacing-09`
1566
-
1567
- ### ✅carbon--spacing-10 [variable]
1568
-
1569
- <details>
1570
- <summary>Source code</summary>
1571
-
1572
- ```scss
1573
- $carbon--spacing-10: 4rem;
1574
- ```
1575
-
1576
- </details>
1577
-
1578
- - **Group**: [@carbon/layout](#carbonlayout)
1579
- - **Type**: `Number`
1580
- - **Aliased**:
1581
- - `spacing-10`
1582
-
1583
- ### ✅carbon--spacing-11 [variable]
1584
-
1585
- <details>
1586
- <summary>Source code</summary>
1587
-
1588
- ```scss
1589
- $carbon--spacing-11: 5rem;
1590
- ```
1591
-
1592
- </details>
1593
-
1594
- - **Group**: [@carbon/layout](#carbonlayout)
1595
- - **Type**: `Number`
1596
- - **Aliased**:
1597
- - `spacing-11`
1598
-
1599
- ### ✅carbon--spacing-12 [variable]
1600
-
1601
- <details>
1602
- <summary>Source code</summary>
1603
-
1604
- ```scss
1605
- $carbon--spacing-12: 6rem;
1606
- ```
1607
-
1608
- </details>
1609
-
1610
- - **Group**: [@carbon/layout](#carbonlayout)
1611
- - **Type**: `Number`
1612
- - **Aliased**:
1613
- - `spacing-12`
1614
-
1615
- ### ✅carbon--spacing [variable]
1616
-
1617
- <details>
1618
- <summary>Source code</summary>
1619
-
1620
- ```scss
1621
- $carbon--spacing: (
1622
- $carbon--spacing-01,
1623
- $carbon--spacing-02,
1624
- $carbon--spacing-03,
1625
- $carbon--spacing-04,
1626
- $carbon--spacing-05,
1627
- $carbon--spacing-06,
1628
- $carbon--spacing-07,
1629
- $carbon--spacing-08,
1630
- $carbon--spacing-09,
1631
- $carbon--spacing-10,
1632
- $carbon--spacing-11,
1633
- $carbon--spacing-12
1634
- );
1635
- ```
1636
-
1637
- </details>
1638
-
1639
- - **Group**: [@carbon/layout](#carbonlayout)
1640
- - **Type**: `List`
1641
-
1642
- ### ✅spacing-01 [variable]
1643
-
1644
- <details>
1645
- <summary>Source code</summary>
1646
-
1647
- ```scss
1648
- $spacing-01: $carbon--spacing-01;
1649
- ```
1650
-
1651
- </details>
1652
-
1653
- - **Group**: [@carbon/layout](#carbonlayout)
1654
- - **Type**: `Number`
1655
- - **Alias**: `carbon--spacing-01`
1656
-
1657
- ### ✅spacing-02 [variable]
1658
-
1659
- <details>
1660
- <summary>Source code</summary>
1661
-
1662
- ```scss
1663
- $spacing-02: $carbon--spacing-02;
1664
- ```
1665
-
1666
- </details>
1667
-
1668
- - **Group**: [@carbon/layout](#carbonlayout)
1669
- - **Type**: `Number`
1670
- - **Alias**: `carbon--spacing-02`
1671
-
1672
- ### ✅spacing-03 [variable]
1673
-
1674
- <details>
1675
- <summary>Source code</summary>
1676
-
1677
- ```scss
1678
- $spacing-03: $carbon--spacing-03;
1679
- ```
1680
-
1681
- </details>
1682
-
1683
- - **Group**: [@carbon/layout](#carbonlayout)
1684
- - **Type**: `Number`
1685
- - **Alias**: `carbon--spacing-03`
1686
-
1687
- ### ✅spacing-04 [variable]
1688
-
1689
- <details>
1690
- <summary>Source code</summary>
1691
-
1692
- ```scss
1693
- $spacing-04: $carbon--spacing-04;
1694
- ```
1695
-
1696
- </details>
1697
-
1698
- - **Group**: [@carbon/layout](#carbonlayout)
1699
- - **Type**: `Number`
1700
- - **Alias**: `carbon--spacing-04`
1701
-
1702
- ### ✅spacing-05 [variable]
1703
-
1704
- <details>
1705
- <summary>Source code</summary>
1706
-
1707
- ```scss
1708
- $spacing-05: $carbon--spacing-05;
1709
- ```
1710
-
1711
- </details>
1712
-
1713
- - **Group**: [@carbon/layout](#carbonlayout)
1714
- - **Type**: `Number`
1715
- - **Alias**: `carbon--spacing-05`
1716
-
1717
- ### ✅spacing-06 [variable]
1718
-
1719
- <details>
1720
- <summary>Source code</summary>
1721
-
1722
- ```scss
1723
- $spacing-06: $carbon--spacing-06;
1724
- ```
1725
-
1726
- </details>
1727
-
1728
- - **Group**: [@carbon/layout](#carbonlayout)
1729
- - **Type**: `Number`
1730
- - **Alias**: `carbon--spacing-06`
1731
-
1732
- ### ✅spacing-07 [variable]
1733
-
1734
- <details>
1735
- <summary>Source code</summary>
1736
-
1737
- ```scss
1738
- $spacing-07: $carbon--spacing-07;
1739
- ```
1740
-
1741
- </details>
1742
-
1743
- - **Group**: [@carbon/layout](#carbonlayout)
1744
- - **Type**: `Number`
1745
- - **Alias**: `carbon--spacing-07`
1746
-
1747
- ### ✅spacing-08 [variable]
1748
-
1749
- <details>
1750
- <summary>Source code</summary>
1751
-
1752
- ```scss
1753
- $spacing-08: $carbon--spacing-08;
1754
- ```
1755
-
1756
- </details>
1757
-
1758
- - **Group**: [@carbon/layout](#carbonlayout)
1759
- - **Type**: `Number`
1760
- - **Alias**: `carbon--spacing-08`
1761
-
1762
- ### ✅spacing-09 [variable]
1763
-
1764
- <details>
1765
- <summary>Source code</summary>
1766
-
1767
- ```scss
1768
- $spacing-09: $carbon--spacing-09;
1769
- ```
1770
-
1771
- </details>
1772
-
1773
- - **Group**: [@carbon/layout](#carbonlayout)
1774
- - **Type**: `Number`
1775
- - **Alias**: `carbon--spacing-09`
1776
-
1777
- ### ✅spacing-10 [variable]
1778
-
1779
- <details>
1780
- <summary>Source code</summary>
1781
-
1782
- ```scss
1783
- $spacing-10: $carbon--spacing-10;
1784
- ```
1785
-
1786
- </details>
1787
-
1788
- - **Group**: [@carbon/layout](#carbonlayout)
1789
- - **Type**: `Number`
1790
- - **Alias**: `carbon--spacing-10`
1791
-
1792
- ### ✅spacing-11 [variable]
1793
-
1794
- <details>
1795
- <summary>Source code</summary>
1796
-
1797
- ```scss
1798
- $spacing-11: $carbon--spacing-11;
1799
- ```
1800
-
1801
- </details>
1802
-
1803
- - **Group**: [@carbon/layout](#carbonlayout)
1804
- - **Type**: `Number`
1805
- - **Alias**: `carbon--spacing-11`
1806
-
1807
- ### ✅spacing-12 [variable]
1808
-
1809
- <details>
1810
- <summary>Source code</summary>
1811
-
1812
- ```scss
1813
- $spacing-12: $carbon--spacing-12;
1814
- ```
1815
-
1816
- </details>
1817
-
1818
- - **Group**: [@carbon/layout](#carbonlayout)
1819
- - **Type**: `Number`
1820
- - **Alias**: `carbon--spacing-12`
1821
-
1822
- ### ✅map-deep-get [function]
1823
-
1824
- Map deep get
1825
-
1826
- <details>
1827
- <summary>Source code</summary>
1828
-
1829
- ```scss
1830
- @function map-deep-get($map, $keys) {
1831
- @each $key in $keys {
1832
- $map: map-get($map, $key);
1833
- }
1834
- @return $map;
1835
- }
1836
- ```
1837
-
1838
- </details>
1839
-
1840
- - **Parameters**:
1841
-
1842
- | Name | Description | Type | Default value |
1843
- | ------- | ----------- | --------- | ------------- |
1844
- | `$map` | Map | `Map` | — |
1845
- | `$keys` | Key chain | `Arglist` | — |
1846
-
1847
- - **Group**: [@carbon/layout](#carbonlayout)
1848
- - **Returns**: `*` Desired value
1849
-
1850
- ### ✅carbon--key-by-index [function]
1851
-
1852
- Provide a map and index, and get back the relevant key value
1853
-
1854
- <details>
1855
- <summary>Source code</summary>
1856
-
1857
- ```scss
1858
- @function carbon--key-by-index($map, $index) {
1859
- $keys: map-keys($map);
1860
- @return nth($keys, $index);
1861
- }
1862
- ```
1863
-
1864
- </details>
1865
-
1866
- - **Parameters**:
1867
-
1868
- | Name | Description | Type | Default value |
1869
- | -------- | ----------- | --------- | ------------- |
1870
- | `$map` | Map | `Map` | — |
1871
- | `$index` | Key chain | `Integer` | — |
1872
-
1873
- - **Group**: [@carbon/layout](#carbonlayout)
1874
- - **Returns**: `String` Desired value
1875
- - **Used by**:
1876
- - [carbon--largest-breakpoint-name [function]](#carbon--largest-breakpoint-name-function)
1877
- - [last-map-item [function]](#last-map-item-function)
1878
-
1879
- ### ✅last-map-item [function]
1880
-
1881
- Pass in a map, and get the last one in the list back
1882
-
1883
- <details>
1884
- <summary>Source code</summary>
1885
-
1886
- ```scss
1887
- @function last-map-item($map) {
1888
- $total-length: length($map);
1889
- @return map-get($map, carbon--key-by-index($map, $total-length));
1890
- }
1891
- ```
1892
-
1893
- </details>
1894
-
1895
- - **Parameters**:
1896
-
1897
- | Name | Description | Type | Default value |
1898
- | ------ | ----------- | ----- | ------------- |
1899
- | `$map` | Map | `Map` | — |
1900
-
1901
- - **Group**: [@carbon/layout](#carbonlayout)
1902
- - **Returns**: `*` Desired value
1903
- - **Requires**:
1904
- - [carbon--key-by-index [function]](#carbon--key-by-index-function)