Skip to content

Commit f39e617

Browse files
Docs: use <ScssDocs> shortcode for all "Sass utilities API" sections (#42766)
1 parent 0756b55 commit f39e617

16 files changed

Lines changed: 46 additions & 196 deletions

scss/_utilities.scss

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ $utilities: map.merge(
3636
values: var(--ratio),
3737
),
3838
"aspect-ratio": (
39-
// property: aspect-ratio,
4039
property: --ratio,
4140
class: ratio,
4241
values: $aspect-ratios
@@ -391,6 +390,8 @@ $utilities: map.merge(
391390
class: flex,
392391
values: wrap nowrap wrap-reverse
393392
),
393+
// scss-docs-end utils-flex
394+
// scss-docs-start utils-justify-content
394395
"justify-content": (
395396
responsive: true,
396397
property: justify-content,
@@ -403,6 +404,8 @@ $utilities: map.merge(
403404
evenly: space-evenly,
404405
)
405406
),
407+
// scss-docs-end utils-justify-content
408+
// scss-docs-start utils-justify-items
406409
"justify-items": (
407410
responsive: true,
408411
property: justify-items,
@@ -413,6 +416,7 @@ $utilities: map.merge(
413416
stretch: stretch,
414417
)
415418
),
419+
// scss-docs-end utils-justify-items
416420
"justify-self": (
417421
responsive: true,
418422
property: justify-self,
@@ -422,6 +426,7 @@ $utilities: map.merge(
422426
center: center,
423427
)
424428
),
429+
// scss-docs-start utils-align-items
425430
"align-items": (
426431
responsive: true,
427432
property: align-items,
@@ -433,6 +438,8 @@ $utilities: map.merge(
433438
stretch: stretch,
434439
)
435440
),
441+
// scss-docs-end utils-align-items
442+
// scss-docs-start utils-align-content
436443
"align-content": (
437444
responsive: true,
438445
property: align-content,
@@ -445,6 +452,8 @@ $utilities: map.merge(
445452
stretch: stretch,
446453
)
447454
),
455+
// scss-docs-end utils-align-content
456+
// scss-docs-start utils-align-self
448457
"align-self": (
449458
responsive: true,
450459
property: align-self,
@@ -457,6 +466,8 @@ $utilities: map.merge(
457466
stretch: stretch,
458467
)
459468
),
469+
// scss-docs-end utils-align-self
470+
// scss-docs-start utils-place-items
460471
"place-items": (
461472
responsive: true,
462473
property: place-items,
@@ -467,9 +478,10 @@ $utilities: map.merge(
467478
stretch: stretch,
468479
)
469480
),
481+
// scss-docs-end utils-place-items
482+
// scss-docs-start utils-grid
470483
"grid-column-counts": (
471484
responsive: true,
472-
// property: --columns,
473485
property: grid-template-columns,
474486
class: grid-cols,
475487
values: (
@@ -495,6 +507,7 @@ $utilities: map.merge(
495507
class: grid-auto-flow,
496508
values: row column dense
497509
),
510+
// scss-docs-end utils-grid
498511
"order": (
499512
responsive: true,
500513
property: order,
@@ -509,9 +522,7 @@ $utilities: map.merge(
509522
last: 6,
510523
),
511524
),
512-
// scss-docs-end utils-flex
513525
// Margin utilities
514-
// scss-docs-start utils-spacing
515526
// scss-docs-start utils-margin
516527
"margin": (
517528
responsive: true,
@@ -622,7 +633,6 @@ $utilities: map.merge(
622633
values: $spacers
623634
),
624635
// scss-docs-end utils-gap
625-
// scss-docs-end utils-spacing
626636
// scss-docs-start utils-space
627637
"space-x": (
628638
responsive: true,
@@ -687,11 +697,13 @@ $utilities: map.merge(
687697
values: $font-sizes
688698
),
689699
// scss-docs-end utils-font-size
700+
// scss-docs-start utils-font-style
690701
"font-style": (
691702
property: font-style,
692703
class: fst,
693704
values: italic normal
694705
),
706+
// scss-docs-end utils-font-style
695707
// scss-docs-start utils-font-weight
696708
"font-weight": (
697709
property: font-weight,
@@ -711,6 +723,7 @@ $utilities: map.merge(
711723
)
712724
),
713725
// scss-docs-end utils-line-height
726+
// scss-docs-start utils-text-align
714727
"text-align": (
715728
responsive: true,
716729
property: text-align,
@@ -721,6 +734,7 @@ $utilities: map.merge(
721734
center: center,
722735
)
723736
),
737+
// scss-docs-end utils-text-align
724738
"text-decoration": (
725739
property: text-decoration,
726740
values: none underline line-through
@@ -746,7 +760,6 @@ $utilities: map.merge(
746760
values: (break: break-word),
747761
),
748762
// scss-docs-end utils-text-break
749-
// scss-docs-end utils-text
750763
// scss-docs-start utils-color
751764
"fg": (
752765
property: (
@@ -896,17 +909,19 @@ $utilities: map.merge(
896909
class: bg,
897910
values: (gradient: var(--gradient))
898911
),
899-
// scss-docs-start utils-interaction
912+
// scss-docs-start utils-user-select
900913
"user-select": (
901914
property: user-select,
902915
values: all auto text none
903916
),
917+
// scss-docs-end utils-user-select
918+
// scss-docs-start utils-pointer-events
904919
"pointer-events": (
905920
property: pointer-events,
906921
class: pe,
907922
values: none auto,
908923
),
909-
// scss-docs-end utils-interaction
924+
// scss-docs-end utils-pointer-events
910925
// scss-docs-start utils-border-radius
911926
"border-radius": (
912927
property: (

site/src/content/docs/utilities/align-content.mdx

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -198,17 +198,4 @@ Responsive variations also exist for `align-content`.
198198

199199
Align content utilities are declared in our utilities API in `scss/_utilities.scss`. [Learn how to use the utilities API.]([[docsref:/utilities/api#using-the-api]])
200200

201-
```scss
202-
"align-content": (
203-
responsive: true,
204-
property: align-content,
205-
values: (
206-
start: flex-start,
207-
end: flex-end,
208-
center: center,
209-
between: space-between,
210-
around: space-around,
211-
stretch: stretch,
212-
)
213-
),
214-
```
201+
<ScssDocs name="utils-align-content" file="scss/_utilities.scss" />

site/src/content/docs/utilities/align-items.mdx

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -75,16 +75,4 @@ Responsive variations also exist for `align-items`.
7575

7676
Align items utilities are declared in our utilities API in `scss/_utilities.scss`. [Learn how to use the utilities API.]([[docsref:/utilities/api#using-the-api]])
7777

78-
```scss
79-
"align-items": (
80-
responsive: true,
81-
property: align-items,
82-
values: (
83-
start: flex-start,
84-
end: flex-end,
85-
center: center,
86-
baseline: baseline,
87-
stretch: stretch,
88-
)
89-
),
90-
```
78+
<ScssDocs name="utils-align-items" file="scss/_utilities.scss" />

site/src/content/docs/utilities/align-self.mdx

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -75,17 +75,4 @@ Responsive variations also exist for `align-self`.
7575

7676
Align self utilities are declared in our utilities API in `scss/_utilities.scss`. [Learn how to use the utilities API.]([[docsref:/utilities/api#using-the-api]])
7777

78-
```scss
79-
"align-self": (
80-
responsive: true,
81-
property: align-self,
82-
values: (
83-
auto: auto,
84-
start: flex-start,
85-
end: flex-end,
86-
center: center,
87-
baseline: baseline,
88-
stretch: stretch,
89-
)
90-
),
91-
```
78+
<ScssDocs name="utils-align-self" file="scss/_utilities.scss" />

site/src/content/docs/utilities/aspect-ratio.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,16 @@ Then apply that class to your markup:
6565
</div>
6666
```
6767

68-
## Sass map
68+
## CSS
69+
70+
### Sass map
6971

7072
Within `_config.scss`, you can change the aspect ratios you want to use. Here’s our default `$aspect-ratios` map. Modify the map as you like and recompile your Sass to put them to use.
7173

7274
<ScssDocs name="aspect-ratios" file="scss/_config.scss" />
75+
76+
### Sass utilities API
77+
78+
Aspect ratio utilities are declared in our utilities API in `scss/_utilities.scss`. [Learn how to use the utilities API.]([[docsref:/utilities/api#using-the-api]])
79+
80+
<ScssDocs name="utils-aspect-ratio" file="scss/_utilities.scss" />

site/src/content/docs/utilities/divide.mdx

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -75,27 +75,4 @@ Divider color comes from the inheriting `--bs-border-color` design token, so set
7575

7676
Divide utilities are declared in our utilities API in `scss/_utilities.scss`. [Learn how to use the utilities API.]([[docsref:/utilities/api#using-the-api]])
7777

78-
```scss
79-
// scss-docs-start utils-divide
80-
"divide-x": (
81-
responsive: true,
82-
property: border-inline-start,
83-
class: divide-x,
84-
child-selector: "> :not(:first-child)",
85-
values: (
86-
null: var(--border-width) var(--border-style) var(--border-color),
87-
0: 0,
88-
)
89-
),
90-
"divide-y": (
91-
responsive: true,
92-
property: border-block-start,
93-
class: divide-y,
94-
child-selector: "> :not(:first-child)",
95-
values: (
96-
null: var(--border-width) var(--border-style) var(--border-color),
97-
0: 0,
98-
)
99-
),
100-
// scss-docs-end utils-divide
101-
```
78+
<ScssDocs name="utils-divide" file="scss/_utilities.scss" />

site/src/content/docs/utilities/font-family.mdx

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,4 @@ Change a selection to our body font stack with `.font-body`, which defaults to s
2626

2727
Font family utilities are declared in our utilities API in `scss/_utilities.scss`. [Learn how to use the utilities API.]([[docsref:/utilities/api#using-the-api]])
2828

29-
```scss
30-
"font-family": (
31-
property: font-family,
32-
class: font,
33-
values: (monospace: var(--#{$prefix}font-monospace))
34-
),
35-
```
29+
<ScssDocs name="utils-font-family" file="scss/_utilities.scss" />

site/src/content/docs/utilities/font-style.mdx

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,4 @@ Quickly change the `font-style` of text with these utilities. `font-style` utili
2121

2222
Font style utilities are declared in our utilities API in `scss/_utilities.scss`. [Learn how to use the utilities API.]([[docsref:/utilities/api#using-the-api]])
2323

24-
```scss
25-
"font-style": (
26-
property: font-style,
27-
class: fst,
28-
values: italic normal
29-
),
30-
```
24+
<ScssDocs name="utils-font-style" file="scss/_utilities.scss" />

site/src/content/docs/utilities/grid.mdx

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -207,30 +207,4 @@ All grid utilities are responsive and include all breakpoints.
207207

208208
Grid utilities are declared in our utilities API in `scss/_utilities.scss`. [Learn how to use the utilities API.]([[docsref:/utilities/api#using-the-api]])
209209

210-
```scss
211-
"grid-column-counts": (
212-
responsive: true,
213-
property: --#{$prefix}columns,
214-
class: grid-cols,
215-
values: (
216-
3,
217-
4,
218-
6,
219-
subgrid: subgrid
220-
)
221-
),
222-
"grid-columns": (
223-
responsive: true,
224-
property: grid-column,
225-
class: grid-cols,
226-
values: (
227-
fill: #{"1 / -1"},
228-
)
229-
),
230-
"grid-auto-flow": (
231-
responsive: true,
232-
property: grid-auto-flow,
233-
class: grid-auto-flow,
234-
values: row column dense
235-
),
236-
```
210+
<ScssDocs name="utils-grid" file="scss/_utilities.scss" />

site/src/content/docs/utilities/justify-content.mdx

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -82,17 +82,4 @@ Responsive variations also exist for `justify-content`.
8282

8383
Justify content utilities are declared in our utilities API in `scss/_utilities.scss`. [Learn how to use the utilities API.]([[docsref:/utilities/api#using-the-api]])
8484

85-
```scss
86-
"justify-content": (
87-
responsive: true,
88-
property: justify-content,
89-
values: (
90-
start: flex-start,
91-
end: flex-end,
92-
center: center,
93-
between: space-between,
94-
around: space-around,
95-
evenly: space-evenly,
96-
)
97-
),
98-
```
85+
<ScssDocs name="utils-justify-content" file="scss/_utilities.scss" />

0 commit comments

Comments
 (0)