Skip to content

Commit 3f63c8f

Browse files
committed
docs(sassdoc): fix dark component schemas docs
1 parent 7b67426 commit 3f63c8f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+323
-270
lines changed

projects/igniteui-angular/src/lib/core/styles/themes/schemas/dark/_action-strip.scss

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
/// Generates a dark action-strip schema.
1010
/// @type {Map}
1111
/// @property {Map} actions-background [igx-color: ('grays', 200), hexrgba: #000, rgba: .8]- actions container background.
12+
/// @requires {function} extend
13+
/// @requires $_light-action-strip
1214
/// @see $default-palette
1315
$_dark-action-strip: extend(
1416
$_light-action-strip,

projects/igniteui-angular/src/lib/core/styles/themes/schemas/dark/_badge.scss

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,25 @@
88

99
/// Generates a dark badge schema.
1010
/// @type {Map}
11-
/// @requires extend
11+
/// @requires {function} extend
1212
/// @requires $_light-badge
1313
/// @see $default-palette
1414
$_dark-badge: extend($_light-badge);
1515

1616
/// Generates a dark fluent badge schema.
1717
/// @type {Map}
18-
/// @requires extend
18+
/// @requires {function} extend
1919
/// @requires $_fluent-badge
2020
$_dark-fluent-badge: extend($_fluent-badge);
2121

2222
/// Generates a dark bootstrap badge schema.
2323
/// @type {Map}
24-
/// @requires extend
24+
/// @requires {function} extend
2525
/// @requires $_bootstrap-badge
2626
$_dark-bootstrap-badge: extend($_bootstrap-badge);
2727

2828
/// Generates a dark indigo badge schema.
2929
/// @type {Map}
30-
/// @requires extend
30+
/// @requires {function} extend
3131
/// @requires $_indigo-badge
3232
$_dark-indigo-badge: extend($_indigo-badge);

projects/igniteui-angular/src/lib/core/styles/themes/schemas/dark/_banner.scss

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,21 @@
77

88
/// Generates a dark banner schema.
99
/// @type {Map}
10-
/// @requires extend
10+
/// @requires {function} extend
1111
/// @requires $_light-banner
1212
/// @see $default-palette
1313
$_dark-banner: extend($_light-banner);
1414

1515
/// Generates a dark fluent banner schema.
1616
/// @type {Map}
17-
/// @requires extend
17+
/// @requires {function} extend
1818
/// @requires $_fluent-banner
1919
$_dark-fluent-banner: extend($_fluent-banner);
2020

2121
/// Generates a dark bootstrap banner schema.
2222
/// @type {Map}
23-
/// @requires extend
23+
/// @property {Map} banner-background [#333]- The background color used banner background.
24+
/// @requires {function} extend
2425
/// @requires $_bootstrap-banner
2526
$_dark-bootstrap-banner: extend(
2627
$_bootstrap-banner,
@@ -31,6 +32,6 @@ $_dark-bootstrap-banner: extend(
3132

3233
/// Generates a dark indigo banner schema.
3334
/// @type {Map}
34-
/// @requires extend
35+
/// @requires {function} extend
3536
/// @requires $_indigo-banner
3637
$_dark-indigo-banner: extend($_indigo-banner);

projects/igniteui-angular/src/lib/core/styles/themes/schemas/dark/_bottom-nav.scss

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ $_dark-bootstrap-bottom-nav: extend($_bootstrap-bottom-nav, $_base-dark-bottom-n
3737
/// Generates a dark indigo bottom-nav schema based on a mix of $_indigo-bottom-nav and $_base-dark-bottom-nav
3838
/// @type {Map}
3939
/// @prop {Map} background [igx-color: 'surface'] - The background color used for the bottom-nav.
40-
/// @prop {Color} active-item-color [#fff] - The text-color used for the active color.
41-
/// @prop {Map} idle-item-color [igx-color: #fff, rgba: .6] - The text-color used for the idle color.
40+
/// @prop {Color} active-item-color [igx-contrast-color: 'surface'] - The text-color used for the active color.
41+
/// @prop {Map} idle-item-color [igx-contrast-color: 'surface', rgba: .6] - The text-color used for the idle color.
4242
/// @requires {function} extend
4343
/// @requires $_indigo-bottom-nav
4444
/// @requires $_base-dark-bottom-nav

projects/igniteui-angular/src/lib/core/styles/themes/schemas/dark/_button-group.scss

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
/// Generates the base dark button-group schema.
1010
/// @type {Map}
1111
/// @prop {Color} item-background [#222] - The background color for button group items.
12-
/// @prop {map} item-border-color [igx-color: ('grays', 400), hexrgba: #222] - The border color for button group items.
13-
/// @prop {map} item-selected-border-color [igx-color: ('grays', 500), hexrgba: #222] - The border color for button group selected items.
14-
/// @prop {map} item-disabled-border: [igx-color: ('grays', 400), hexrgba: #222] - The border color for button group disabled items.
12+
/// @prop {Map} item-border-color [igx-color: ('grays', 400), hexrgba: #222] - The border color for button group items.
13+
/// @prop {Map} item-selected-border-color [igx-color: ('grays', 500), hexrgba: #222] - The border color for button group selected items.
14+
/// @prop {Map} item-disabled-border: [igx-color: ('grays', 400), hexrgba: #222] - The border color for button group disabled items.
1515
$_base-dark-button-group: (
1616
item-background: #222,
1717

@@ -42,15 +42,15 @@ $_dark-button-group: extend($_light-button-group, $_base-dark-button-group);
4242
/// Generates a dark fluent button-group schema based on a mix of $_fluent-button-group and $_base-dark-button-group
4343
/// @type {Map}
4444
///
45-
/// @prop {map} item-border-color [igx-color: ('grays', 100), hexrgba: #000] - The border color for button group items.
46-
/// @prop {map} item-selected-border-color [igx-color: ('grays', 100), hexrgba: #000] - The border color for button group selected items.
47-
/// @prop {map} item-disabled-border: [igx-color: ('grays', 100), hexrgba: #000] - The border color for button group disabled items.
48-
/// @prop {map} item-text-color [igx-color: ('grays', 900)] - The text color for button group items.
49-
/// @prop {map} item-hover-text-color [igx-color: ('primary', 200)] - The text color for button group items on hover.
45+
/// @prop {Map} item-border-color [igx-color: ('grays', 100), hexrgba: #000] - The border color for button group items.
46+
/// @prop {Map} item-selected-border-color [igx-color: ('grays', 100), hexrgba: #000] - The border color for button group selected items.
47+
/// @prop {Map} item-disabled-border: [igx-color: ('grays', 100), hexrgba: #000] - The border color for button group disabled items.
48+
/// @prop {Map} item-text-color [igx-color: ('grays', 900)] - The text color for button group items.
49+
/// @prop {Map} item-hover-text-color [igx-color: ('primary', 200)] - The text color for button group items on hover.
5050
/// @prop {Color} item-hover-background [#222] - The background color for button group items on hover.
51-
/// @prop {map} item-selected-background [igx-color: ('grays', 100)] - The background color for button group selected items.
52-
/// @prop {map} item-selected-hover-background [igx-color: ('grays', 100)] - The background color for button group selected items on hover.
53-
/// @prop {map} item-selected-text-color [igx-color: ('primary', 200)] - The text color for button group selected items.
51+
/// @prop {Map} item-selected-background [igx-color: ('grays', 100)] - The background color for button group selected items.
52+
/// @prop {Map} item-selected-hover-background [igx-color: ('grays', 100)] - The background color for button group selected items on hover.
53+
/// @prop {Map} item-selected-text-color [igx-color: ('primary', 200)] - The text color for button group selected items.
5454
/// @prop {Color} disabled-background-color [#222] - The background color for button group disabled items.
5555
///
5656
/// @requires {function} extend

projects/igniteui-angular/src/lib/core/styles/themes/schemas/dark/_button.scss

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
/// @prop {Map} flat-focus-background [igx-color: ('secondary', 400), rgba: .24] - The focus background color of a flat button.
1313
/// @prop {Map} icon-hover-background [igx-color: ('grays', 300)] - The hover background color of an icon button.
1414
/// @prop {Map} disabled-background [igx-color: ('grays', 200)] - The disabled background color of raised, fab, or icon buttons.
15-
/// @requires extend
15+
/// @requires {function} extend
1616
/// @requires $_light-button
1717
/// @see $default-palette
1818
$_dark-button: extend(
@@ -44,7 +44,7 @@ $_dark-button: extend(
4444
/// @prop {Map} flat-hover-icon-color [igx-color: ('primary', 200)] - The icon color of a flat button on hover.
4545
/// @prop {Map} flat-focus-icon-color [igx-color: ('primary', 200)] - The icon color of a flat button on focus.
4646
/// @prop {Map} flat-hover-text-color [igx-color: ('primary', 200)] - The text color of a flat button on hover.
47-
/// @requires extend
47+
/// @requires {function} extend
4848
/// @requires $_fluent-button
4949
$_dark-fluent-button: extend(
5050
$_fluent-button,
@@ -69,7 +69,10 @@ $_dark-fluent-button: extend(
6969

7070
/// Generates a dark bootstrap button schema.
7171
/// @type {Map}
72-
/// @requires extend
72+
/// @prop {Map} disabled-color [igx-color: ('primary', 900)] - The disabled text/icon color of a button.
73+
/// @prop {Map} disabled-background [igx-color: ('primary', 900), darken: 5%] - The disabled background color of raised, fab, or icon buttons.
74+
/// @prop {Map} outlined-disabled-outline-color [igx-color: ('primary', 900), darken: 5%] - The border color of an outlined button.
75+
/// @requires {function} extend
7376
/// @requires $_bootstrap-button
7477
$_dark-bootstrap-button: extend(
7578
$_bootstrap-button,
@@ -93,12 +96,12 @@ $_dark-bootstrap-button: extend(
9396
/// Generates a dark indigo button schema.
9497
/// @type {Map}
9598
///
96-
/// @prop {map} outlined-hover-background [#fff] - The hover background color of an outlined button.
99+
/// @prop {Map} outlined-hover-background [#fff] - The hover background color of an outlined button.
97100
/// @prop {Color} outlined-hover-text-color [(igx-color: 'surface')] - The hover text color of an outlined button.
98-
/// @prop {map} outlined-focus-background [#fff] - The focus background color of an outlined button.
101+
/// @prop {Map} outlined-focus-background [#fff] - The focus background color of an outlined button.
99102
/// @prop {Color} outlined-focus-text-color [(igx-color: 'surface')] - The focus text color of an outlined button.
100103
///
101-
/// @requires extend
104+
/// @requires {function} extend
102105
/// @requires $_indigo-button
103106
$_dark-indigo-button: extend(
104107
$_indigo-button,

projects/igniteui-angular/src/lib/core/styles/themes/schemas/dark/_calendar.scss

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
/// Generates a dark calendar schema.
99
/// @type {Map}
1010
/// @prop {Map} date-disabled-text-color [igx-color: ('grays', 500), hexrgba: (), rgba: .38] - The text color for disabled dates.
11-
/// @requires extend
11+
/// @requires {function} extend
1212
/// @requires $_light-calendar
1313
/// @see $default-palette
1414
$_dark-calendar: extend($_light-calendar, (
@@ -21,13 +21,15 @@ $_dark-calendar: extend($_light-calendar, (
2121

2222
/// Generates a dark fluent calendar schema.
2323
/// @type {Map}
24-
/// @requires extend
24+
/// @requires {function} extend
2525
/// @requires $_fluent-calendar
2626
$_dark-fluent-calendar: extend($_fluent-calendar);
2727

2828
/// Generates a dark bootstrap calendar schema.
2929
/// @type {Map}
30-
/// @requires extend
30+
/// @prop {Map} content-background [#222] - The main content background color.
31+
/// @prop {Map} picker-text-color [#fff]- The idle picker month/year color.
32+
/// @requires {function} extend
3133
/// @requires $_bootstrap-calendar
3234
$_dark-bootstrap-calendar: extend(
3335
$_bootstrap-calendar,
@@ -54,7 +56,7 @@ $_dark-bootstrap-calendar: extend(
5456
/// @prop {Map} year-current-text-color [igx-contrast-color: ('surface')] - The text color for the current/selected year.
5557
/// @prop {Map} month-current-text-color [igx-contrast-color: ('surface')]- The text color for the current/selected month.
5658
/// @prop {Map} month-hover-current-text-color [igx-contrast-color: ('surface')]- The text color for the current/selected month on hover.
57-
/// @requires extend
59+
/// @requires {function} extend
5860
/// @requires $_indigo-calendar
5961
$_dark-indigo-calendar: extend(
6062
$_indigo-calendar,

projects/igniteui-angular/src/lib/core/styles/themes/schemas/dark/_card.scss

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,21 @@
77

88
/// Generates a dark card schema.
99
/// @type {Map}
10-
/// @requires extend
10+
/// @requires {function} extend
1111
/// @requires $_light-card
1212
/// @see $default-palette
1313
$_dark-card: extend($_light-card);
1414

1515
/// Generates a dark fluent card schema.
1616
/// @type {Map}
17-
/// @requires extend
17+
/// @requires {function} extend
1818
/// @requires $_fluent-card
1919
$_dark-fluent-card: extend($_fluent-card);
2020

2121
/// Generates a dark bootstrap card schema.
2222
/// @type {Map}
2323
/// @prop {Map} background [#222]- The card background color.
24-
/// @requires extend
24+
/// @requires {function} extend
2525
/// @requires $_bootstrap-card
2626
$_dark-bootstrap-card: extend(
2727
$_bootstrap-card,
@@ -33,7 +33,7 @@ $_dark-bootstrap-card: extend(
3333
/// Generates a dark indigo card schema.
3434
/// @type {Map}
3535
/// @prop {Map} outline-color [igx-color: ('grays', 200)] - The outline color of an outlined type card.
36-
/// @requires extend
36+
/// @requires {function} extend
3737
/// @requires $_indigo-card
3838
$_dark-indigo-card: extend(
3939
$_indigo-card,

projects/igniteui-angular/src/lib/core/styles/themes/schemas/dark/_carousel.scss

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,22 +28,22 @@ $_base-dark-carousel: (
2828

2929
/// Generates a dark carousel schema based on a mix of $_light-carousel and $_base-dark-carousel
3030
/// @type {Map}
31-
/// @requires extend
31+
/// @requires {function} extend
3232
/// @requires $_light-carousel
3333
/// @requires $_base-dark-carousel
3434
/// @see $default-palette
3535
$_dark-carousel: extend($_light-carousel, $_base-dark-carousel);
3636

3737
/// Generates a dark fluent carousel schema based on a mix of $_fluent-carousel and $_base-dark-carousel
3838
/// @type {Map}
39-
/// @requires extend
39+
/// @requires {function} extend
4040
/// @requires $_fluent-carousel
4141
/// @requires $_base-dark-carousel
4242
$_dark-fluent-carousel: extend($_fluent-carousel, $_base-dark-carousel);
4343

4444
/// Generates a dark bootstrap carousel schema based on a mix of $_bootstrap-carousel and $_base-dark-carousel
4545
/// @type {Map}
46-
/// @requires extend
46+
/// @requires {function} extend
4747
/// @requires $_bootstrap-carousel
4848
/// @requires $_base-dark-carousel
4949
$_dark-bootstrap-carousel: extend($_bootstrap-carousel, $_base-dark-carousel);
@@ -55,7 +55,7 @@ $_dark-bootstrap-carousel: extend($_bootstrap-carousel, $_base-dark-carousel);
5555
/// @prop {Color} button-hover-background [igx-color: ('grays', 300)] - The previous/next buttons hover background color.
5656
/// @prop {Color} indicator-dot-color [igx-color: ('grays', 600)] - The idle indicator dot color.
5757
/// @prop {Color} indicator-active-dot-color [igx-color: ('grays', 900)] - The active indicator dot color.
58-
/// @requires extend
58+
/// @requires {function} extend
5959
/// @requires $_indigo-carousel
6060
/// @requires $_base-dark-carousel
6161
$_dark-indigo-carousel: extend($_indigo-carousel, (

projects/igniteui-angular/src/lib/core/styles/themes/schemas/dark/_checkbox.scss

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
/// Generates a dark checkbox schema.
99
/// @type {Map}
1010
/// @prop {Color} tick-color [#222] - The checked mark color.
11-
/// @requires extend
11+
/// @requires {function} extend
1212
/// @requires $_light-checkbox
1313
/// @see $default-palette
1414
$_dark-checkbox: extend($_light-checkbox, (
@@ -18,7 +18,7 @@ $_dark-checkbox: extend($_light-checkbox, (
1818
/// Generates a dark fluent checkbox schema.
1919
/// @type {Map}
2020
/// @prop {Color} tick-color [#fff] - The checked mark color.
21-
/// @requires extend
21+
/// @requires {function} extend
2222
/// @requires $_fluent-checkbox
2323
$_dark-fluent-checkbox: extend($_fluent-checkbox, (
2424
tick-color: #fff
@@ -27,7 +27,7 @@ $_dark-fluent-checkbox: extend($_fluent-checkbox, (
2727
/// Generates a dark bootstrap checkbox schema.
2828
/// @type {Map}
2929
/// @prop {Color} tick-color [#fff] - The checked mark color.
30-
/// @requires extend
30+
/// @requires {function} extend
3131
/// @requires $_bootstrap-checkbox
3232
$_dark-bootstrap-checkbox: extend($_bootstrap-checkbox);
3333

@@ -37,7 +37,7 @@ $_dark-bootstrap-checkbox: extend($_bootstrap-checkbox);
3737
/// @prop {Color} empty-color [igx-color: ('grays', 700)] - The unchecked border color.
3838
/// @prop {Color} disabled-color [igx-color: ('grays', 400)] - The disabled border and fill colors.
3939
/// @prop {Color} disabled-color-label [igx-color: ('grays', 400)] - The disabled label color.
40-
/// @requires extend
40+
/// @requires {function} extend
4141
/// @requires $_indigo-checkbox
4242
$_dark-indigo-checkbox: extend($_indigo-checkbox, (
4343
fill-color: #fff,

0 commit comments

Comments
 (0)