Skip to content

Commit f0ce419

Browse files
committed
docs(themes): add missing docs around theme mixins
Closes #12622
1 parent 2c644b1 commit f0ce419

File tree

4 files changed

+32
-18
lines changed

4 files changed

+32
-18
lines changed

projects/igniteui-angular/src/lib/core/styles/themes/generators/_base.scss

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,12 @@
1010
@use 'igniteui-theming/sass/themes' as *;
1111
@use 'igniteui-theming/sass/themes/charts' as *;
1212

13+
////
1314
/// @group themes
1415
/// @access public
16+
/// @author <a href="https://github.com/simeonoff" target="_blank">Simeon Simeonoff</a>
17+
////
18+
1519
/// Generates an Ignite UI for Angular global theme.
1620
/// @param {Map} $palette - An palette to be used by the global theme.
1721
/// @param {Map} $schema [$light-schema] - The schema used as basis for styling the components.
@@ -442,11 +446,10 @@
442446
}
443447
}
444448

445-
/// @group themes
446-
/// @access public
447-
/// Creates a global material theme that can be used with light backgrounds.
449+
/// A wrapper around the theme mixin. Creates a global material theme that can be used with light backgrounds.
448450
/// @param {Map} $palette - An palette to be used by the global theme.
449451
/// @param {List} $exclude [( )] - A list of ig components to be excluded from the global theme styles.
452+
/// @see {mixin} theme
450453
@mixin light-theme(
451454
$palette,
452455
$exclude: (),
@@ -476,11 +479,10 @@
476479
);
477480
}
478481

479-
/// @group themes
480-
/// @access public
481-
/// Creates a global material theme that can be used with dark backgrounds.
482+
/// A wrapper around the theme mixin. Creates a global material theme that can be used with dark backgrounds.
482483
/// @param {Map} $palette - An palette to be used by the global theme.
483484
/// @param {List} $exclude [( )] - A list of igx components to be excluded from the global theme styles.
485+
/// @see {mixin} theme
484486
@mixin dark-theme(
485487
$palette,
486488
$exclude: (),

projects/igniteui-angular/src/lib/core/styles/themes/generators/_bootstrap.scss

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,16 @@
22
@use '../schemas' as *;
33
@use 'igniteui-theming/sass/color' as *;
44

5+
////
56
/// @group themes
67
/// @access public
7-
/// Creates a global bootstrap-like theme that can be used with light backgrounds.
8+
/// @author <a href="https://github.com/simeonoff" target="_blank">Simeon Simeonoff</a>
9+
////
10+
11+
/// A wrapper around the theme mixin. Creates a global bootstrap-like theme that can be used with light backgrounds.
812
/// @param {Map} $palette - An palette to be used by the global theme.
913
/// @param {List} $exclude [( )] - A list of ig components to be excluded from the global theme styles.
14+
/// @see {mixin} theme
1015
@mixin bootstrap-light-theme(
1116
$palette,
1217
$exclude: (),
@@ -39,11 +44,10 @@
3944
);
4045
}
4146

42-
/// @group themes
43-
/// @access public
44-
/// Creates a global bootstrap-like theme that can be used with dark backgrounds.
47+
/// A wrapper around the theme mixin. Creates a global bootstrap-like theme that can be used with dark backgrounds.
4548
/// @param {Map} $palette - An palette to be used by the global theme.
4649
/// @param {List} $exclude [( )] - A list of ig components to be excluded from the global theme styles.
50+
/// @see {mixin} theme
4751
@mixin bootstrap-dark-theme(
4852
$palette,
4953
$exclude: (),

projects/igniteui-angular/src/lib/core/styles/themes/generators/_fluent.scss

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,16 @@
22
@use '../schemas' as *;
33
@use 'igniteui-theming/sass/color' as *;
44

5+
////
56
/// @group themes
67
/// @access public
7-
/// Creates a global fluent theme that can be used with light backgrounds.
8+
/// @author <a href="https://github.com/simeonoff" target="_blank">Simeon Simeonoff</a>
9+
////
10+
11+
/// A wrapper around the theme mixin. Creates a global fluent theme that can be used with light backgrounds.
812
/// @param {Map} $palette - An palette to be used by the global theme.
913
/// @param {List} $exclude [( )] - A list of ig components to be excluded from the global theme styles.
14+
/// @see {mixin} theme
1015
@mixin fluent-light-theme(
1116
$palette,
1217
$exclude: (),
@@ -39,11 +44,10 @@
3944
);
4045
}
4146

42-
/// @group themes
43-
/// @access public
44-
/// Creates a global fluent theme that can be used with dark backgrounds.
47+
/// A wrapper around the theme mixin. Creates a global fluent theme that can be used with dark backgrounds.
4548
/// @param {Map} $palette - An palette to be used by the global theme.
4649
/// @param {List} $exclude [( )] - A list of ig components to be excluded from the global theme styles.
50+
/// @see {mixin} theme
4751
@mixin fluent-dark-theme(
4852
$palette,
4953
$exclude: (),

projects/igniteui-angular/src/lib/core/styles/themes/generators/_indigo.scss

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,16 @@
22
@use '../schemas' as *;
33
@use 'igniteui-theming/sass/color' as *;
44

5+
////
56
/// @group themes
67
/// @access public
7-
/// Creates a global indigo theme that can be used with light backgrounds.
8+
/// @author <a href="https://github.com/simeonoff" target="_blank">Simeon Simeonoff</a>
9+
////
10+
11+
/// A wrapper around the theme mixin. Creates a global indigo theme that can be used with light backgrounds.
812
/// @param {Map} $palette - An palette to be used by the global theme.
913
/// @param {List} $exclude [( )] - A list of ig components to be excluded from the global theme styles.
14+
/// @see {mixin} theme
1015
@mixin indigo-light-theme(
1116
$palette,
1217
$exclude: (),
@@ -39,11 +44,10 @@
3944
);
4045
}
4146

42-
/// @group themes
43-
/// @access public
44-
/// Creates a global indigo theme that can be used with dark backgrounds.
47+
/// A wrapper around the theme mixin. Creates a global indigo theme that can be used with dark backgrounds.
4548
/// @param {Map} $palette - An palette to be used by the global theme.
4649
/// @param {List} $exclude [( )] - A list of ig components to be excluded from the global theme styles.
50+
/// @see {mixin} theme
4751
@mixin indigo-dark-theme(
4852
$palette,
4953
$exclude: (),

0 commit comments

Comments
 (0)