igniteui-theming 25.0.0 → 25.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (281) hide show
  1. package/README.md +2 -2
  2. package/dist/mcp/generators/css.js +1 -8
  3. package/dist/mcp/generators/sass.d.ts +1 -1
  4. package/dist/mcp/generators/sass.js +26 -3
  5. package/dist/mcp/index.js +3 -3
  6. package/dist/mcp/json/components/themes.json.js +17 -17
  7. package/dist/mcp/knowledge/docs/setup/platform.md.js +4 -0
  8. package/dist/mcp/knowledge/index.d.ts +1 -1
  9. package/dist/mcp/knowledge/index.js +1 -4
  10. package/dist/mcp/knowledge/platform-setup.d.ts +2 -0
  11. package/dist/mcp/knowledge/platforms/index.d.ts +8 -11
  12. package/dist/mcp/knowledge/platforms/index.js +22 -14
  13. package/dist/mcp/knowledge/platforms/react.d.ts +2 -2
  14. package/dist/mcp/knowledge/platforms/react.js +3 -3
  15. package/dist/mcp/knowledge/sass-api.d.ts +2 -2
  16. package/dist/mcp/resources/presets.d.ts +12 -0
  17. package/dist/mcp/resources/presets.js +44 -1
  18. package/dist/mcp/tools/descriptions.d.ts +8 -8
  19. package/dist/mcp/tools/descriptions.js +25 -7
  20. package/dist/mcp/tools/handlers/component-theme.js +23 -5
  21. package/dist/mcp/tools/handlers/custom-palette.js +2 -1
  22. package/dist/mcp/tools/handlers/elevations.js +2 -1
  23. package/dist/mcp/tools/handlers/layout.js +1 -1
  24. package/dist/mcp/tools/handlers/palette.js +2 -3
  25. package/dist/mcp/tools/handlers/platform.js +247 -86
  26. package/dist/mcp/tools/handlers/theme.js +3 -0
  27. package/dist/mcp/tools/handlers/typography.js +2 -1
  28. package/dist/mcp/tools/schemas.d.ts +31 -31
  29. package/dist/mcp/utils/sass.d.ts +20 -0
  30. package/dist/mcp/utils/sass.js +16 -0
  31. package/dist/mcp/utils/types.d.ts +2 -1
  32. package/dist/mcp/utils/types.js +2 -1
  33. package/json/components/bootstrap.json +1 -1
  34. package/json/components/fluent.json +1 -1
  35. package/json/components/indigo.json +1 -1
  36. package/json/components/material.json +1 -1
  37. package/json/components/themes.json +53 -28
  38. package/package.json +15 -7
  39. package/sass/animations/_easings.scss +24 -24
  40. package/sass/bem/_index.scss +16 -14
  41. package/sass/color/_charts.scss +20 -20
  42. package/sass/color/_functions.scss +18 -18
  43. package/sass/color/_mixins.scss +1 -1
  44. package/sass/elevations/_functions.scss +4 -4
  45. package/sass/elevations/_mixins.scss +2 -2
  46. package/sass/elevations/presets/_index.scss +3 -3
  47. package/sass/elevations/presets/_indigo.scss +16 -16
  48. package/sass/elevations/presets/_material.scss +3 -3
  49. package/sass/tailwind/utilities/_common.scss +1 -1
  50. package/sass/themes/_functions.scss +15 -15
  51. package/sass/themes/_mixins.scss +9 -9
  52. package/sass/themes/charts/_category-chart-theme.scss +2 -9
  53. package/sass/themes/charts/_data-chart-theme.scss +1 -1
  54. package/sass/themes/charts/_doughnut-chart-theme.scss +1 -1
  55. package/sass/themes/charts/_financial-chart-theme.scss +2 -9
  56. package/sass/themes/charts/_funnel-chart-theme.scss +1 -1
  57. package/sass/themes/charts/_gauge-theme.scss +2 -2
  58. package/sass/themes/charts/_geo-map-theme.scss +1 -1
  59. package/sass/themes/charts/_graph-theme.scss +1 -1
  60. package/sass/themes/charts/_pie-chart-theme.scss +1 -1
  61. package/sass/themes/charts/_shape-chart-theme.scss +2 -9
  62. package/sass/themes/charts/_sparkline-theme.scss +2 -2
  63. package/sass/themes/components/action-strip/_action-strip-theme.scss +1 -1
  64. package/sass/themes/components/avatar/_avatar-theme.scss +2 -2
  65. package/sass/themes/components/badge/_badge-theme.scss +2 -2
  66. package/sass/themes/components/banner/_banner-theme.scss +1 -1
  67. package/sass/themes/components/bottom-nav/_bottom-nav-theme.scss +2 -2
  68. package/sass/themes/components/button/_button-theme.scss +5 -5
  69. package/sass/themes/components/button/_contained-button-theme.scss +5 -5
  70. package/sass/themes/components/button/_fab-button-theme.scss +5 -5
  71. package/sass/themes/components/button/_flat-button-theme.scss +17 -17
  72. package/sass/themes/components/button/_outlined-button-theme.scss +17 -17
  73. package/sass/themes/components/button-group/_button-group-theme.scss +5 -5
  74. package/sass/themes/components/calendar/_calendar-theme.scss +18 -20
  75. package/sass/themes/components/card/_card-theme.scss +3 -3
  76. package/sass/themes/components/carousel/_carousel-theme.scss +8 -8
  77. package/sass/themes/components/chat/_chat-theme.scss +1 -1
  78. package/sass/themes/components/checkbox/_checkbox-theme.scss +6 -6
  79. package/sass/themes/components/chip/_chip-theme.scss +5 -5
  80. package/sass/themes/components/column-actions/_column-actions-theme.scss +1 -1
  81. package/sass/themes/components/combo/_combo-theme.scss +3 -3
  82. package/sass/themes/components/dialog/_dialog-theme.scss +4 -4
  83. package/sass/themes/components/divider/_divider-theme.scss +1 -1
  84. package/sass/themes/components/dock-manager/_dock-manager-theme.scss +1 -1
  85. package/sass/themes/components/drop-down/_drop-down-theme.scss +10 -10
  86. package/sass/themes/components/expansion-panel/_expansion-panel-theme.scss +4 -4
  87. package/sass/themes/components/grid/_grid-summary-theme.scss +3 -3
  88. package/sass/themes/components/grid/_grid-theme.scss +56 -17
  89. package/sass/themes/components/grid/_grid-toolbar-theme.scss +1 -1
  90. package/sass/themes/components/highlight/_highlight-theme.scss +1 -1
  91. package/sass/themes/components/icon/_icon-theme.scss +1 -1
  92. package/sass/themes/components/icon-button/_contained-icon-button-theme.scss +8 -8
  93. package/sass/themes/components/icon-button/_flat-icon-button-theme.scss +12 -12
  94. package/sass/themes/components/icon-button/_icon-button-theme.scss +4 -4
  95. package/sass/themes/components/icon-button/_outlined-icon-button-theme.scss +13 -13
  96. package/sass/themes/components/input/_file-input-theme.scss +1 -1
  97. package/sass/themes/components/input/_input-theme.scss +23 -23
  98. package/sass/themes/components/list/_list-theme.scss +6 -6
  99. package/sass/themes/components/navbar/_navbar-theme.scss +4 -4
  100. package/sass/themes/components/navdrawer/_navdrawer-theme.scss +3 -3
  101. package/sass/themes/components/overlay/_overlay-theme.scss +1 -1
  102. package/sass/themes/components/paginator/_paginator-theme.scss +1 -1
  103. package/sass/themes/components/progress/_circular-theme.scss +1 -1
  104. package/sass/themes/components/progress/_linear-theme.scss +1 -1
  105. package/sass/themes/components/query-builder/_query-builder-theme.scss +2 -2
  106. package/sass/themes/components/radio/_radio-theme.scss +5 -5
  107. package/sass/themes/components/rating/_rating-theme.scss +1 -1
  108. package/sass/themes/components/ripple/_ripple-theme.scss +1 -1
  109. package/sass/themes/components/scrollbar/_scrollbar-theme.scss +1 -1
  110. package/sass/themes/components/select/_select-theme.scss +1 -1
  111. package/sass/themes/components/slider/_slider-theme.scss +7 -7
  112. package/sass/themes/components/snackbar/_snackbar-theme.scss +2 -2
  113. package/sass/themes/components/splitter/_splitter-theme.scss +1 -1
  114. package/sass/themes/components/stepper/_stepper-theme.scss +2 -2
  115. package/sass/themes/components/switch/_switch-theme.scss +13 -13
  116. package/sass/themes/components/tabs/_tabs-theme.scss +8 -8
  117. package/sass/themes/components/time-picker/_time-picker-theme.scss +8 -8
  118. package/sass/themes/components/toast/_toast-theme.scss +3 -3
  119. package/sass/themes/components/tooltip/_tooltip-theme.scss +2 -2
  120. package/sass/themes/components/tree/_tree-theme.scss +17 -17
  121. package/sass/themes/components/watermark/_watermark-theme.scss +1 -1
  122. package/sass/themes/schemas/charts/dark/_category-chart.scss +5 -5
  123. package/sass/themes/schemas/charts/dark/_data-chart.scss +5 -5
  124. package/sass/themes/schemas/charts/dark/_doughnut-chart.scss +5 -5
  125. package/sass/themes/schemas/charts/dark/_financial-chart.scss +5 -5
  126. package/sass/themes/schemas/charts/dark/_funnel-chart.scss +5 -5
  127. package/sass/themes/schemas/charts/dark/_gauge.scss +9 -9
  128. package/sass/themes/schemas/charts/dark/_geo-map.scss +5 -5
  129. package/sass/themes/schemas/charts/dark/_graph.scss +5 -5
  130. package/sass/themes/schemas/charts/dark/_pie-chart.scss +5 -5
  131. package/sass/themes/schemas/charts/dark/_shape-chart.scss +5 -5
  132. package/sass/themes/schemas/charts/dark/_sparkline.scss +5 -5
  133. package/sass/themes/schemas/charts/light/_category-chart.scss +8 -8
  134. package/sass/themes/schemas/charts/light/_data-chart.scss +8 -8
  135. package/sass/themes/schemas/charts/light/_doughnut-chart.scss +8 -8
  136. package/sass/themes/schemas/charts/light/_financial-chart.scss +8 -8
  137. package/sass/themes/schemas/charts/light/_funnel-chart.scss +8 -8
  138. package/sass/themes/schemas/charts/light/_gauge.scss +19 -19
  139. package/sass/themes/schemas/charts/light/_geo-map.scss +8 -8
  140. package/sass/themes/schemas/charts/light/_graph.scss +8 -8
  141. package/sass/themes/schemas/charts/light/_pie-chart.scss +8 -8
  142. package/sass/themes/schemas/charts/light/_shape-chart.scss +8 -8
  143. package/sass/themes/schemas/charts/light/_sparkline.scss +9 -9
  144. package/sass/themes/schemas/components/dark/_action-strip.scss +5 -5
  145. package/sass/themes/schemas/components/dark/_avatar.scss +5 -5
  146. package/sass/themes/schemas/components/dark/_badge.scss +5 -5
  147. package/sass/themes/schemas/components/dark/_banner.scss +5 -5
  148. package/sass/themes/schemas/components/dark/_bottom-nav.scss +5 -5
  149. package/sass/themes/schemas/components/dark/_button-group.scss +6 -6
  150. package/sass/themes/schemas/components/dark/_button.scss +65 -65
  151. package/sass/themes/schemas/components/dark/_calendar.scss +24 -24
  152. package/sass/themes/schemas/components/dark/_card.scss +5 -5
  153. package/sass/themes/schemas/components/dark/_carousel.scss +5 -5
  154. package/sass/themes/schemas/components/dark/_chat.scss +5 -5
  155. package/sass/themes/schemas/components/dark/_checkbox.scss +5 -5
  156. package/sass/themes/schemas/components/dark/_chip.scss +7 -7
  157. package/sass/themes/schemas/components/dark/_column-actions.scss +5 -5
  158. package/sass/themes/schemas/components/dark/_combo.scss +6 -6
  159. package/sass/themes/schemas/components/dark/_date-picker.scss +8 -8
  160. package/sass/themes/schemas/components/dark/_date-range-picker.scss +5 -5
  161. package/sass/themes/schemas/components/dark/_dialog.scss +5 -5
  162. package/sass/themes/schemas/components/dark/_divider.scss +5 -5
  163. package/sass/themes/schemas/components/dark/_dock-manager.scss +5 -5
  164. package/sass/themes/schemas/components/dark/_drop-down.scss +5 -5
  165. package/sass/themes/schemas/components/dark/_expansion-panel.scss +5 -5
  166. package/sass/themes/schemas/components/dark/_file-input.scss +5 -5
  167. package/sass/themes/schemas/components/dark/_grid-filtering.scss +5 -5
  168. package/sass/themes/schemas/components/dark/_grid-summary.scss +9 -9
  169. package/sass/themes/schemas/components/dark/_grid-toolbar.scss +5 -5
  170. package/sass/themes/schemas/components/dark/_grid.scss +57 -14
  171. package/sass/themes/schemas/components/dark/_highlight.scss +7 -7
  172. package/sass/themes/schemas/components/dark/_icon-button.scss +46 -46
  173. package/sass/themes/schemas/components/dark/_icon.scss +5 -5
  174. package/sass/themes/schemas/components/dark/_input-group.scss +6 -6
  175. package/sass/themes/schemas/components/dark/_label.scss +5 -5
  176. package/sass/themes/schemas/components/dark/_list.scss +5 -5
  177. package/sass/themes/schemas/components/dark/_navbar.scss +5 -5
  178. package/sass/themes/schemas/components/dark/_navdrawer.scss +5 -5
  179. package/sass/themes/schemas/components/dark/_overlay.scss +5 -5
  180. package/sass/themes/schemas/components/dark/_pagination.scss +5 -5
  181. package/sass/themes/schemas/components/dark/_pivot-data-selector.scss +9 -9
  182. package/sass/themes/schemas/components/dark/_progress.scss +10 -10
  183. package/sass/themes/schemas/components/dark/_query-builder.scss +3 -3
  184. package/sass/themes/schemas/components/dark/_radio.scss +5 -5
  185. package/sass/themes/schemas/components/dark/_rating.scss +5 -5
  186. package/sass/themes/schemas/components/dark/_resize-indicator.scss +9 -9
  187. package/sass/themes/schemas/components/dark/_ripple.scss +5 -5
  188. package/sass/themes/schemas/components/dark/_scrollbar.scss +5 -5
  189. package/sass/themes/schemas/components/dark/_select.scss +5 -5
  190. package/sass/themes/schemas/components/dark/_slider.scss +5 -5
  191. package/sass/themes/schemas/components/dark/_snackbar.scss +6 -6
  192. package/sass/themes/schemas/components/dark/_splitter.scss +13 -7
  193. package/sass/themes/schemas/components/dark/_stepper.scss +5 -5
  194. package/sass/themes/schemas/components/dark/_switch.scss +5 -5
  195. package/sass/themes/schemas/components/dark/_tabs.scss +5 -5
  196. package/sass/themes/schemas/components/dark/_tile-manager.scss +11 -11
  197. package/sass/themes/schemas/components/dark/_time-picker.scss +5 -5
  198. package/sass/themes/schemas/components/dark/_toast.scss +4 -4
  199. package/sass/themes/schemas/components/dark/_tooltip.scss +7 -7
  200. package/sass/themes/schemas/components/dark/_tree.scss +5 -5
  201. package/sass/themes/schemas/components/dark/_validator.scss +5 -5
  202. package/sass/themes/schemas/components/dark/_watermark.scss +5 -5
  203. package/sass/themes/schemas/components/dark/calendar/_base.scss +9 -9
  204. package/sass/themes/schemas/components/dark/calendar/_days-view.scss +11 -11
  205. package/sass/themes/schemas/components/dark/calendar/_picker.scss +8 -8
  206. package/sass/themes/schemas/components/dark/calendar/_year-month-view.scss +11 -11
  207. package/sass/themes/schemas/components/elevation/_button-group.scss +3 -3
  208. package/sass/themes/schemas/components/elevation/_carousel.scss +2 -2
  209. package/sass/themes/schemas/components/light/_action-strip.scss +9 -9
  210. package/sass/themes/schemas/components/light/_avatar.scss +9 -9
  211. package/sass/themes/schemas/components/light/_badge.scss +12 -12
  212. package/sass/themes/schemas/components/light/_banner.scss +9 -9
  213. package/sass/themes/schemas/components/light/_bottom-nav.scss +12 -12
  214. package/sass/themes/schemas/components/light/_button-group.scss +14 -14
  215. package/sass/themes/schemas/components/light/_button.scss +103 -103
  216. package/sass/themes/schemas/components/light/_calendar.scss +28 -28
  217. package/sass/themes/schemas/components/light/_card.scss +14 -42
  218. package/sass/themes/schemas/components/light/_carousel.scss +12 -12
  219. package/sass/themes/schemas/components/light/_chat.scss +9 -9
  220. package/sass/themes/schemas/components/light/_checkbox.scss +9 -9
  221. package/sass/themes/schemas/components/light/_chip.scss +27 -27
  222. package/sass/themes/schemas/components/light/_column-actions.scss +9 -9
  223. package/sass/themes/schemas/components/light/_combo.scss +11 -11
  224. package/sass/themes/schemas/components/light/_date-picker.scss +8 -8
  225. package/sass/themes/schemas/components/light/_date-range-picker.scss +9 -9
  226. package/sass/themes/schemas/components/light/_dialog.scss +14 -23
  227. package/sass/themes/schemas/components/light/_divider.scss +7 -7
  228. package/sass/themes/schemas/components/light/_dock-manager.scss +9 -9
  229. package/sass/themes/schemas/components/light/_drop-down.scss +16 -24
  230. package/sass/themes/schemas/components/light/_expansion-panel.scss +12 -24
  231. package/sass/themes/schemas/components/light/_file-input.scss +1 -1
  232. package/sass/themes/schemas/components/light/_grid-filtering.scss +9 -9
  233. package/sass/themes/schemas/components/light/_grid-summary.scss +13 -26
  234. package/sass/themes/schemas/components/light/_grid-toolbar.scss +9 -9
  235. package/sass/themes/schemas/components/light/_grid.scss +162 -68
  236. package/sass/themes/schemas/components/light/_highlight.scss +10 -10
  237. package/sass/themes/schemas/components/light/_icon-button.scss +48 -48
  238. package/sass/themes/schemas/components/light/_icon.scss +9 -9
  239. package/sass/themes/schemas/components/light/_input-group.scss +17 -26
  240. package/sass/themes/schemas/components/light/_label.scss +8 -8
  241. package/sass/themes/schemas/components/light/_list.scss +13 -33
  242. package/sass/themes/schemas/components/light/_navbar.scss +12 -12
  243. package/sass/themes/schemas/components/light/_navdrawer.scss +14 -26
  244. package/sass/themes/schemas/components/light/_overlay.scss +9 -9
  245. package/sass/themes/schemas/components/light/_pagination.scss +9 -9
  246. package/sass/themes/schemas/components/light/_pivot-data-selector.scss +9 -9
  247. package/sass/themes/schemas/components/light/_progress.scss +13 -13
  248. package/sass/themes/schemas/components/light/_query-builder.scss +10 -10
  249. package/sass/themes/schemas/components/light/_radio.scss +9 -9
  250. package/sass/themes/schemas/components/light/_rating.scss +9 -9
  251. package/sass/themes/schemas/components/light/_resize-indicator.scss +8 -8
  252. package/sass/themes/schemas/components/light/_ripple.scss +9 -9
  253. package/sass/themes/schemas/components/light/_scrollbar.scss +9 -9
  254. package/sass/themes/schemas/components/light/_select.scss +9 -9
  255. package/sass/themes/schemas/components/light/_slider.scss +11 -17
  256. package/sass/themes/schemas/components/light/_snackbar.scss +9 -9
  257. package/sass/themes/schemas/components/light/_splitter.scss +9 -9
  258. package/sass/themes/schemas/components/light/_stepper.scss +8 -8
  259. package/sass/themes/schemas/components/light/_switch.scss +9 -9
  260. package/sass/themes/schemas/components/light/_tabs.scss +9 -9
  261. package/sass/themes/schemas/components/light/_tile-manager.scss +10 -10
  262. package/sass/themes/schemas/components/light/_time-picker.scss +10 -19
  263. package/sass/themes/schemas/components/light/_toast.scss +11 -11
  264. package/sass/themes/schemas/components/light/_tooltip.scss +10 -10
  265. package/sass/themes/schemas/components/light/_tree.scss +8 -8
  266. package/sass/themes/schemas/components/light/_validator.scss +9 -9
  267. package/sass/themes/schemas/components/light/_watermark.scss +9 -9
  268. package/sass/themes/schemas/components/light/calendar/_base.scss +9 -29
  269. package/sass/themes/schemas/components/light/calendar/_days-view.scss +8 -17
  270. package/sass/themes/schemas/components/light/calendar/_picker.scss +9 -17
  271. package/sass/themes/schemas/components/light/calendar/_year-month-view.scss +9 -17
  272. package/sass/typography/_functions.scss +14 -14
  273. package/sass/typography/_mixins.scss +7 -7
  274. package/sass/utils/_css.scss +1 -1
  275. package/sass/utils/_map.scss +5 -5
  276. package/sass/utils/_math.scss +6 -5
  277. package/sass/utils/_meta.scss +4 -4
  278. package/tailwind/utilities/bootstrap.css +1 -1
  279. package/tailwind/utilities/fluent.css +1 -1
  280. package/tailwind/utilities/indigo.css +1 -1
  281. package/tailwind/utilities/material.css +1 -1
@@ -11,7 +11,7 @@
11
11
  /// @prop {Map} helper-text-color [color: ('gray', 700)] - The color used for helper text.
12
12
  /// @prop {Map} text-error-color [color: ('error', 500)] - The color used for the error message.
13
13
  /// @prop {Map} icon-error-color [color: ('error', 500)] - The color used for the error icon.
14
- /// @type {Map}
14
+ /// @type Map
15
15
  $light-validator: extend(
16
16
  (
17
17
  helper-text-color: (
@@ -40,8 +40,8 @@ $light-validator: extend(
40
40
  );
41
41
 
42
42
  /// Generates a light material validator schema.
43
- /// @type {Map}
44
- /// @requires {Map} $light-validator
43
+ /// @type Map
44
+ /// @requires $light-validator
45
45
  $material-validator: extend(
46
46
  $light-validator,
47
47
  (
@@ -52,8 +52,8 @@ $material-validator: extend(
52
52
  );
53
53
 
54
54
  /// Generates a light fluent validator schema.
55
- /// @type {Map}
56
- /// @requires {Map} $light-validator
55
+ /// @type Map
56
+ /// @requires $light-validator
57
57
  $fluent-validator: extend(
58
58
  $light-validator,
59
59
  (
@@ -64,8 +64,8 @@ $fluent-validator: extend(
64
64
  );
65
65
 
66
66
  /// Generates a bootstrap validator schema.
67
- /// @type {Map}
68
- /// @requires {Map} $light-validator
67
+ /// @type Map
68
+ /// @requires $light-validator
69
69
  $bootstrap-validator: extend(
70
70
  $light-validator,
71
71
  (
@@ -76,9 +76,9 @@ $bootstrap-validator: extend(
76
76
  );
77
77
 
78
78
  /// Generates an indigo validator schema.
79
- /// @type {Map}
79
+ /// @type Map
80
80
  /// @prop {Map} text-error-color [color: ('gray', 700)] - The color used for error message.
81
- /// @requires {Map} $light-validator
81
+ /// @requires $light-validator
82
82
  $indigo-validator: extend(
83
83
  $light-validator,
84
84
  (
@@ -8,7 +8,7 @@
8
8
  ////
9
9
 
10
10
  /// Generates a base light watermark schema.
11
- /// @type {Map}
11
+ /// @type Map
12
12
  /// @prop {Color} base-color [null] - The base color for all elements of the watermark.
13
13
  /// @prop {Color} image-color [null] - The color used for the stamp image.
14
14
  /// @prop {Number} image-opacity [null] - The opacity of the stamp image.
@@ -47,8 +47,8 @@ $light-watermark: extend(
47
47
  );
48
48
 
49
49
  /// Generates a light material watermark schema.
50
- /// @type {Map}
51
- /// @requires {Map} $light-watermark
50
+ /// @type Map
51
+ /// @requires $light-watermark
52
52
  $material-watermark: extend(
53
53
  $light-watermark,
54
54
  (
@@ -59,9 +59,9 @@ $material-watermark: extend(
59
59
  );
60
60
 
61
61
  /// Generates a light fluent watermark schema.
62
- /// @type {Map}
62
+ /// @type Map
63
63
  /// @prop {List} border-radius [(rem(2px), rem(0), rem(16px))] - The border radius used for watermark.
64
- /// @requires {Map} $light-watermark
64
+ /// @requires $light-watermark
65
65
  $fluent-watermark: extend(
66
66
  $light-watermark,
67
67
  (
@@ -79,9 +79,9 @@ $fluent-watermark: extend(
79
79
  );
80
80
 
81
81
  /// Generates a bootstrap watermark schema.
82
- /// @type {Map}
82
+ /// @type Map
83
83
  /// @prop {List} border-radius [(rem(4px), rem(0), rem(16px))] - The border radius used for watermark.
84
- /// @requires {Map} $light-watermark
84
+ /// @requires $light-watermark
85
85
  $bootstrap-watermark: extend(
86
86
  $light-watermark,
87
87
  (
@@ -99,10 +99,10 @@ $bootstrap-watermark: extend(
99
99
  );
100
100
 
101
101
  /// Generates an indigo watermark schema.
102
- /// @type {Map}
102
+ /// @type Map
103
103
  /// @prop {Map} border-color [color: ('primary', 300)] - The border color for the link.
104
104
  /// @prop {List} border-radius [(rem(16px), rem(0), rem(16px))] - The border radius used for watermark.
105
- /// @requires {Map} $light-watermark
105
+ /// @requires $light-watermark
106
106
  $indigo-watermark: extend(
107
107
  $light-watermark,
108
108
  (
@@ -8,7 +8,7 @@
8
8
  ////
9
9
 
10
10
  /// Generates a light base calendar schema.
11
- /// @type {Map}
11
+ /// @type Map
12
12
  /// @prop {Number} default-size [2] - The default size used for the calendar component.
13
13
  /// @prop {Color} border-color [transparent] - The calendar border color.
14
14
  /// @prop {Map} border-radius [border-radius: (rem(4px), rem(0), rem(20px))] - The border radius used for calendar.
@@ -40,16 +40,11 @@ $calendar-base: (
40
40
  );
41
41
 
42
42
  /// Generates a base material calendar schema.
43
- /// @type {Map}
43
+ /// @type Map
44
44
  /// @prop {Map} header-foreground [contrast-color: ('secondary', 900)] - The header foreground color.
45
45
  /// @prop {Map} header-background [color: ('secondary', 500)] - The header background color.
46
46
  /// @prop {Map} actions-divider-color [color: ('gray', 200)] - The border color used for the date-picker actions divider.
47
- /// @prop {Map} typography [
48
- /// header: (
49
- /// year: (value: 'overline'),
50
- /// date: (value: 'h4')
51
- /// )
52
- /// ] - The typography styles used for the component.
47
+ /// @prop {Map} typography [header: (year: (value: 'overline'), date: (value: 'h4'))] - The typography styles used for the component.
53
48
  /// @requires $calendar-base
54
49
  $material-base: extend(
55
50
  $calendar-base,
@@ -90,17 +85,12 @@ $material-base: extend(
90
85
  );
91
86
 
92
87
  /// Generates a light base fluent base calendar schema.
93
- /// @type {Map}
88
+ /// @type Map
94
89
  /// @prop {Map} header-foreground [contrast-color: ('primary', 600)] - The header foreground color.
95
90
  /// @prop {Map} header-background [color: ('primary', 500)] - The background color of the month and year pickers.
96
91
  /// @prop {Map} border-radius [border-radius: (rem(0), rem(0), rem(25px))] - The border radius used for calendar.
97
92
  /// @prop {Map} actions-divider-color [color: ('gray', 200)] - The border color used for the date-picker actions divider.
98
- /// @prop {Map} typography [
99
- /// header: (
100
- /// year: (value: 'overline'),
101
- /// date: (value: 'h4')
102
- /// )
103
- /// ] - The typography styles used for the component.
93
+ /// @prop {Map} typography [header: (year: (value: 'overline'), date: (value: 'h4'))] - The typography styles used for the component.
104
94
  /// @requires $calendar-base
105
95
  $fluent-base: extend(
106
96
  $calendar-base,
@@ -148,18 +138,13 @@ $fluent-base: extend(
148
138
  );
149
139
 
150
140
  /// Generates a light base bootstrap base calendar schema.
151
- /// @type {Map}
141
+ /// @type Map
152
142
  /// @prop {Map} header-foreground [contrast-color: ('gray', 100)] - The header foreground color.
153
143
  /// @prop {Map} header-background [color: ('gray', 100)] - The header background color.
154
144
  /// @prop {Map} border-color [color: ('gray', 300)] - The calendar border color.
155
145
  /// @prop {Map} border-radius [border-radius: (rem(4px), rem(0), rem(20px))] - The border radius used for the calendar.
156
146
  /// @prop {Map} actions-divider-color [color: ('gray', 300)] - The border color used for the date-picker actions divider.
157
- /// @prop {Map} typography [
158
- /// header: (
159
- /// year: (value: 'body-2'),
160
- /// date: (value: 'h4')
161
- /// )
162
- /// ] - The typography styles used for the component.
147
+ /// @prop {Map} typography [header: (year: (value: 'body-2'), date: (value: 'h4'))] - The typography styles used for the component.
163
148
  /// @requires $calendar-base
164
149
  $bootstrap-base: extend(
165
150
  $calendar-base,
@@ -213,7 +198,7 @@ $bootstrap-base: extend(
213
198
  );
214
199
 
215
200
  /// Generates a light base indigo base calendar schema.
216
- /// @type {Map}
201
+ /// @type Map
217
202
  /// @prop {Map} content-foreground [color: ('gray', 800)] - The foreground color of the days, months and years views.
218
203
  /// @prop {Map} content-background [contrast-color: ('gray', 900)] - The background color of the days, months and years views.
219
204
  /// @prop {Map} header-foreground [color: ('gray', 800)] - The header foreground color.
@@ -221,12 +206,7 @@ $bootstrap-base: extend(
221
206
  /// @prop {Map} border-color [color: ('gray', 400)] - The calendar border color.
222
207
  /// @prop {Map} border-radius [border-radius: (rem(6px), rem(0), rem(6px))] - The border radius used for calendar.
223
208
  /// @prop {Map} actions-divider-color [color: ('gray', 400)] - The border color used for the date-picker actions divider.
224
- /// @prop {Map} typography [
225
- /// header: (
226
- /// year: (value: 'body-2'),
227
- /// date: (value: 'h5')
228
- /// )
229
- /// ] - The typography styles used for the component.
209
+ /// @prop {Map} typography [header: (year: (value: 'body-2'), date: (value: 'h5'))] - The typography styles used for the component.
230
210
  /// @requires $calendar-base
231
211
  $indigo-base: extend(
232
212
  $calendar-base,
@@ -9,7 +9,7 @@
9
9
  ////
10
10
 
11
11
  /// Generates a base light days-view schema.
12
- /// @type {Map}
12
+ /// @type Map
13
13
  /// @prop {Map} weekday-color [color: ('gray', 500)] - The foreground color of the weekday labels.
14
14
  /// @prop {Map} weekend-color [color: ('gray', 900)] - The foreground color of the weekend days.
15
15
  /// @prop {Map} inactive-color [color: ('gray', 500)] - The foreground color of the previous and next month dates.
@@ -200,7 +200,7 @@ $light-days-view: extend(
200
200
  );
201
201
 
202
202
  /// Generates a light material days-view schema.
203
- /// @type {Map}
203
+ /// @type Map
204
204
  /// @prop {Map} date-hover-background [color: ('gray', 100)] - The :hover background color of a date.
205
205
  /// @prop {Map} date-focus-background [color: ('gray', 100)] - The :focus background color of date.
206
206
  /// @prop {Map} date-current-foreground [color: ('gray', 900)] - The foreground color of the current date.
@@ -260,10 +260,7 @@ $light-days-view: extend(
260
260
  /// @prop {List} date-current-border-radius [(rem(20px), rem(0), rem(20px))] - The border radius used for the current date selection.
261
261
  /// @prop {Map} weekday-color [color: ('gray', 700)] - The foreground color of the weekday labels.
262
262
  /// @prop {Map} week-number-foreground [color: ('gray', 700)] - The foreground color of the week number column.
263
- /// @prop {Map} typography [
264
- /// weekday-label: (value: 'body-1'),
265
- /// content: (value: 'body-1')
266
- /// ] - The typography styles used for the component.
263
+ /// @prop {Map} typography [weekday-label: (value: 'body-1'), content: (value: 'body-1')] - The typography styles used for the component.
267
264
  /// @requires $light-days-view
268
265
  /// @requires $material-base
269
266
  $material-days-view: extend(
@@ -635,7 +632,7 @@ $material-days-view: extend(
635
632
  );
636
633
 
637
634
  /// Generates a light fluent days-view schema.
638
- /// @type {Map}
635
+ /// @type Map
639
636
  /// @prop {Map} date-special-foreground [color: ('gray', 900)] - The foreground color of a special date.
640
637
  /// @prop {Map} date-special-hover-foreground [color: ('gray', 900)] - The foreground color of a special date.
641
638
  /// @prop {Map} date-special-focus-foreground [color: ('gray', 900)] - The foreground color of a special date.
@@ -714,10 +711,7 @@ $material-days-view: extend(
714
711
  /// @prop {Map} weekday-color [color: ('gray', 700)] - The foreground color of the weekday labels.
715
712
  /// @prop {Map} week-number-foreground [color: ('gray', 700)] - The foreground color of the week number column.
716
713
  /// @prop {Map} inactive-color [color: ('gray', 700)] - The foreground color of the previous and next month dates.
717
- /// @prop {Map} typography [
718
- /// weekday-label: (value: 'body-1'),
719
- /// content: (value: 'body-1')
720
- /// ] - The typography styles used for the component.
714
+ /// @prop {Map} typography [weekday-label: (value: 'body-1'), content: (value: 'body-1')] - The typography styles used for the component.
721
715
  /// @requires $light-days-view
722
716
  /// @requires $fluent-base
723
717
  $fluent-days-view: extend(
@@ -1190,7 +1184,7 @@ $fluent-days-view: extend(
1190
1184
  );
1191
1185
 
1192
1186
  /// Generates a light bootstrap days-view schema.
1193
- /// @type {Map}
1187
+ /// @type Map
1194
1188
  /// @prop {Map} date-special-hover-background [color: ('gray', 200)] - The background color of a special date.
1195
1189
  /// @prop {Map} date-special-focus-background [color: ('gray', 200)] - The background color of a special date.
1196
1190
  /// @prop {Map} date-special-range-hover-background [color: ('gray', 200)] - The :hover background color of a special date in range selection.
@@ -1258,10 +1252,7 @@ $fluent-days-view: extend(
1258
1252
  /// @prop {List} date-special-border-radius [(rem(20px), rem(0), rem(20px))] - The border radius used for the special date selection.
1259
1253
  /// @prop {List} border-radius [(rem(4px), rem(0), rem(20px))] - The border radius used for the calendar.
1260
1254
  /// @prop {List} week-number-border-radius [(rem(0), rem(0), rem(8px))] - The border radius used for the week numbers column.
1261
- /// @prop {Map} typography [
1262
- /// weekday-label: (value: 'body-2'),
1263
- /// content: (value: 'body-1')
1264
- /// ] - The typography styles used for the component.
1255
+ /// @prop {Map} typography [weekday-label: (value: 'body-2'), content: (value: 'body-1')] - The typography styles used for the component.
1265
1256
  /// @requires $light-days-view
1266
1257
  /// @requires $bootstrap-base
1267
1258
  $bootstrap-days-view: extend(
@@ -1655,7 +1646,7 @@ $bootstrap-days-view: extend(
1655
1646
  );
1656
1647
 
1657
1648
  /// Generates a light indigo days-view schema.
1658
- /// @type {Map}
1649
+ /// @type Map
1659
1650
  /// @prop {Map} weekend-color [color: ('gray', 800)] - The foreground color of the weekend days.
1660
1651
  /// @prop {Map} week-number-foreground [color: ('gray', 600)] - The foreground color of the week number column.
1661
1652
  /// @prop {Map} week-number-background [color: ('gray', 900, .05)] - The background color of the week number column.
@@ -8,7 +8,7 @@
8
8
  ////
9
9
 
10
10
  /// Generates a base light month/year picker schema.
11
- /// @type {Map}
11
+ /// @type Map
12
12
  /// @prop {Map} picker-background [color: 'surface'] - The background color of the month and year pickers.
13
13
  /// @prop {Map} picker-hover-foreground [color: ('secondary', 500)] - The :hover foreground color of the month and year pickers.
14
14
  /// @prop {Map} picker-focus-foreground [color: ('secondary', 500)] - The :focus foreground color of the month and year pickers.
@@ -53,11 +53,9 @@ $light-picker: (
53
53
  );
54
54
 
55
55
  /// Generates a light material month/year picker schema.
56
- /// @type {Map}
56
+ /// @type Map
57
57
  /// @prop {Map} picker-foreground [color: ('gray', 900)] - The foreground color of the month and year pickers.
58
- /// @prop {Map} typography [
59
- /// picker-date: (value: 'subtitle-1')
60
- /// ] - The typography styles used for the component.
58
+ /// @prop {Map} typography [picker-date: (value: 'subtitle-1')] - The typography styles used for the component.
61
59
  /// @requires $light-picker
62
60
  $material-picker: extend(
63
61
  $light-picker,
@@ -78,15 +76,13 @@ $material-picker: extend(
78
76
  );
79
77
 
80
78
  /// Generates a light fluent month/year picker schema.
81
- /// @type {Map}
79
+ /// @type Map
82
80
  /// @prop {Map} picker-foreground [color: ('gray', 900)] - The foreground color of the month and year pickers.
83
81
  /// @prop {Map} picker-hover-foreground [color: ('primary', 500)] - The :hover foreground color of the month and year pickers.
84
82
  /// @prop {Map} picker-focus-foreground [color: ('primary', 500)] - The :focus foreground color of the month and year pickers.
85
83
  /// @prop {Map} navigation-hover-color [color: ('primary', 500)] - The :hover color of the buttons responsible for navigation.
86
84
  /// @prop {Map} navigation-focus-color [color: ('primary', 500)] - The :focus color of the buttons responsible for navigation.
87
- /// @prop {Map} typography [
88
- /// picker-date: (value: 'subtitle-2')
89
- /// ] - The typography styles used for the component.
85
+ /// @prop {Map} typography [picker-date: (value: 'subtitle-2')] - The typography styles used for the component.
90
86
  /// @requires $light-picker
91
87
  $fluent-picker: extend(
92
88
  $light-picker,
@@ -131,12 +127,10 @@ $fluent-picker: extend(
131
127
  );
132
128
 
133
129
  /// Generates a light bootstrap month/year picker schema.
134
- /// @type {Map}
130
+ /// @type Map
135
131
  /// @prop {Map} picker-foreground [color: ('gray', 900)] - The foreground color of the month and year pickers.
136
132
  /// @prop {Map} picker-background [color: ('gray', 100)] - The background color of the month and year pickers.
137
- /// @prop {Map} typography [
138
- /// picker-date: (value: 'subtitle-1')
139
- /// ] - The typography styles used for the component.
133
+ /// @prop {Map} typography [picker-date: (value: 'subtitle-1')] - The typography styles used for the component.
140
134
  /// @requires $light-picker
141
135
  $bootstrap-picker: extend(
142
136
  $light-picker,
@@ -170,10 +164,8 @@ $bootstrap-picker: extend(
170
164
  /// @prop {Map} navigation-color [color: ('gray', 600)] - the color of the buttons responsible for navigation.
171
165
  /// @prop {Map} navigation-hover-color [color: ('primary', 500)] - The :hover color of the icon button responsible for month navigation.
172
166
  /// @prop {Map} navigation-focus-color [color: ('primary', 500)] - The :focus color of the icon button responsible for month navigation.
173
- /// @type {Map}
174
- /// @prop {Map} typography [
175
- /// picker-date: (value: 'subtitle-2')
176
- /// ] - The typography styles used for the component.
167
+ /// @type Map
168
+ /// @prop {Map} typography [picker-date: (value: 'subtitle-2')] - The typography styles used for the component.
177
169
  /// @requires $light-picker
178
170
  $indigo-picker: extend(
179
171
  $light-picker,
@@ -9,7 +9,7 @@
9
9
  ////
10
10
 
11
11
  /// Generates a base light year/month views schema.
12
- /// @type {Map}
12
+ /// @type Map
13
13
  /// @prop {Number} default-size [2] - The default size used for the calendar component.
14
14
  /// @prop {Map} ym-current-outline-hover-color [color: ('gray', 900)] - The :hover outline color of the current month/year.
15
15
  /// @prop {Map} ym-current-outline-focus-color [color: ('gray', 900)] - The :focus outline color of the current month/year.
@@ -62,7 +62,7 @@ $light-year-month: extend(
62
62
  );
63
63
 
64
64
  /// Generates a light material year/month views schema.
65
- /// @type {Map}
65
+ /// @type Map
66
66
  /// @prop {Map} ym-selected-current-hover-foreground [contrast-color: ('secondary', 700)] - The :hover foreground color of the current/selected year/month.
67
67
  /// @prop {Map} ym-selected-current-hover-background [color: ('secondary', 700)] - The :hover background color of the current/selected year.
68
68
  /// @prop {Map} ym-hover-foreground [color: ('gray', 900)] - The :hover foreground color of the month/year.
@@ -83,9 +83,7 @@ $light-year-month: extend(
83
83
  /// @prop {Map} ym-selected-current-outline-color [color: ('gray', 900)] - The outline color of the selected current month/year.
84
84
  /// @prop {Map} ym-selected-current-outline-hover-color [color: ('gray', 900)] - The :hover outline color of the selected current month/year.
85
85
  /// @prop {Map} ym-selected-current-outline-focus-color [color: ('gray', 900)] - The :focus outline color of the selected current month/year.
86
- /// @prop {Map} typography [
87
- /// content: (value: 'body-1')
88
- /// ]
86
+ /// @prop {Map} typography [content: (value: 'body-1')] - The typography styles used for the component.
89
87
  /// @requires $light-year-month
90
88
  /// @requires $material-base
91
89
  $material-year-month: extend(
@@ -206,7 +204,7 @@ $material-year-month: extend(
206
204
  );
207
205
 
208
206
  /// Generates a light fluent year/month views schema.
209
- /// @type {Map}
207
+ /// @type Map
210
208
  /// @prop {Map} ym-hover-background [color: ('gray', 200)] - The :hover background color of the month/year.
211
209
  /// @prop {Map} ym-selected-current-hover-foreground [color: ('gray', 900)] - The foreground color of the current/selected month/year on :hover.
212
210
  /// @prop {Map} ym-selected-current-hover-background [color: ('primary', 100, .5)] - The background color of the current/selected month/year on :hover.
@@ -230,9 +228,7 @@ $material-year-month: extend(
230
228
  /// @prop {Map} ym-selected-current-outline-hover-color [color: ('gray', 700)] - The :hover outline color of the selected current month/year.
231
229
  /// @prop {Map} ym-selected-current-outline-focus-color [color: ('gray', 700)] - The :focus outline color of the selected current month/year.
232
230
  /// @prop {List} ym-border-radius [(rem(0), rem(0), rem(25px))] - The border radius used for the month/year.
233
- /// @prop {Map} typography [
234
- /// content: (value: 'body-1')
235
- /// ]
231
+ /// @prop {Map} typography [content: (value: 'body-1')] - The typography styles used for the component.
236
232
  /// @requires $light-year-month
237
233
  /// @requires $fluent-base
238
234
  $fluent-year-month: extend(
@@ -379,7 +375,7 @@ $fluent-year-month: extend(
379
375
  );
380
376
 
381
377
  /// Generates a light bootstrap year/month views schema.
382
- /// @type {Map}
378
+ /// @type Map
383
379
  /// @prop {Map} ym-current-outline-color [color: ('gray', 900)] - The outline color of the current month/year.
384
380
  /// @prop {Map} ym-selected-current-hover-foreground [contrast-color: ('primary', 900)] - The :hover foreground color of the current/selected month/year.
385
381
  /// @prop {Map} ym-selected-current-hover-background [color: ('primary', 600)] - The :hover background color of the current/selected month/year.
@@ -401,9 +397,7 @@ $fluent-year-month: extend(
401
397
  /// @prop {Map} ym-selected-current-outline-hover-color [color: ('gray', 900)] - The :hover outline color of the selected current month/year.
402
398
  /// @prop {Map} ym-selected-current-outline-focus-color [color: ('gray', 900)] - The :focus outline color of the selected current month/year.
403
399
  /// @prop {List} ym-border-radius [(rem(4px), rem(0), rem(20px))] - The border radius used for the month/year.
404
- /// @prop {Map} typography [
405
- /// content: (value: 'body-1')
406
- /// ]
400
+ /// @prop {Map} typography [content: (value: 'body-1')] - The typography styles used for the component.
407
401
  /// @requires $light-year-month
408
402
  /// @requires $bootstrap-base
409
403
  $bootstrap-year-month: extend(
@@ -530,7 +524,7 @@ $bootstrap-year-month: extend(
530
524
  );
531
525
 
532
526
  /// Generates a light indigo year/month views schema.
533
- /// @type {Map}
527
+ /// @type Map
534
528
  /// @prop {Map} ym-hover-foreground [color: ('gray', 800)] - The :hover foreground color of the month/year.
535
529
  /// @prop {Map} ym-hover-background [color: ('gray', 900, .05)] - The :hover background color of the month/year.
536
530
  /// @prop {Map} ym-current-foreground [color: ('gray', 800)] - The foreground color of the current month/year.
@@ -551,9 +545,7 @@ $bootstrap-year-month: extend(
551
545
  /// @prop {Map} ym-selected-current-outline-color [color: ('primary', 100)] - The outline color of the selected current month/year.
552
546
  /// @prop {Map} ym-selected-current-outline-hover-color [color: ('primary', 200)] - The :hover outline color of the selected current month/year.
553
547
  /// @prop {Map} ym-selected-current-outline-focus-color [color: ('primary', 200)] - The :focus outline color of the selected current month/year.
554
- /// @prop {Map} typography [
555
- /// content: (value: 'body-1')
556
- /// ]
548
+ /// @prop {Map} typography [content: (value: 'body-1')] - The typography styles used for the component.
557
549
  /// @requires $light-year-month
558
550
  /// @requires $indigo-base
559
551
  $indigo-year-month: extend(
@@ -13,9 +13,9 @@
13
13
 
14
14
  /// Converts pixels to relative values (em).
15
15
  /// @access public
16
- /// @param {number|string} $pixels - The pixel value to be converted.
17
- /// @param {number|string} $context [$browser-context] - The base context to convert against.
18
- /// @example
16
+ /// @param {Number | String} $pixels - The pixel value to be converted.
17
+ /// @param {Number | String} $context [$browser-context] - The base context to convert against.
18
+ /// @example scss
19
19
  /// .my-component {
20
20
  /// margin: em(10px) em(5px);
21
21
  /// }
@@ -25,7 +25,7 @@
25
25
  /// margin: 0.625em 0.3125em;
26
26
  /// }
27
27
  ///
28
- /// @return {number} - Returns the pixels value converted to em.
28
+ /// @return {number} Returns the pixels value converted to em.
29
29
  @function em($pixels, $context: $base-font-size) {
30
30
  @if math.is-unitless($pixels) {
31
31
  $pixels: $pixels * 1px;
@@ -42,7 +42,7 @@
42
42
  /// @access public
43
43
  /// @param {number|string} $pixels - The pixel value to be converted.
44
44
  /// @param {number|string} $context [$browser-context] - The base context to convert against.
45
- /// @example
45
+ /// @example scss
46
46
  /// .my-component {
47
47
  /// margin: rem(10px) rem(5px);
48
48
  /// }
@@ -52,7 +52,7 @@
52
52
  /// margin: 0.625rem 0.3125rem;
53
53
  /// }
54
54
  ///
55
- /// @return {number} - Returns the pixels value converted to rem.
55
+ /// @return {number} Returns the pixels value converted to rem.
56
56
  @function rem($pixels, $context: $base-font-size) {
57
57
  @if math.is-unitless($pixels) {
58
58
  $pixels: $pixels * 1px;
@@ -69,7 +69,7 @@
69
69
  /// @access public
70
70
  /// @param {number|string} $num - The relative value to be converted.
71
71
  /// @param {number|string} $context [$browser-context] - The base context to convert against.
72
- /// @example
72
+ /// @example scss
73
73
  /// .my-component {
74
74
  /// margin: px(3rem);
75
75
  /// }
@@ -79,7 +79,7 @@
79
79
  /// margin: 48px;
80
80
  /// }
81
81
  ///
82
- /// @return {number} - Returns the relative value converted to pixels.
82
+ /// @return {number} Returns the relative value converted to pixels.
83
83
  @function px($num, $context: $base-font-size) {
84
84
  @if math.is-unitless($context) {
85
85
  $context: $context * 1px;
@@ -104,7 +104,7 @@
104
104
  /// @param {Number} $margin-top [0] - The margin-top property of the type style.
105
105
  /// @param {Number} $margin-bottom [0] - The margin-bottom property of the type style.
106
106
  /// @requires $ITypeStyle
107
- /// @example
107
+ /// @example scss
108
108
  /// $main_navigation: type-style(
109
109
  /// $font-size: rem(14px),
110
110
  /// $font-weight: 600,
@@ -117,7 +117,7 @@
117
117
  /// .main-nav {
118
118
  /// @include type-style($main_navigation);
119
119
  /// }
120
- /// @returns {Map} - A map of all defined type style properties.
120
+ /// @returns {Map} A map of all defined type style properties.
121
121
  @function type-style($args...) {
122
122
  $keywords: meta.keywords($args);
123
123
  $result: ();
@@ -158,7 +158,7 @@
158
158
  /// @param {Map} $overline - A map containing type style properties as produces by the type-style function.
159
159
  /// @param {String} $_theme [null] - The theme related to this type scale. Internal use only.
160
160
  /// @requires $ITypeScale
161
- /// @example
161
+ /// @example scss
162
162
  /// // First define type styles to use
163
163
  /// $my-body-1: type-style(
164
164
  /// $font-size: rem(14px),
@@ -170,7 +170,7 @@
170
170
  /// $body-1: $my-body-1,
171
171
  /// ...
172
172
  /// );
173
- /// @returns {Map} - A map of all defined type scales.
173
+ /// @returns {Map} A map of all defined type scales.
174
174
  @function type-scale($_theme: null, $args...) {
175
175
  $style_fn: meta.get-function('type-style');
176
176
  $categories: meta.keywords($args);
@@ -201,9 +201,9 @@
201
201
  /// Get type scale category config.
202
202
  /// @param {Map} $scale - A type scale map reference as produces by type-scale.
203
203
  /// @param {String} $category - The scale category you want config for. For instance - 'h1';
204
- /// @example scss Get the type scale category config for the `h1` scale.
204
+ /// @example scss - Get the type scale category config for the `h1` scale.
205
205
  /// $h1-type-scale: type-scale-category($type-scale, 'h1');
206
- /// @returns {Map} - The config map for the selected category in the type scale.
206
+ /// @returns {Map} The config map for the selected category in the type scale.
207
207
  @function type-scale-category($scale, $category) {
208
208
  @return map.get($scale, $category);
209
209
  }
@@ -19,7 +19,7 @@
19
19
  /// keywords like inherit, etc.) are returned as-is.
20
20
  /// @access private
21
21
  /// @param {String | List | *} $value - The font-family value to normalize.
22
- /// @return {String | List | *} - The normalized value.
22
+ /// @return {String | List | *} The normalized value.
23
23
  @function _normalize-font-family($value) {
24
24
  @return if(meta.type-of($value) == 'string', string.unquote($value), $value);
25
25
  }
@@ -28,7 +28,7 @@
28
28
  /// @param {String} $category - The type scale category.
29
29
  /// @param {String} $check [true] - Toggles category checks against ITypeScale.
30
30
  /// Set to false when using a custom type scale.
31
- /// @example scss Add the `h1` styles to custom CSS selector.
31
+ /// @example scss - Add the `h1` styles to custom CSS selector.
32
32
  /// .fancy-h1 {
33
33
  /// @include type-style('h1');
34
34
  ///
@@ -54,7 +54,7 @@
54
54
  /// Transforms a type style map into css font variables.
55
55
  /// @param {String} $name - The custom CSS variable name.
56
56
  /// @param {Map} $type-style - A type style map reference as produced by type-style.
57
- /// @example scss Assign the `h1` styles to custom CSS property using the CSS font shorthand syntax.
57
+ /// @example scss - Assign the `h1` styles to custom CSS property using the CSS font shorthand syntax.
58
58
  /// $h1-style: type-scale-category($type-scale, 'h1');
59
59
  /// @include type-style-vars('h1', $h1-style);
60
60
  @mixin type-style-vars($name, $type-style) {
@@ -112,7 +112,7 @@
112
112
  /// @param {String} $name - The custom CSS variable name.
113
113
  /// @param {Map} $type-style - A type style map reference as produces by type-style.
114
114
  /// @param {String} $prefix [null] - Optional prefix.
115
- /// @example scss Assign the `h1` styles to custom CSS property using the CSS font shorthand syntax.
115
+ /// @example scss - Assign the `h1` styles to custom CSS property using the CSS font shorthand syntax.
116
116
  /// $h1-style: type-scale-category($type-scale, 'h1');
117
117
  /// @include font-var('h1-font', $h1-style);
118
118
  @mixin font-var($name, $type-style, $prefix: null) {
@@ -139,11 +139,11 @@
139
139
  /// (e.g. "'Comic Sans MS', sans-serif" for backward compatibility), or any other
140
140
  /// valid CSS value such as var(--my-font), inherit, etc.
141
141
  /// @param {Map} $type-scale - A type scale map as produced by the type-scale function.
142
- /// @example scss Using a font-family list
142
+ /// @example scss - Using a font-family list
143
143
  /// @include typography(("Open Sans", Helvetica, sans-serif), $my-type-scale);
144
- /// @example scss Using a quoted string (backward compatible)
144
+ /// @example scss - Using a quoted string (backward compatible)
145
145
  /// @include typography("'Comic Sans MS', sans-serif", $my-type-scale);
146
- /// @example scss Using a CSS variable reference
146
+ /// @example scss - Using a CSS variable reference
147
147
  /// @include typography(var(--my-custom-font), $my-type-scale);
148
148
  ///
149
149
  /// @requires {function} is-root
@@ -11,7 +11,7 @@
11
11
  /// @access private
12
12
  /// @param {List} $list - The of values to be expanded. Supports up to four values.
13
13
  /// @param {string} $prop [margin] - The name of the property.
14
- /// @returns {Map} - Returns an expanded list of values.
14
+ /// @returns {Map} Returns an expanded list of values.
15
15
  @function expand-shorthand($list, $prop: 'margin') {
16
16
  $len: list.length($list);
17
17
  $props: (
@@ -9,7 +9,7 @@
9
9
  /// Removes all null key-value pairs from a map
10
10
  /// @access public
11
11
  /// @param {Map} $map - The target map to be cleaned.
12
- /// @returns {Map} - Returns a map with null key-value pairs removed.
12
+ /// @returns {Map} Returns a map with null key-value pairs removed.
13
13
  @function clean($map) {
14
14
  $result: ();
15
15
 
@@ -26,7 +26,7 @@
26
26
  /// @access public
27
27
  /// @param {Map...} $maps - The maps to get extended.
28
28
  /// @requires {function} clean
29
- /// @returns {Map} - Returns the merged maps.
29
+ /// @returns {Map} Returns the merged maps.
30
30
  @function extend($maps...) {
31
31
  $result: ();
32
32
 
@@ -40,7 +40,7 @@
40
40
  /// Extracts the differences between two or more maps, comparing the first map against the rest.
41
41
  /// @access public
42
42
  /// @param {Map...} $maps - A list of maps that will be diffed.
43
- /// @example scss Pull out the unique properties of the second map when compared to the first.
43
+ /// @example scss - Pull out the unique properties of the second map when compared to the first.
44
44
  /// $map-1: (
45
45
  /// color: orange,
46
46
  /// background: black,
@@ -52,7 +52,7 @@
52
52
  /// );
53
53
  ///
54
54
  /// $diffed: diff($map-1, $map-2); // returns (color: red);
55
- /// @returns {Map} - Returns a map of the unique properties.
55
+ /// @returns {Map} Returns a map of the unique properties.
56
56
  @function diff($maps...) {
57
57
  $result: ();
58
58
 
@@ -81,7 +81,7 @@
81
81
  /// @param {Map} $map - The target map.
82
82
  /// @param {String} $prefix - The string used to prefix all keys in the map.
83
83
  /// @param {String} $separator [-] - The string used as a separator between the prefix and the key.
84
- /// @returns {Map} - Returns the modified map with all keys prefixed.
84
+ /// @returns {Map} Returns the modified map with all keys prefixed.
85
85
  @function map-keys-prefix($map, $prefix, $separator: '-') {
86
86
  $keys: map.keys($map);
87
87
  $len: list.length($keys);