Skip to content

Commit eaab236

Browse files
committed
docs: update SCSS docs
1 parent 76126f9 commit eaab236

28 files changed

+292
-1207
lines changed

packages/docs/content/components/accordion.mdx

Lines changed: 2 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -150,30 +150,7 @@ Add `alwaysOpen` property to make react accordion items stay open when another i
150150

151151
React accordions use local CSS variables on `.accordion` for enhanced real-time customization. Values for the CSS variables are set via Sass, so Sass customization is still supported, too.
152152

153-
```sass
154-
--cui-accordion-color: #{color-contrast($accordion-bg)};
155-
--cui-accordion-bg: #{$accordion-bg};
156-
--cui-accordion-transition: #{$accordion-transition};
157-
--cui-accordion-border-color: #{$accordion-border-color};
158-
--cui-accordion-border-width: #{$accordion-border-width};
159-
--cui-accordion-border-radius: #{$accordion-border-radius};
160-
--cui-accordion-inner-border-radius: #{$accordion-inner-border-radius};
161-
--cui-accordion-btn-padding-x: #{$accordion-button-padding-x};
162-
--cui-accordion-btn-padding-y: #{$accordion-button-padding-y};
163-
--cui-accordion-btn-color: #{$accordion-color};
164-
--cui-accordion-btn-bg: #{$accordion-button-bg};
165-
--cui-accordion-btn-icon: #{escape-svg($accordion-button-icon)};
166-
--cui-accordion-btn-icon-width: #{$accordion-icon-width};
167-
--cui-accordion-btn-icon-transform: #{$accordion-icon-transform};
168-
--cui-accordion-btn-icon-transition: #{$accordion-icon-transition};
169-
--cui-accordion-btn-active-icon: #{escape-svg($accordion-button-active-icon)};
170-
--cui-accordion-btn-focus-border-color: #{$accordion-button-focus-border-color};
171-
--cui-accordion-btn-focus-box-shadow: #{$accordion-button-focus-box-shadow};
172-
--cui-accordion-body-padding-x: #{$accordion-body-padding-x};
173-
--cui-accordion-body-padding-y: #{$accordion-body-padding-y};
174-
--cui-accordion-active-color: #{$accordion-button-active-color};
175-
--cui-accordion-active-bg: #{$accordion-button-active-bg};
176-
```
153+
<ScssDocs file="_accordion.scss" capture="accordion-css-vars"/>
177154

178155
#### How to use CSS variables
179156

@@ -187,39 +164,7 @@ return <CAccordion style={vars}>...</CAccordion>
187164

188165
### SASS variables
189166

190-
```sass
191-
$accordion-padding-y: 1rem;
192-
$accordion-padding-x: 1.25rem;
193-
$accordion-color: var(--cui-body-color);
194-
$accordion-bg: $body-bg;
195-
$accordion-border-width: $border-width;
196-
$accordion-border-color: var(--cui-border-color);
197-
$accordion-border-radius: $border-radius;
198-
$accordion-inner-border-radius: subtract($accordion-border-radius, $accordion-border-width);
199-
200-
$accordion-body-padding-y: $accordion-padding-y;
201-
$accordion-body-padding-x: $accordion-padding-x;
202-
203-
$accordion-button-padding-y: $accordion-padding-y;
204-
$accordion-button-padding-x: $accordion-padding-x;
205-
$accordion-button-color: $accordion-color;
206-
$accordion-button-bg: var(--cui-accordion-bg);
207-
$accordion-transition: $btn-transition, border-radius .15s ease;
208-
$accordion-button-active-bg: tint-color($component-active-bg, 90%);
209-
$accordion-button-active-color: shade-color($primary, 10%);
210-
211-
$accordion-button-focus-border-color: $input-focus-border-color;
212-
$accordion-button-focus-box-shadow: $btn-focus-box-shadow;
213-
214-
$accordion-icon-width: 1.25rem;
215-
$accordion-icon-color: $accordion-button-color;
216-
$accordion-icon-active-color: $accordion-button-active-color;
217-
$accordion-icon-transition: transform .2s ease-in-out;
218-
$accordion-icon-transform: rotate(-180deg);
219-
220-
$accordion-button-icon: url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16' fill='#{$accordion-icon-color}'><path fill-rule='evenodd' d='M1.646 4.646a.5.5 0 0 1 .708 0L8 10.293l5.646-5.647a.5.5 0 0 1 .708.708l-6 6a.5.5 0 0 1-.708 0l-6-6a.5.5 0 0 1 0-.708z'/></svg>");
221-
$accordion-button-active-icon: url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16' fill='#{$accordion-icon-active-color}'><path fill-rule='evenodd' d='M1.646 4.646a.5.5 0 0 1 .708 0L8 10.293l5.646-5.647a.5.5 0 0 1 .708.708l-6 6a.5.5 0 0 1-.708 0l-6-6a.5.5 0 0 1 0-.708z'/></svg>");
222-
```
167+
<ScssDocs file="_variables.scss" capture="accordion-variables"/>
223168

224169
## API
225170

packages/docs/content/components/alert.mdx

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -231,16 +231,7 @@ React Alert component can also be easily dismissed. Just add the `dismissible` p
231231

232232
React alerts use local CSS variables on `.alert` for enhanced real-time customization. Values for the CSS variables are set via Sass, so Sass customization is still supported, too.
233233

234-
```sass
235-
--cui-alert-bg: transparent;
236-
--cui-alert-padding-x: #{$alert-padding-x};
237-
--cui-alert-padding-y: #{$alert-padding-y};
238-
--cui-alert-margin-bottom: #{$alert-margin-bottom};
239-
--cui-alert-color: inherit;
240-
--cui-alert-border-color: transparent;
241-
--cui-alert-border: #{$alert-border-width} solid var(--cui-alert-border-color);
242-
--cui-alert-border-radius: #{$alert-border-radius};
243-
```
234+
<ScssDocs file="_alert.scss" capture="alert-css-vars"/>
244235

245236
#### How to use CSS variables
246237

@@ -254,18 +245,7 @@ return <CAlert style={vars}>...</CAlert>
254245

255246
### SASS variables
256247

257-
```sass
258-
$alert-padding-y: $spacer;
259-
$alert-padding-x: $spacer;
260-
$alert-margin-bottom: 1rem;
261-
$alert-border-radius: $border-radius;
262-
$alert-link-font-weight: $font-weight-bold;
263-
$alert-border-width: $border-width;
264-
$alert-bg-scale: -80%;
265-
$alert-border-scale: -70%;
266-
$alert-color-scale: 40%;
267-
$alert-dismissible-padding-r: $alert-padding-x * 3; // 3x covers width of x plus default padding on either side
268-
```
248+
<ScssDocs file="_variables.scss" capture="alert-variables"/>
269249

270250
## API
271251

packages/docs/content/components/badge.mdx

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -123,14 +123,7 @@ Apply the `shape="rounded-pill"` prop to make badges rounded.
123123

124124
React badges use local CSS variables on `.badges` for enhanced real-time customization. Values for the CSS variables are set via Sass, so Sass customization is still supported, too.
125125

126-
```sass
127-
--cui-badge-padding-x: #{$badge-padding-x};
128-
--cui-badge-padding-y: #{$badge-padding-y};
129-
--cui-badge-font-size: #{$badge-font-size};
130-
--cui-badge-font-weight: #{$badge-font-weight};
131-
--cui-badge-color: #{$badge-color};
132-
--cui-badge-border-radius: #{$badge-border-radius};
133-
```
126+
<ScssDocs file="_badge.scss" capture="badge-css-vars"/>
134127

135128
#### How to use CSS variables
136129

@@ -144,18 +137,7 @@ return <CBadge style={vars}>...</CBadge>
144137

145138
### SASS variables
146139

147-
```sass
148-
$badge-font-size: .75em;
149-
$badge-font-weight: $font-weight-bold;
150-
$badge-color: $high-emphasis-inverse;
151-
$badge-padding-y: .35em;
152-
$badge-padding-x: .65em;
153-
$badge-border-radius: $border-radius;
154-
155-
$badge-font-size-sm: .65em;
156-
$badge-padding-y-sm: .3em;
157-
$badge-padding-x-sm: .5em;
158-
```
140+
<ScssDocs file="_variables.scss" capture="badge-variables"/>
159141

160142
## API
161143

packages/docs/content/components/breadcrumb.mdx

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -86,17 +86,7 @@ For more information, see the [WAI-ARIA Authoring Practices for the breadcrumb p
8686

8787
React breadcrumbs use local CSS variables on `.breadcrumb` for enhanced real-time customization. Values for the CSS variables are set via Sass, so Sass customization is still supported, too.
8888

89-
```sass
90-
--cui-breadcrumb-padding-x: #{$breadcrumb-padding-x};
91-
--cui-breadcrumb-padding-y: #{$breadcrumb-padding-y};
92-
--cui-breadcrumb-margin-bottom: #{$breadcrumb-margin-bottom};
93-
--cui-breadcrumb-font-size: #{$breadcrumb-font-size};
94-
--cui-breadcrumb-bg: #{$breadcrumb-bg};
95-
--cui-breadcrumb-border-radius: #{$breadcrumb-border-radius};
96-
--cui-breadcrumb-divider-color: #{$breadcrumb-divider-color};
97-
--cui-breadcrumb-item-padding-x: #{$breadcrumb-item-padding-x};
98-
--cui-breadcrumb-item-active-color: #{$breadcrumb-active-color};
99-
```
89+
<ScssDocs file="_breadcrumb.scss" capture="breadcrumb-css-vars"/>
10090

10191
#### How to use CSS variables
10292

@@ -110,19 +100,7 @@ return <CBreadcrumb style={vars}>...</CBreadcrumb>
110100

111101
### SASS variables
112102

113-
```sass
114-
$breadcrumb-font-size: null;
115-
$breadcrumb-padding-y: 0;
116-
$breadcrumb-padding-x: 0;
117-
$breadcrumb-item-padding-x: .5rem;
118-
$breadcrumb-margin-bottom: 1rem;
119-
$breadcrumb-bg: unset;
120-
$breadcrumb-divider-color: $gray-600;
121-
$breadcrumb-active-color: $gray-600;
122-
$breadcrumb-divider: quote("/");
123-
$breadcrumb-divider-flipped: $breadcrumb-divider;
124-
$breadcrumb-border-radius: null;
125-
```
103+
<ScssDocs file="_variables.scss" capture="breadcrumb-variables"/>
126104

127105
## API
128106

packages/docs/content/components/button.mdx

Lines changed: 2 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -193,22 +193,7 @@ Additional utilities can be used to adjust the alignment of buttons when horizon
193193

194194
React buttons use local CSS variables on `.btn` for enhanced real-time customization. Values for the CSS variables are set via Sass, so Sass customization is still supported, too.
195195

196-
```sass
197-
--cui-btn-padding-x: #{$btn-padding-x};
198-
--cui-btn-padding-y: #{$btn-padding-y};
199-
--cui-btn-font-family: #{$btn-font-family};
200-
--cui-btn-font-size: #{$btn-font-size};
201-
--cui-btn-font-weight: #{$btn-font-weight};
202-
--cui-btn-line-height: #{$btn-line-height};
203-
--cui-btn-color: #{$body-color};
204-
--cui-btn-bg: transparent;
205-
--cui-btn-border-width: #{$btn-border-width};
206-
--cui-btn-border-color: transparent;
207-
--cui-btn-border-radius: #{$btn-border-radius};
208-
--cui-btn-box-shadow: #{$btn-box-shadow};
209-
--cui-btn-disabled-opacity: #{$btn-disabled-opacity};
210-
--cui-btn-focus-box-shadow: 0 0 0 #{$btn-focus-width} rgba(var(--cui-btn-focus-shadow-rgb), .5);
211-
```
196+
<ScssDocs file="_buttons.scss" capture="btn-css-vars"/>
212197

213198
#### How to use CSS variables
214199

@@ -222,75 +207,7 @@ return <CButton style={vars}>...</CButton>
222207

223208
### SASS variables
224209

225-
```sass
226-
$btn-padding-y: $input-btn-padding-y;
227-
$btn-padding-x: $input-btn-padding-x;
228-
$btn-font-family: $input-btn-font-family;
229-
$btn-font-size: $input-btn-font-size;
230-
$btn-line-height: $input-btn-line-height;
231-
$btn-white-space: null; // Set to `nowrap` to prevent text wrapping
232-
233-
$btn-padding-y-sm: $input-btn-padding-y-sm;
234-
$btn-padding-x-sm: $input-btn-padding-x-sm;
235-
$btn-font-size-sm: $input-btn-font-size-sm;
236-
237-
$btn-padding-y-lg: $input-btn-padding-y-lg;
238-
$btn-padding-x-lg: $input-btn-padding-x-lg;
239-
$btn-font-size-lg: $input-btn-font-size-lg;
240-
241-
$btn-border-width: $input-btn-border-width;
242-
243-
$btn-font-weight: $font-weight-normal;
244-
$btn-box-shadow: inset 0 1px 0 rgba($white, .15), 0 1px 1px rgba($black, .075);
245-
$btn-focus-width: $input-btn-focus-width;
246-
$btn-focus-box-shadow: $input-btn-focus-box-shadow;
247-
$btn-disabled-opacity: .65;
248-
$btn-active-box-shadow: inset 0 3px 5px rgba($black, .125);
249-
250-
$btn-link-color: var(--cui-link-color);
251-
$btn-link-hover-color: var(--cui-link-hover-color);
252-
$btn-link-disabled-color: $gray-600;
253-
254-
// Allows for customizing button radius independently from global border radius
255-
$btn-border-radius: $border-radius;
256-
$btn-border-radius-sm: $border-radius-sm;
257-
$btn-border-radius-lg: $border-radius-lg;
258-
259-
$btn-transition: color .15s ease-in-out, background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out;
260-
261-
$btn-hover-bg-shade-amount: 15%;
262-
$btn-hover-bg-tint-amount: 15%;
263-
$btn-hover-border-shade-amount: 20%;
264-
$btn-hover-border-tint-amount: 10%;
265-
$btn-active-bg-shade-amount: 20%;
266-
$btn-active-bg-tint-amount: 20%;
267-
$btn-active-border-shade-amount: 25%;
268-
$btn-active-border-tint-amount: 10%;
269-
270-
// scss-docs-start button-variants
271-
$button-variants: (
272-
"primary": btn-color-map($primary, $primary),
273-
"secondary": btn-color-map($secondary, $secondary),
274-
"success": btn-color-map($success, $success),
275-
"danger": btn-color-map($danger, $danger),
276-
"warning": btn-color-map($warning, $warning),
277-
"info": btn-color-map($info, $info),
278-
"light": btn-color-map($light, $light),
279-
"dark": btn-color-map($dark, $dark)
280-
);
281-
282-
$button-outline-ghost-variants: (
283-
"primary": btn-outline-color-map($primary),
284-
"secondary": btn-outline-color-map($secondary),
285-
"success": btn-outline-color-map($success),
286-
"danger": btn-outline-color-map($danger),
287-
"warning": btn-outline-color-map($warning),
288-
"info": btn-outline-color-map($info),
289-
"light": btn-outline-color-map($light),
290-
"dark": btn-outline-color-map($dark)
291-
);
292-
// scss-docs-end button-variants
293-
```
210+
<ScssDocs file="_variables.scss" capture="btn-variables"/>
294211

295212
## API
296213

packages/docs/content/components/callout.mdx

Lines changed: 2 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -61,16 +61,7 @@ Callout component is prepared for any length of text, as well as an optional ele
6161
6262
React callouts use local CSS variables on `.callout` for enhanced real-time customization. Values for the CSS variables are set via Sass, so Sass customization is still supported, too.
6363
64-
```sass
65-
--cui-callout-padding-x: #{$callout-padding-x};
66-
--cui-callout-padding-y: #{$callout-padding-y};
67-
--cui-callout-margin-x: #{$callout-margin-x};
68-
--cui-callout-margin-y: #{$callout-margin-y};
69-
--cui-callout-border-width: #{$callout-border-width};
70-
--cui-callout-border-color: #{$callout-border-color};
71-
--cui-callout-border-left-width: #{$callout-border-left-width};
72-
--cui-callout-border-radius: #{$callout-border-radius};
73-
```
64+
<ScssDocs file="_callout.scss" capture="callout-css-vars"/>
7465
7566
#### How to use CSS variables
7667
@@ -84,28 +75,7 @@ return <CCallout style={vars}>...</CCallout>
8475
8576
### SASS variables
8677
87-
```sass
88-
$callout-padding-y: $spacer;
89-
$callout-padding-x: $spacer;
90-
$callout-margin-y: $spacer;
91-
$callout-margin-x: 0;
92-
$callout-border-radius: $border-radius;
93-
$callout-border-width: $border-width;
94-
$callout-border-color: $border-color;
95-
$callout-border-left-width: (4 * $callout-border-width);
96-
97-
$callout-variants: (
98-
"primary": $primary,
99-
"secondary": $secondary,
100-
"success": $success,
101-
"danger": $danger,
102-
"warning": $warning,
103-
"info": $info,
104-
"light": $light,
105-
"dark": $dark
106-
);
107-
```
108-
78+
<ScssDocs file="_variables.scss" capture="callout-variables"/>
10979
11080
## API
11181

packages/docs/content/components/card.mdx

Lines changed: 2 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -972,25 +972,7 @@ Just like with card groups, card footers will automatically line up.
972972
973973
React cards use local CSS variables on `.card` for enhanced real-time customization. Values for the CSS variables are set via Sass, so Sass customization is still supported, too.
974974
975-
```sass
976-
--cui-card-spacer-y: #{$card-spacer-y};
977-
--cui-card-spacer-x: #{$card-spacer-x};
978-
--cui-card-title-spacer-y: #{$card-title-spacer-y};
979-
--cui-card-border-width: #{$card-border-width};
980-
--cui-card-border-color: #{$card-border-color};
981-
--cui-card-border-radius: #{$card-border-radius};
982-
--cui-card-box-shadow: #{$card-box-shadow};
983-
--cui-card-inner-border-radius: #{$card-inner-border-radius};
984-
--cui-card-cap-padding-y: #{$card-cap-padding-y};
985-
--cui-card-cap-padding-x: #{$card-cap-padding-x};
986-
--cui-card-cap-bg: #{$card-cap-bg};
987-
--cui-card-cap-color: #{$card-cap-color};
988-
--cui-card-height: #{$card-height};
989-
--cui-card-color: #{$card-color};
990-
--cui-card-bg: #{$card-bg};
991-
--cui-card-img-overlay-padding: #{$card-img-overlay-padding};
992-
--cui-card-group-margin: #{$card-group-margin};
993-
```
975+
<ScssDocs file="_card.scss" capture="card-css-vars"/>
994976
995977
#### How to use CSS variables
996978
@@ -1004,25 +986,7 @@ return <CCard style={vars}>...</CCard>
1004986
1005987
### SASS variables
1006988
1007-
```sass
1008-
$card-spacer-y: $spacer;
1009-
$card-spacer-x: $spacer;
1010-
$card-title-spacer-y: $spacer * .5;
1011-
$card-border-width: $border-width;
1012-
$card-border-color: var(--cui-border-color-translucent);
1013-
$card-border-radius: $border-radius;
1014-
$card-box-shadow: null;
1015-
$card-inner-border-radius: subtract($card-border-radius, $card-border-width);
1016-
$card-cap-padding-y: $card-spacer-y * .5;
1017-
$card-cap-padding-x: $card-spacer-x;
1018-
$card-cap-bg: rgba($black, .03);
1019-
$card-cap-color: unset;
1020-
$card-height: null;
1021-
$card-color: unset;
1022-
$card-bg: $white;
1023-
$card-img-overlay-padding: $spacer;
1024-
$card-group-margin: $grid-gutter-width * .5;
1025-
```
989+
<ScssDocs file="_variables.scss" capture="card-variables"/>
1026990
1027991
## API
1028992

0 commit comments

Comments
 (0)