Skip to content

Commit b8633b3

Browse files
committed
docs: add mediaplayer variable descriptions
1 parent 5e64c25 commit b8633b3

File tree

5 files changed

+122
-14
lines changed

5 files changed

+122
-14
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,43 @@
11
// Media player
2+
3+
/// The border width of the MediaPlayer.
4+
/// @group mediaplayer
25
$kendo-media-player-border-width: 1px !default;
6+
/// The font family of the MediaPlayer.
7+
/// @group mediaplayer
38
$kendo-media-player-font-family: var( --kendo-font-family, inherit ) !default;
9+
/// The font size of the MediaPlayer.
10+
/// @group mediaplayer
411
$kendo-media-player-font-size: var( --kendo-font-size, inherit ) !default;
12+
/// The line height of the MediaPlayer.
13+
/// @group mediaplayer
514
$kendo-media-player-line-height: var( --kendo-line-height, normal ) !default;
615

16+
/// The background color of the MediaPlayer.
17+
/// @group mediaplayer
718
$kendo-media-player-bg: $kendo-component-bg !default;
19+
/// The text color of the MediaPlayer.
20+
/// @group mediaplayer
821
$kendo-media-player-text: $kendo-component-text !default;
22+
/// The border color of the MediaPlayer.
23+
/// @group mediaplayer
924
$kendo-media-player-border: $kendo-component-border !default;
1025

26+
/// The horizontal padding of the MediaPlayer title.
27+
/// @group mediaplayer
1128
$kendo-media-player-titlebar-padding-x: k-spacing(2) !default;
29+
/// The vertical padding of the MediaPlayer title.
30+
/// @group mediaplayer
1231
$kendo-media-player-titlebar-padding-y: k-spacing(2) !default;
32+
/// The background color of the MediaPlayer title.
33+
/// @group mediaplayer
1334
$kendo-media-player-titlebar-bg: null !default;
35+
/// The text color of the MediaPlayer title.
36+
/// @group mediaplayer
1437
$kendo-media-player-titlebar-text: $kendo-media-player-bg !default;
38+
/// The border color of the MediaPlayer title.
39+
/// @group mediaplayer
1540
$kendo-media-player-titlebar-border: null !default;
41+
/// The gradient of the MediaPlayer title.
42+
/// @group mediaplayer
1643
$kendo-media-player-titlebar-gradient: if($kendo-enable-color-system, ( color-mix(in srgb, k-color( on-app-surface ) 70%, transparent), color-mix(in srgb, k-color( on-app-surface ) 0%, transparent) ), ( rgba( $kendo-media-player-text, .7 ), rgba( $kendo-media-player-text, 0 ) )) !default;
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,43 @@
11
// Media player
2+
3+
/// The border width of the MediaPlayer.
4+
/// @group mediaplayer
25
$kendo-media-player-border-width: 1px !default;
6+
/// The font family of the MediaPlayer.
7+
/// @group mediaplayer
38
$kendo-media-player-font-family: var( --kendo-font-family, inherit ) !default;
9+
/// The font size of the MediaPlayer.
10+
/// @group mediaplayer
411
$kendo-media-player-font-size: var( --kendo-font-size, inherit ) !default;
12+
/// The line height of the MediaPlayer.
13+
/// @group mediaplayer
514
$kendo-media-player-line-height: var( --kendo-line-height, normal ) !default;
615

16+
/// The background color of the MediaPlayer.
17+
/// @group mediaplayer
718
$kendo-media-player-bg: $kendo-component-bg !default;
19+
/// The text color of the MediaPlayer.
20+
/// @group mediaplayer
821
$kendo-media-player-text: $kendo-component-text !default;
22+
/// The border color of the MediaPlayer.
23+
/// @group mediaplayer
924
$kendo-media-player-border: $kendo-component-border !default;
1025

26+
/// The horizontal padding of the MediaPlayer title.
27+
/// @group mediaplayer
1128
$kendo-media-player-titlebar-padding-x: k-spacing(2) !default;
29+
/// The vertical padding of the MediaPlayer title.
30+
/// @group mediaplayer
1231
$kendo-media-player-titlebar-padding-y: k-spacing(2) !default;
32+
/// The background color of the MediaPlayer title.
33+
/// @group mediaplayer
1334
$kendo-media-player-titlebar-bg: null !default;
35+
/// The text color of the MediaPlayer title.
36+
/// @group mediaplayer
1437
$kendo-media-player-titlebar-text: $kendo-media-player-bg !default;
38+
/// The border color of the MediaPlayer title.
39+
/// @group mediaplayer
1540
$kendo-media-player-titlebar-border: null !default;
41+
/// The gradient of the MediaPlayer title.
42+
/// @group mediaplayer
1643
$kendo-media-player-titlebar-gradient: if($kendo-enable-color-system, ( color-mix(in srgb, k-color( on-app-surface ) 70%, transparent), color-mix(in srgb, k-color( on-app-surface ) 0%, transparent) ), ( rgba( $kendo-media-player-text, .7 ), rgba( $kendo-media-player-text, 0 ) )) !default;
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,43 @@
11
// Media player
2+
3+
/// The border width of the MediaPlayer.
4+
/// @group mediaplayer
25
$kendo-media-player-border-width: 1px !default;
6+
/// The font family of the MediaPlayer.
7+
/// @group mediaplayer
38
$kendo-media-player-font-family: var( --kendo-font-family, inherit ) !default;
9+
/// The font size of the MediaPlayer.
10+
/// @group mediaplayer
411
$kendo-media-player-font-size: var( --kendo-font-size, inherit ) !default;
12+
/// The line height of the MediaPlayer.
13+
/// @group mediaplayer
514
$kendo-media-player-line-height: var( --kendo-line-height, normal ) !default;
615

16+
/// The background color of the MediaPlayer.
17+
/// @group mediaplayer
718
$kendo-media-player-bg: $kendo-component-bg !default;
19+
/// The text color of the MediaPlayer.
20+
/// @group mediaplayer
821
$kendo-media-player-text: $kendo-component-text !default;
22+
/// The border color of the MediaPlayer.
23+
/// @group mediaplayer
924
$kendo-media-player-border: $kendo-component-border !default;
1025

26+
/// The horizontal padding of the MediaPlayer title.
27+
/// @group mediaplayer
1128
$kendo-media-player-titlebar-padding-x: k-spacing(2) !default;
29+
/// The vertical padding of the MediaPlayer title.
30+
/// @group mediaplayer
1231
$kendo-media-player-titlebar-padding-y: k-spacing(2) !default;
32+
/// The background color of the MediaPlayer title.
33+
/// @group mediaplayer
1334
$kendo-media-player-titlebar-bg: null !default;
35+
/// The text color of the MediaPlayer title.
36+
/// @group mediaplayer
1437
$kendo-media-player-titlebar-text: $kendo-media-player-bg !default;
38+
/// The border color of the MediaPlayer title.
39+
/// @group mediaplayer
1540
$kendo-media-player-titlebar-border: null !default;
41+
/// The gradient of the MediaPlayer title.
42+
/// @group mediaplayer
1643
$kendo-media-player-titlebar-gradient: if($kendo-enable-color-system, ( color-mix(in srgb, k-color( on-app-surface ) 70%, transparent), color-mix(in srgb, k-color( on-app-surface ) 0%, transparent) ), ( rgba( $kendo-media-player-text, .7 ), rgba( $kendo-media-player-text, 0 ) )) !default;
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,49 @@
11
@use "sass:map";
22
@use "../core/" as *;
33

4-
/// Border width of the mediaplayer.
4+
/// The border width of the MediaPlayer.
55
/// @group mediaplayer
66
$kendo-media-player-border-width: 1px !default;
7-
/// Font family of the mediaplayer.
7+
/// The font family of the MediaPlayer.
88
/// @group mediaplayer
99
$kendo-media-player-font-family: var( --kendo-font-family, inherit ) !default;
10-
/// Font size of the mediaplayer.
10+
/// The font size of the MediaPlayer.
1111
/// @group mediaplayer
1212
$kendo-media-player-font-size: var( --kendo-font-size, inherit ) !default;
13-
/// Line height of the mediaplayer.
13+
/// The line height of the MediaPlayer.
1414
/// @group mediaplayer
1515
$kendo-media-player-line-height: var( --kendo-line-height, normal ) !default;
1616

17-
/// Background color of the mediaplayer.
17+
/// The background color of the MediaPlayer.
1818
/// @group mediaplayer
1919
$kendo-media-player-bg: var( --kendo-component-bg, inherit ) !default;
20-
/// Text color of the mediaplayer.
20+
/// The text color of the MediaPlayer.
2121
/// @group mediaplayer
2222
$kendo-media-player-text: var( --kendo-component-text, inherit ) !default;
23-
/// Border color of the mediaplayer.
23+
/// The border color of the MediaPlayer.
2424
/// @group mediaplayer
2525
$kendo-media-player-border: var( --kendo-component-border, inherit ) !default;
2626

27-
/// Mediaplayer overlay background color.
27+
/// The background color of the MediaPlayer overlay.
2828
/// @group mediaplayer
2929
$kendo-media-player-overlay-bg: if($kendo-enable-color-system, k-color( base-emphasis ), k-get-theme-color-var( neutral-130 )) !default;
3030

31-
/// Mediaplayer quality button border color.
31+
/// The border color of the MediaPlayer button.
3232
/// @group mediaplayer
3333
$kendo-media-player-quality-border: if($kendo-enable-color-system, k-color( border ), k-get-theme-color-var( neutral-110 )) !default;
3434

35-
/// Media player title font size.
35+
/// The font size of the MediaPlayer title.
3636
/// @group mediaplayer
3737
$kendo-media-player-title-font-size: var( --kendo-font-size-xl, inherit ) !default;
38-
/// Mediaplayer titlebar horizontal padding.
38+
/// The horizontal padding of the MediaPlayer title.
3939
/// @group mediaplayer
4040
$kendo-media-player-titlebar-padding-x: k-spacing(2) !default;
41-
/// Mediaplayer titlebar vertical padding.
41+
/// The vertical padding of the MediaPlayer title.
4242
/// @group mediaplayer
4343
$kendo-media-player-titlebar-padding-y: k-spacing(2) !default;
44-
/// Mediaplayer titlebar background color.
44+
/// The background color of the MediaPlayer title.
4545
/// @group mediaplayer
4646
$kendo-media-player-titlebar-bg: if($kendo-enable-color-system, color-mix(in srgb, k-color( on-app-surface ) 40%, transparent), rgba( $kendo-color-black, .4 )) !default;
47-
/// Mediaplayer titlebar text color.
47+
/// The text color of the MediaPlayer title.
4848
/// @group mediaplayer
4949
$kendo-media-player-titlebar-text: $kendo-media-player-bg !default;
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,43 @@
11
// Media player
2+
3+
/// The border width of the MediaPlayer.
4+
/// @group mediaplayer
25
$kendo-media-player-border-width: 1px !default;
6+
/// The font family of the MediaPlayer.
7+
/// @group mediaplayer
38
$kendo-media-player-font-family: var( --kendo-font-family, inherit ) !default;
9+
/// The font size of the MediaPlayer.
10+
/// @group mediaplayer
411
$kendo-media-player-font-size: var( --kendo-font-size, inherit ) !default;
12+
/// The line height of the MediaPlayer.
13+
/// @group mediaplayer
514
$kendo-media-player-line-height: var( --kendo-line-height, normal ) !default;
615

16+
/// The background color of the MediaPlayer.
17+
/// @group mediaplayer
718
$kendo-media-player-bg: $kendo-component-bg !default;
19+
/// The text color of the MediaPlayer.
20+
/// @group mediaplayer
821
$kendo-media-player-text: $kendo-component-text !default;
22+
/// The border color of the MediaPlayer.
23+
/// @group mediaplayer
924
$kendo-media-player-border: $kendo-component-border !default;
1025

26+
/// The horizontal padding of the MediaPlayer title.
27+
/// @group mediaplayer
1128
$kendo-media-player-titlebar-padding-x: k-spacing(2) !default;
29+
/// The vertical padding of the MediaPlayer title.
30+
/// @group mediaplayer
1231
$kendo-media-player-titlebar-padding-y: k-spacing(2) !default;
32+
/// The background color of the MediaPlayer title.
33+
/// @group mediaplayer
1334
$kendo-media-player-titlebar-bg: null !default;
35+
/// The text color of the MediaPlayer title.
36+
/// @group mediaplayer
1437
$kendo-media-player-titlebar-text: $kendo-media-player-bg !default;
38+
/// The border color of the MediaPlayer title.
39+
/// @group mediaplayer
1540
$kendo-media-player-titlebar-border: null !default;
41+
/// The gradient of the MediaPlayer title.
42+
/// @group mediaplayer
1643
$kendo-media-player-titlebar-gradient: if($kendo-enable-color-system, ( color-mix(in srgb, k-color( on-app-surface ) 70%, transparent), color-mix(in srgb, k-color( on-app-surface ) 0%, transparent) ), ( rgba( $kendo-media-player-text, .7 ), rgba( $kendo-media-player-text, 0 ) )) !default;

0 commit comments

Comments
 (0)