@haiilo/catalyst 4.1.2 → 5.0.1

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 (277) hide show
  1. package/README.md +0 -2
  2. package/dist/catalyst/assets/fonts/Lato-Black.woff +0 -0
  3. package/dist/catalyst/assets/fonts/Lato-Black.woff2 +0 -0
  4. package/dist/catalyst/assets/fonts/Lato-BlackItalic.woff +0 -0
  5. package/dist/catalyst/assets/fonts/Lato-BlackItalic.woff2 +0 -0
  6. package/dist/catalyst/assets/fonts/Lato-Bold.woff +0 -0
  7. package/dist/catalyst/assets/fonts/Lato-Bold.woff2 +0 -0
  8. package/dist/catalyst/assets/fonts/Lato-BoldItalic.woff +0 -0
  9. package/dist/catalyst/assets/fonts/Lato-BoldItalic.woff2 +0 -0
  10. package/dist/catalyst/assets/fonts/Lato-Hairline.woff +0 -0
  11. package/dist/catalyst/assets/fonts/Lato-Hairline.woff2 +0 -0
  12. package/dist/catalyst/assets/fonts/Lato-HairlineItalic.woff +0 -0
  13. package/dist/catalyst/assets/fonts/Lato-HairlineItalic.woff2 +0 -0
  14. package/dist/catalyst/assets/fonts/Lato-Heavy.woff +0 -0
  15. package/dist/catalyst/assets/fonts/Lato-Heavy.woff2 +0 -0
  16. package/dist/catalyst/assets/fonts/Lato-HeavyItalic.woff +0 -0
  17. package/dist/catalyst/assets/fonts/Lato-HeavyItalic.woff2 +0 -0
  18. package/dist/catalyst/assets/fonts/Lato-Italic.woff +0 -0
  19. package/dist/catalyst/assets/fonts/Lato-Italic.woff2 +0 -0
  20. package/dist/catalyst/assets/fonts/Lato-Light.woff +0 -0
  21. package/dist/catalyst/assets/fonts/Lato-Light.woff2 +0 -0
  22. package/dist/catalyst/assets/fonts/Lato-LightItalic.woff +0 -0
  23. package/dist/catalyst/assets/fonts/Lato-LightItalic.woff2 +0 -0
  24. package/dist/catalyst/assets/fonts/Lato-Medium.woff +0 -0
  25. package/dist/catalyst/assets/fonts/Lato-Medium.woff2 +0 -0
  26. package/dist/catalyst/assets/fonts/Lato-MediumItalic.woff +0 -0
  27. package/dist/catalyst/assets/fonts/Lato-MediumItalic.woff2 +0 -0
  28. package/dist/catalyst/assets/fonts/Lato-Regular.woff +0 -0
  29. package/dist/catalyst/assets/fonts/Lato-Regular.woff2 +0 -0
  30. package/dist/catalyst/assets/fonts/Lato-Semibold.woff +0 -0
  31. package/dist/catalyst/assets/fonts/Lato-Semibold.woff2 +0 -0
  32. package/dist/catalyst/assets/fonts/Lato-SemiboldItalic.woff +0 -0
  33. package/dist/catalyst/assets/fonts/Lato-SemiboldItalic.woff2 +0 -0
  34. package/dist/catalyst/assets/fonts/Lato-Thin.woff +0 -0
  35. package/dist/catalyst/assets/fonts/Lato-Thin.woff2 +0 -0
  36. package/dist/catalyst/assets/fonts/Lato-ThinItalic.woff +0 -0
  37. package/dist/catalyst/assets/fonts/Lato-ThinItalic.woff2 +0 -0
  38. package/dist/catalyst/catalyst.css +6 -27
  39. package/dist/catalyst/catalyst.esm.js +1 -1
  40. package/dist/catalyst/catalyst.esm.js.map +1 -1
  41. package/dist/catalyst/index.esm.js.map +1 -1
  42. package/dist/catalyst/p-ccfebe33.js.map +1 -1
  43. package/dist/catalyst/p-d1ee6a09.entry.js +10 -0
  44. package/dist/catalyst/p-d1ee6a09.entry.js.map +1 -0
  45. package/dist/catalyst/p-d1fb9d96.js +3 -0
  46. package/dist/catalyst/p-d1fb9d96.js.map +1 -0
  47. package/dist/catalyst/scss/fonts/_fonts-mixins.scss +0 -10
  48. package/dist/cjs/cat-alert_24.cjs.entry.js +933 -1135
  49. package/dist/cjs/cat-alert_24.cjs.entry.js.map +1 -1
  50. package/dist/cjs/catalyst.cjs.js +10 -3
  51. package/dist/cjs/catalyst.cjs.js.map +1 -1
  52. package/dist/cjs/{index-c4542095.js → index-01312a2e.js} +527 -245
  53. package/dist/cjs/index-01312a2e.js.map +1 -0
  54. package/dist/cjs/index.cjs.js.map +1 -1
  55. package/dist/cjs/loader.cjs.js +4 -3
  56. package/dist/cjs/loader.cjs.js.map +1 -1
  57. package/dist/collection/assets/fonts/Lato-Black.woff +0 -0
  58. package/dist/collection/assets/fonts/Lato-Black.woff2 +0 -0
  59. package/dist/collection/assets/fonts/Lato-BlackItalic.woff +0 -0
  60. package/dist/collection/assets/fonts/Lato-BlackItalic.woff2 +0 -0
  61. package/dist/collection/assets/fonts/Lato-Bold.woff +0 -0
  62. package/dist/collection/assets/fonts/Lato-Bold.woff2 +0 -0
  63. package/dist/collection/assets/fonts/Lato-BoldItalic.woff +0 -0
  64. package/dist/collection/assets/fonts/Lato-BoldItalic.woff2 +0 -0
  65. package/dist/collection/assets/fonts/Lato-Hairline.woff +0 -0
  66. package/dist/collection/assets/fonts/Lato-Hairline.woff2 +0 -0
  67. package/dist/collection/assets/fonts/Lato-HairlineItalic.woff +0 -0
  68. package/dist/collection/assets/fonts/Lato-HairlineItalic.woff2 +0 -0
  69. package/dist/collection/assets/fonts/Lato-Heavy.woff +0 -0
  70. package/dist/collection/assets/fonts/Lato-Heavy.woff2 +0 -0
  71. package/dist/collection/assets/fonts/Lato-HeavyItalic.woff +0 -0
  72. package/dist/collection/assets/fonts/Lato-HeavyItalic.woff2 +0 -0
  73. package/dist/collection/assets/fonts/Lato-Italic.woff +0 -0
  74. package/dist/collection/assets/fonts/Lato-Italic.woff2 +0 -0
  75. package/dist/collection/assets/fonts/Lato-Light.woff +0 -0
  76. package/dist/collection/assets/fonts/Lato-Light.woff2 +0 -0
  77. package/dist/collection/assets/fonts/Lato-LightItalic.woff +0 -0
  78. package/dist/collection/assets/fonts/Lato-LightItalic.woff2 +0 -0
  79. package/dist/collection/assets/fonts/Lato-Medium.woff +0 -0
  80. package/dist/collection/assets/fonts/Lato-Medium.woff2 +0 -0
  81. package/dist/collection/assets/fonts/Lato-MediumItalic.woff +0 -0
  82. package/dist/collection/assets/fonts/Lato-MediumItalic.woff2 +0 -0
  83. package/dist/collection/assets/fonts/Lato-Regular.woff +0 -0
  84. package/dist/collection/assets/fonts/Lato-Regular.woff2 +0 -0
  85. package/dist/collection/assets/fonts/Lato-Semibold.woff +0 -0
  86. package/dist/collection/assets/fonts/Lato-Semibold.woff2 +0 -0
  87. package/dist/collection/assets/fonts/Lato-SemiboldItalic.woff +0 -0
  88. package/dist/collection/assets/fonts/Lato-SemiboldItalic.woff2 +0 -0
  89. package/dist/collection/assets/fonts/Lato-Thin.woff +0 -0
  90. package/dist/collection/assets/fonts/Lato-Thin.woff2 +0 -0
  91. package/dist/collection/assets/fonts/Lato-ThinItalic.woff +0 -0
  92. package/dist/collection/assets/fonts/Lato-ThinItalic.woff2 +0 -0
  93. package/dist/collection/collection-manifest.json +2 -2
  94. package/dist/collection/components/cat-alert/cat-alert.js +69 -71
  95. package/dist/collection/components/cat-alert/cat-alert.js.map +1 -1
  96. package/dist/collection/components/cat-avatar/cat-avatar.js +172 -165
  97. package/dist/collection/components/cat-avatar/cat-avatar.js.map +1 -1
  98. package/dist/collection/components/cat-badge/cat-badge.js +102 -111
  99. package/dist/collection/components/cat-badge/cat-badge.js.map +1 -1
  100. package/dist/collection/components/cat-button/cat-button.js +526 -537
  101. package/dist/collection/components/cat-button/cat-button.js.map +1 -1
  102. package/dist/collection/components/cat-card/cat-card.js +12 -8
  103. package/dist/collection/components/cat-checkbox/cat-checkbox.js +336 -350
  104. package/dist/collection/components/cat-checkbox/cat-checkbox.js.map +1 -1
  105. package/dist/collection/components/cat-dropdown/cat-dropdown.js +137 -137
  106. package/dist/collection/components/cat-dropdown/cat-dropdown.js.map +1 -1
  107. package/dist/collection/components/cat-form-group/cat-form-group.js +58 -40
  108. package/dist/collection/components/cat-form-group/cat-form-group.js.map +1 -1
  109. package/dist/collection/components/cat-form-hint/cat-form-hint.js +14 -7
  110. package/dist/collection/components/cat-form-hint/cat-form-hint.js.map +1 -1
  111. package/dist/collection/components/cat-i18n/cat-i18n-registry.js +1 -1
  112. package/dist/collection/components/cat-icon/cat-icon-registry.js +1 -1
  113. package/dist/collection/components/cat-icon/cat-icon.js +85 -79
  114. package/dist/collection/components/cat-icon/cat-icon.js.map +1 -1
  115. package/dist/collection/components/cat-input/cat-input.css +32 -3
  116. package/dist/collection/components/cat-input/cat-input.js +662 -660
  117. package/dist/collection/components/cat-input/cat-input.js.map +1 -1
  118. package/dist/collection/components/cat-input/input-type.js +1 -1
  119. package/dist/collection/components/cat-label/cat-label.js +69 -78
  120. package/dist/collection/components/cat-label/cat-label.js.map +1 -1
  121. package/dist/collection/components/cat-notification/cat-notification.js +1 -1
  122. package/dist/collection/components/cat-notification/cat-notification.js.map +1 -1
  123. package/dist/collection/components/cat-pagination/cat-pagination.js +192 -226
  124. package/dist/collection/components/cat-pagination/cat-pagination.js.map +1 -1
  125. package/dist/collection/components/cat-radio/cat-radio.js +319 -327
  126. package/dist/collection/components/cat-radio/cat-radio.js.map +1 -1
  127. package/dist/collection/components/cat-radio-group/cat-radio-group.js +173 -165
  128. package/dist/collection/components/cat-radio-group/cat-radio-group.js.map +1 -1
  129. package/dist/collection/components/cat-scrollable/cat-scrollable.js +200 -208
  130. package/dist/collection/components/cat-scrollable/cat-scrollable.js.map +1 -1
  131. package/dist/collection/components/cat-select/cat-select.js +556 -593
  132. package/dist/collection/components/cat-select/cat-select.js.map +1 -1
  133. package/dist/collection/components/cat-select-demo/cat-select-demo.js +3 -28
  134. package/dist/collection/components/cat-select-demo/cat-select-demo.js.map +1 -1
  135. package/dist/collection/components/cat-skeleton/cat-skeleton.js +85 -88
  136. package/dist/collection/components/cat-skeleton/cat-skeleton.js.map +1 -1
  137. package/dist/collection/components/cat-spinner/cat-spinner.js +52 -50
  138. package/dist/collection/components/cat-spinner/cat-spinner.js.map +1 -1
  139. package/dist/collection/components/cat-tab/cat-tab.js +169 -168
  140. package/dist/collection/components/cat-tab/cat-tab.js.map +1 -1
  141. package/dist/collection/components/cat-tabs/cat-tabs.js +73 -66
  142. package/dist/collection/components/cat-tabs/cat-tabs.js.map +1 -1
  143. package/dist/collection/components/cat-textarea/cat-textarea.css +32 -1
  144. package/dist/collection/components/cat-textarea/cat-textarea.js +479 -468
  145. package/dist/collection/components/cat-textarea/cat-textarea.js.map +1 -1
  146. package/dist/collection/components/cat-toggle/cat-toggle.js +319 -326
  147. package/dist/collection/components/cat-toggle/cat-toggle.js.map +1 -1
  148. package/dist/collection/components/cat-tooltip/cat-tooltip.css +7 -1
  149. package/dist/collection/components/cat-tooltip/cat-tooltip.js +187 -198
  150. package/dist/collection/components/cat-tooltip/cat-tooltip.js.map +1 -1
  151. package/dist/collection/index.js +1 -1
  152. package/dist/collection/scss/fonts/_fonts-mixins.scss +0 -10
  153. package/dist/collection/utils/breakpoints.js +1 -1
  154. package/dist/collection/utils/breakpoints.js.map +1 -1
  155. package/dist/collection/utils/coerce.js +11 -0
  156. package/dist/collection/utils/coerce.js.map +1 -0
  157. package/dist/collection/utils/first-tabbable.js +1 -1
  158. package/dist/collection/utils/is-touch-screen.js +1 -1
  159. package/dist/collection/utils/load-img.js +1 -1
  160. package/dist/collection/utils/media-matcher.js +1 -1
  161. package/dist/collection/utils/platform.js +4 -4
  162. package/dist/collection/utils/setDefault.js +1 -1
  163. package/dist/components/cat-alert.js +1 -6
  164. package/dist/components/cat-alert.js.map +1 -1
  165. package/dist/components/cat-avatar2.js +6 -9
  166. package/dist/components/cat-avatar2.js.map +1 -1
  167. package/dist/components/cat-badge.js +0 -15
  168. package/dist/components/cat-badge.js.map +1 -1
  169. package/dist/components/cat-button2.js +10 -36
  170. package/dist/components/cat-button2.js.map +1 -1
  171. package/dist/components/cat-checkbox2.js +9 -26
  172. package/dist/components/cat-checkbox2.js.map +1 -1
  173. package/dist/components/cat-dropdown2.js +139 -176
  174. package/dist/components/cat-dropdown2.js.map +1 -1
  175. package/dist/components/cat-form-group.js +4 -9
  176. package/dist/components/cat-form-group.js.map +1 -1
  177. package/dist/components/cat-form-hint.js +13 -6
  178. package/dist/components/cat-form-hint.js.map +1 -1
  179. package/dist/components/cat-icon-registry.js +71 -0
  180. package/dist/components/cat-icon-registry.js.map +1 -0
  181. package/dist/components/cat-icon.js +1 -1
  182. package/dist/components/cat-icon2.js +5 -71
  183. package/dist/components/cat-icon2.js.map +1 -1
  184. package/dist/components/cat-input.js +33 -41
  185. package/dist/components/cat-input.js.map +1 -1
  186. package/dist/components/cat-label.js +1 -6
  187. package/dist/components/cat-label.js.map +1 -1
  188. package/dist/components/cat-pagination.js +0 -30
  189. package/dist/components/cat-pagination.js.map +1 -1
  190. package/dist/components/cat-radio-group.js +3 -6
  191. package/dist/components/cat-radio-group.js.map +1 -1
  192. package/dist/components/cat-radio.js +9 -23
  193. package/dist/components/cat-radio.js.map +1 -1
  194. package/dist/components/cat-scrollable2.js +1 -12
  195. package/dist/components/cat-scrollable2.js.map +1 -1
  196. package/dist/components/cat-select-demo.js +2 -12
  197. package/dist/components/cat-select-demo.js.map +1 -1
  198. package/dist/components/cat-select2.js +41 -50
  199. package/dist/components/cat-select2.js.map +1 -1
  200. package/dist/components/cat-skeleton2.js +1 -10
  201. package/dist/components/cat-skeleton2.js.map +1 -1
  202. package/dist/components/cat-spinner2.js +1 -3
  203. package/dist/components/cat-spinner2.js.map +1 -1
  204. package/dist/components/cat-tab.js +3 -12
  205. package/dist/components/cat-tab.js.map +1 -1
  206. package/dist/components/cat-tabs.js +1 -6
  207. package/dist/components/cat-tabs.js.map +1 -1
  208. package/dist/components/cat-textarea.js +28 -33
  209. package/dist/components/cat-textarea.js.map +1 -1
  210. package/dist/components/cat-toggle.js +9 -23
  211. package/dist/components/cat-toggle.js.map +1 -1
  212. package/dist/components/cat-tooltip.js +14 -34
  213. package/dist/components/cat-tooltip.js.map +1 -1
  214. package/dist/components/first-tabbable.js +51 -113
  215. package/dist/components/first-tabbable.js.map +1 -1
  216. package/dist/components/floating-ui.dom.esm.js +577 -441
  217. package/dist/components/floating-ui.dom.esm.js.map +1 -1
  218. package/dist/components/index.d.ts +9 -27
  219. package/dist/components/index.js +2 -26
  220. package/dist/components/index.js.map +1 -1
  221. package/dist/esm/cat-alert_24.entry.js +934 -1136
  222. package/dist/esm/cat-alert_24.entry.js.map +1 -1
  223. package/dist/esm/catalyst.js +7 -3
  224. package/dist/esm/catalyst.js.map +1 -1
  225. package/dist/esm/{index-524906f7.js → index-fc2f91a4.js} +527 -246
  226. package/dist/esm/index-fc2f91a4.js.map +1 -0
  227. package/dist/esm/index.js.map +1 -1
  228. package/dist/esm/loader.js +4 -3
  229. package/dist/esm/loader.js.map +1 -1
  230. package/dist/esm/polyfills/css-shim.js +1 -1
  231. package/dist/types/components/cat-checkbox/cat-checkbox.d.ts +1 -1
  232. package/dist/types/components/cat-form-group/cat-form-group.d.ts +4 -0
  233. package/dist/types/components/cat-form-hint/cat-form-hint.d.ts +5 -0
  234. package/dist/types/components/cat-input/cat-input.d.ts +6 -1
  235. package/dist/types/components/cat-input/input-type.d.ts +1 -1
  236. package/dist/types/components/cat-radio/cat-radio.d.ts +1 -1
  237. package/dist/types/components/cat-select/cat-select.d.ts +2 -1
  238. package/dist/types/components/cat-textarea/cat-textarea.d.ts +6 -1
  239. package/dist/types/components/cat-toggle/cat-toggle.d.ts +1 -1
  240. package/dist/types/components/cat-tooltip/cat-tooltip.d.ts +3 -0
  241. package/dist/types/components.d.ts +353 -7
  242. package/dist/types/stencil-public-runtime.d.ts +91 -19
  243. package/dist/types/utils/breakpoints.d.ts +1 -1
  244. package/dist/types/utils/coerce.d.ts +3 -0
  245. package/dist/types/utils/first-tabbable.d.ts +2 -2
  246. package/loader/index.d.ts +9 -0
  247. package/loader/package.json +1 -0
  248. package/package.json +19 -19
  249. package/dist/catalyst/assets/fonts/AzeretMono-Regular.woff2 +0 -0
  250. package/dist/catalyst/assets/fonts/DMSans-Bold.woff2 +0 -0
  251. package/dist/catalyst/assets/fonts/DMSans-BoldItalic.woff2 +0 -0
  252. package/dist/catalyst/assets/fonts/DMSans-Italic.woff2 +0 -0
  253. package/dist/catalyst/assets/fonts/DMSans-Medium.woff2 +0 -0
  254. package/dist/catalyst/assets/fonts/DMSans-MediumItalic.woff2 +0 -0
  255. package/dist/catalyst/assets/fonts/DMSans-Regular.woff2 +0 -0
  256. package/dist/catalyst/p-919eea27.js +0 -3
  257. package/dist/catalyst/p-919eea27.js.map +0 -1
  258. package/dist/catalyst/p-cd8f8639.entry.js +0 -10
  259. package/dist/catalyst/p-cd8f8639.entry.js.map +0 -1
  260. package/dist/catalyst/scss/fonts/_fonts.mixins.azeret.scss +0 -14
  261. package/dist/catalyst/scss/fonts/_fonts.mixins.dm.scss +0 -53
  262. package/dist/cjs/index-c4542095.js.map +0 -1
  263. package/dist/collection/assets/fonts/AzeretMono-Regular.woff2 +0 -0
  264. package/dist/collection/assets/fonts/DMSans-Bold.woff2 +0 -0
  265. package/dist/collection/assets/fonts/DMSans-BoldItalic.woff2 +0 -0
  266. package/dist/collection/assets/fonts/DMSans-Italic.woff2 +0 -0
  267. package/dist/collection/assets/fonts/DMSans-Medium.woff2 +0 -0
  268. package/dist/collection/assets/fonts/DMSans-MediumItalic.woff2 +0 -0
  269. package/dist/collection/assets/fonts/DMSans-Regular.woff2 +0 -0
  270. package/dist/collection/components/cat-form-hint/cat-form-hint-utils.js +0 -13
  271. package/dist/collection/components/cat-form-hint/cat-form-hint-utils.js.map +0 -1
  272. package/dist/collection/scss/fonts/_fonts.mixins.azeret.scss +0 -14
  273. package/dist/collection/scss/fonts/_fonts.mixins.dm.scss +0 -53
  274. package/dist/components/cat-form-hint-utils.js +0 -17
  275. package/dist/components/cat-form-hint-utils.js.map +0 -1
  276. package/dist/esm/index-524906f7.js.map +0 -1
  277. package/dist/types/components/cat-form-hint/cat-form-hint-utils.d.ts +0 -4
@@ -8,10 +8,20 @@ import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
8
8
  import { Breakpoint } from "./utils/breakpoints";
9
9
  import { Placement } from "@floating-ui/dom";
10
10
  import { InputType } from "./components/cat-input/input-type";
11
- import { ErrorMap } from "./components/cat-form-hint/cat-form-hint-utils";
11
+ import { ErrorMap } from "./components/cat-form-hint/cat-form-hint";
12
12
  import { CatSelectConnector, CatSelectMultipleTaggingValue, CatSelectTaggingValue, Item } from "./components/cat-select/cat-select";
13
13
  import { Observable } from "rxjs";
14
+ export { Breakpoint } from "./utils/breakpoints";
15
+ export { Placement } from "@floating-ui/dom";
16
+ export { InputType } from "./components/cat-input/input-type";
17
+ export { ErrorMap } from "./components/cat-form-hint/cat-form-hint";
18
+ export { CatSelectConnector, CatSelectMultipleTaggingValue, CatSelectTaggingValue, Item } from "./components/cat-select/cat-select";
19
+ export { Observable } from "rxjs";
14
20
  export namespace Components {
21
+ /**
22
+ * Informs user about important changes or conditions in the interface. Use this
23
+ * component if you need to capture user’s attention in a prominent way.
24
+ */
15
25
  interface CatAlert {
16
26
  /**
17
27
  * The color palette of the alert.
@@ -26,6 +36,9 @@ export namespace Components {
26
36
  */
27
37
  "noIcon": boolean;
28
38
  }
39
+ /**
40
+ * Avatars are used to represent a person or object.
41
+ */
29
42
  interface CatAvatar {
30
43
  /**
31
44
  * An icon to be used instead of the initials.
@@ -60,6 +73,10 @@ export namespace Components {
60
73
  */
61
74
  "urlTarget"?: '_blank' | '_self';
62
75
  }
76
+ /**
77
+ * Badges are used to inform users of the status of an object or of an action
78
+ * that’s been taken.
79
+ */
63
80
  interface CatBadge {
64
81
  /**
65
82
  * The color palette of the badge.
@@ -82,6 +99,10 @@ export namespace Components {
82
99
  */
83
100
  "variant": 'filled' | 'outlined';
84
101
  }
102
+ /**
103
+ * Buttons are used for interface actions. Primary style should be used only
104
+ * once per view for main call-to-action.
105
+ */
85
106
  interface CatButton {
86
107
  /**
87
108
  * Sets the `aria-current` attribute on the button.
@@ -119,7 +140,7 @@ export namespace Components {
119
140
  * Programmatically move focus to the button. Use this method instead of `button.focus()`.
120
141
  * @param options An optional object providing options to control aspects of the focusing process.
121
142
  */
122
- "doFocus": (options?: FocusOptions | undefined) => Promise<void>;
143
+ "doFocus": (options?: FocusOptions) => Promise<void>;
123
144
  /**
124
145
  * The name of an icon to be displayed in the button.
125
146
  */
@@ -181,8 +202,16 @@ export namespace Components {
181
202
  */
182
203
  "variant": 'filled' | 'outlined' | 'text';
183
204
  }
205
+ /**
206
+ * Cards are surfaces that display content and actions on a single topic. They
207
+ * should be easy to scan for relevant and actionable information.
208
+ */
184
209
  interface CatCard {
185
210
  }
211
+ /**
212
+ * Checkboxes are used to let a user choose one or more options from a limited
213
+ * number of options.
214
+ */
186
215
  interface CatCheckbox {
187
216
  /**
188
217
  * Checked state of the checkbox
@@ -204,7 +233,7 @@ export namespace Components {
204
233
  * Programmatically move focus to the checkbox. Use this method instead of `input.focus()`.
205
234
  * @param options An optional object providing options to control aspects of the focusing process.
206
235
  */
207
- "doFocus": (options?: FocusOptions | undefined) => Promise<void>;
236
+ "doFocus": (options?: FocusOptions) => Promise<void>;
208
237
  /**
209
238
  * Optional hint text(s) to be displayed with the checkbox.
210
239
  */
@@ -265,11 +294,19 @@ export namespace Components {
265
294
  "placement": Placement;
266
295
  }
267
296
  interface CatFormGroup {
297
+ /**
298
+ * The space allocated to the input label
299
+ */
300
+ "labelSize"?: string;
268
301
  /**
269
302
  * Whether the labels need a marker to shown if the forms fields are required or optional.<br /><br /> By default, it is set to auto, it will display the mark depending on the number of required and optional fields: <br /> - If there are more required, the optional will be marked.<br /> - If there are less required, it will mark the required.<br /><br /> If a form field had "!", the requiredMarked of the field would not change.
270
303
  */
271
304
  "requiredMarker": 'none' | 'required' | 'optional' | 'auto';
272
305
  }
306
+ /**
307
+ * Icons are used to provide additional meaning or in places where text label
308
+ * doesn't fit.
309
+ */
273
310
  interface CatIcon {
274
311
  /**
275
312
  * Adds accessible label for the icon that is only shown for screen readers. The `aria-hidden` attribute will be set if no label is present.
@@ -288,6 +325,11 @@ export namespace Components {
288
325
  */
289
326
  "size": 'xs' | 's' | 'm' | 'l' | 'xl' | 'inline';
290
327
  }
328
+ /**
329
+ * Inputs are used to allow users to provide text input when the expected input
330
+ * is short. As well as plain text, Input supports various types of text,
331
+ * including passwords and numbers.
332
+ */
291
333
  interface CatInput {
292
334
  /**
293
335
  * Hint for form autofill feature.
@@ -317,7 +359,7 @@ export namespace Components {
317
359
  * Programmatically move focus to the input. Use this method instead of `input.focus()`.
318
360
  * @param options An optional object providing options to control aspects of the focusing process.
319
361
  */
320
- "doFocus": (options?: FocusOptions | undefined) => Promise<void>;
362
+ "doFocus": (options?: FocusOptions) => Promise<void>;
321
363
  /**
322
364
  * Fine-grained control over when the errors are shown. Can be `false` to never show errors, `true` to show errors on blur, or a number to show errors on change with the given delay in milliseconds.
323
365
  */
@@ -330,6 +372,10 @@ export namespace Components {
330
372
  * Optional hint text(s) to be displayed with the input.
331
373
  */
332
374
  "hint"?: string | string[];
375
+ /**
376
+ * Whether the label is on top or left.
377
+ */
378
+ "horizontal": boolean;
333
379
  /**
334
380
  * The name of an icon to be displayed in the input.
335
381
  */
@@ -411,6 +457,9 @@ export namespace Components {
411
457
  */
412
458
  "value"?: string | number;
413
459
  }
460
+ /**
461
+ * Labels are used to provide a short description of an input or form element.
462
+ */
414
463
  interface CatLabel {
415
464
  /**
416
465
  * The unique identifier for a referenced input.
@@ -425,6 +474,13 @@ export namespace Components {
425
474
  */
426
475
  "requiredMarker": 'none' | 'required' | 'optional' | 'none!' | 'optional!' | 'required!';
427
476
  }
477
+ /**
478
+ * A navigation component to switch between different pages of paged chunks of
479
+ * data such as a table. Pagination is built with list HTML elements and a
480
+ * wrapping `<nav>` element to identify it as a navigation section to screen
481
+ * readers and other assistive technologies. Furthermore, the current page is
482
+ * correctly highlighted using `aria-current`.
483
+ */
428
484
  interface CatPagination {
429
485
  /**
430
486
  * The number of pages to be shown around the current page.
@@ -467,6 +523,10 @@ export namespace Components {
467
523
  */
468
524
  "variant": 'filled' | 'outlined' | 'text';
469
525
  }
526
+ /**
527
+ * Radio Buttons are graphical interface elements that allow user to choose
528
+ * only one of a predefined set of mutually exclusive options.
529
+ */
470
530
  interface CatRadio {
471
531
  /**
472
532
  * Whether this radio is checked.
@@ -488,7 +548,7 @@ export namespace Components {
488
548
  * Programmatically move focus to the radio button. Use this method instead of `input.focus()`.
489
549
  * @param options An optional object providing options to control aspects of the focusing process.
490
550
  */
491
- "doFocus": (options?: FocusOptions | undefined) => Promise<void>;
551
+ "doFocus": (options?: FocusOptions) => Promise<void>;
492
552
  /**
493
553
  * Optional hint text(s) to be displayed with the radio.
494
554
  */
@@ -526,6 +586,9 @@ export namespace Components {
526
586
  */
527
587
  "value"?: string;
528
588
  }
589
+ /**
590
+ * A group of radio buttons.
591
+ */
529
592
  interface CatRadioGroup {
530
593
  /**
531
594
  * Adds an accessible label for the radio group that it is only shown in assistive technologies, like screen readers.
@@ -548,6 +611,9 @@ export namespace Components {
548
611
  */
549
612
  "value"?: string;
550
613
  }
614
+ /**
615
+ * An element to display scrollable content.
616
+ */
551
617
  interface CatScrollable {
552
618
  /**
553
619
  * Flags to disable/enable overflowX.
@@ -578,6 +644,11 @@ export namespace Components {
578
644
  */
579
645
  "scrolledBuffer": number;
580
646
  }
647
+ /**
648
+ * Select lets user choose one option from an options' menu. Consider using
649
+ * select when you have 6 or more options. Select component supports any content
650
+ * type.
651
+ */
581
652
  interface CatSelect {
582
653
  /**
583
654
  * Whether the select should show a clear button.
@@ -667,6 +738,9 @@ export namespace Components {
667
738
  }
668
739
  interface CatSelectDemo {
669
740
  }
741
+ /**
742
+ * Skeletons are used to show where content will eventually be drawn.
743
+ */
670
744
  interface CatSkeleton {
671
745
  /**
672
746
  * The animation style of the skeleton.
@@ -685,6 +759,9 @@ export namespace Components {
685
759
  */
686
760
  "variant": 'rectangle' | 'square' | 'circle' | 'head' | 'body';
687
761
  }
762
+ /**
763
+ * Spinners are used to indicate users that their action is being processed.
764
+ */
688
765
  interface CatSpinner {
689
766
  /**
690
767
  * Adds accessible label for the spinner that is only shown for screen readers. The `aria-hidden` attribute will be set if no label is present.
@@ -695,6 +772,9 @@ export namespace Components {
695
772
  */
696
773
  "size": 'xs' | 's' | 'm' | 'l' | 'xl' | 'inline';
697
774
  }
775
+ /**
776
+ * A single tab inside a tabs component.
777
+ */
698
778
  interface CatTab {
699
779
  /**
700
780
  * Specifies that the tab should be deactivated.
@@ -725,6 +805,10 @@ export namespace Components {
725
805
  */
726
806
  "urlTarget"?: '_blank' | '_self';
727
807
  }
808
+ /**
809
+ * Tabs are used to display multiple panels to be contained within a single
810
+ * window, using tabs as a navigational element.
811
+ */
728
812
  interface CatTabs {
729
813
  /**
730
814
  * The ID of the active tab.
@@ -735,6 +819,11 @@ export namespace Components {
735
819
  */
736
820
  "tabsAlign": 'left' | 'center' | 'right' | 'justify';
737
821
  }
822
+ /**
823
+ * Textarea specifies a control that allows user to write text over multiple
824
+ * rows. Used when the expected user input is long. For shorter input, use the
825
+ * input component.
826
+ */
738
827
  interface CatTextarea {
739
828
  /**
740
829
  * Whether the textarea is disabled.
@@ -752,7 +841,7 @@ export namespace Components {
752
841
  * Programmatically move focus to the textarea. Use this method instead of `textarea.focus()`.
753
842
  * @param options An optional object providing options to control aspects of the focusing process.
754
843
  */
755
- "doFocus": (options?: FocusOptions | undefined) => Promise<void>;
844
+ "doFocus": (options?: FocusOptions) => Promise<void>;
756
845
  /**
757
846
  * Fine-grained control over when the errors are shown. Can be `false` to never show errors, `true` to show errors on blur, or a number to show errors on change with the given delay in milliseconds.
758
847
  */
@@ -765,6 +854,10 @@ export namespace Components {
765
854
  * Optional hint text(s) to be displayed with the textarea.
766
855
  */
767
856
  "hint"?: string | string[];
857
+ /**
858
+ * Whether the label is on top or left.
859
+ */
860
+ "horizontal": boolean;
768
861
  /**
769
862
  * A unique identifier for the input.
770
863
  */
@@ -818,6 +911,10 @@ export namespace Components {
818
911
  */
819
912
  "value"?: string | number;
820
913
  }
914
+ /**
915
+ * Toggles are graphical interface switches that give user control over a
916
+ * feature or option that can be turned on or off.
917
+ */
821
918
  interface CatToggle {
822
919
  /**
823
920
  * Checked state of the toggle.
@@ -839,7 +936,7 @@ export namespace Components {
839
936
  * Programmatically move focus to the toggle. Use this method instead of `input.focus()`.
840
937
  * @param options An optional object providing options to control aspects of the focusing process.
841
938
  */
842
- "doFocus": (options?: FocusOptions | undefined) => Promise<void>;
939
+ "doFocus": (options?: FocusOptions) => Promise<void>;
843
940
  /**
844
941
  * Optional hint text(s) to be displayed with the toggle.
845
942
  */
@@ -957,36 +1054,59 @@ export interface CatToggleCustomEvent<T> extends CustomEvent<T> {
957
1054
  target: HTMLCatToggleElement;
958
1055
  }
959
1056
  declare global {
1057
+ /**
1058
+ * Informs user about important changes or conditions in the interface. Use this
1059
+ * component if you need to capture user’s attention in a prominent way.
1060
+ */
960
1061
  interface HTMLCatAlertElement extends Components.CatAlert, HTMLStencilElement {
961
1062
  }
962
1063
  var HTMLCatAlertElement: {
963
1064
  prototype: HTMLCatAlertElement;
964
1065
  new (): HTMLCatAlertElement;
965
1066
  };
1067
+ /**
1068
+ * Avatars are used to represent a person or object.
1069
+ */
966
1070
  interface HTMLCatAvatarElement extends Components.CatAvatar, HTMLStencilElement {
967
1071
  }
968
1072
  var HTMLCatAvatarElement: {
969
1073
  prototype: HTMLCatAvatarElement;
970
1074
  new (): HTMLCatAvatarElement;
971
1075
  };
1076
+ /**
1077
+ * Badges are used to inform users of the status of an object or of an action
1078
+ * that’s been taken.
1079
+ */
972
1080
  interface HTMLCatBadgeElement extends Components.CatBadge, HTMLStencilElement {
973
1081
  }
974
1082
  var HTMLCatBadgeElement: {
975
1083
  prototype: HTMLCatBadgeElement;
976
1084
  new (): HTMLCatBadgeElement;
977
1085
  };
1086
+ /**
1087
+ * Buttons are used for interface actions. Primary style should be used only
1088
+ * once per view for main call-to-action.
1089
+ */
978
1090
  interface HTMLCatButtonElement extends Components.CatButton, HTMLStencilElement {
979
1091
  }
980
1092
  var HTMLCatButtonElement: {
981
1093
  prototype: HTMLCatButtonElement;
982
1094
  new (): HTMLCatButtonElement;
983
1095
  };
1096
+ /**
1097
+ * Cards are surfaces that display content and actions on a single topic. They
1098
+ * should be easy to scan for relevant and actionable information.
1099
+ */
984
1100
  interface HTMLCatCardElement extends Components.CatCard, HTMLStencilElement {
985
1101
  }
986
1102
  var HTMLCatCardElement: {
987
1103
  prototype: HTMLCatCardElement;
988
1104
  new (): HTMLCatCardElement;
989
1105
  };
1106
+ /**
1107
+ * Checkboxes are used to let a user choose one or more options from a limited
1108
+ * number of options.
1109
+ */
990
1110
  interface HTMLCatCheckboxElement extends Components.CatCheckbox, HTMLStencilElement {
991
1111
  }
992
1112
  var HTMLCatCheckboxElement: {
@@ -1005,48 +1125,82 @@ declare global {
1005
1125
  prototype: HTMLCatFormGroupElement;
1006
1126
  new (): HTMLCatFormGroupElement;
1007
1127
  };
1128
+ /**
1129
+ * Icons are used to provide additional meaning or in places where text label
1130
+ * doesn't fit.
1131
+ */
1008
1132
  interface HTMLCatIconElement extends Components.CatIcon, HTMLStencilElement {
1009
1133
  }
1010
1134
  var HTMLCatIconElement: {
1011
1135
  prototype: HTMLCatIconElement;
1012
1136
  new (): HTMLCatIconElement;
1013
1137
  };
1138
+ /**
1139
+ * Inputs are used to allow users to provide text input when the expected input
1140
+ * is short. As well as plain text, Input supports various types of text,
1141
+ * including passwords and numbers.
1142
+ */
1014
1143
  interface HTMLCatInputElement extends Components.CatInput, HTMLStencilElement {
1015
1144
  }
1016
1145
  var HTMLCatInputElement: {
1017
1146
  prototype: HTMLCatInputElement;
1018
1147
  new (): HTMLCatInputElement;
1019
1148
  };
1149
+ /**
1150
+ * Labels are used to provide a short description of an input or form element.
1151
+ */
1020
1152
  interface HTMLCatLabelElement extends Components.CatLabel, HTMLStencilElement {
1021
1153
  }
1022
1154
  var HTMLCatLabelElement: {
1023
1155
  prototype: HTMLCatLabelElement;
1024
1156
  new (): HTMLCatLabelElement;
1025
1157
  };
1158
+ /**
1159
+ * A navigation component to switch between different pages of paged chunks of
1160
+ * data such as a table. Pagination is built with list HTML elements and a
1161
+ * wrapping `<nav>` element to identify it as a navigation section to screen
1162
+ * readers and other assistive technologies. Furthermore, the current page is
1163
+ * correctly highlighted using `aria-current`.
1164
+ */
1026
1165
  interface HTMLCatPaginationElement extends Components.CatPagination, HTMLStencilElement {
1027
1166
  }
1028
1167
  var HTMLCatPaginationElement: {
1029
1168
  prototype: HTMLCatPaginationElement;
1030
1169
  new (): HTMLCatPaginationElement;
1031
1170
  };
1171
+ /**
1172
+ * Radio Buttons are graphical interface elements that allow user to choose
1173
+ * only one of a predefined set of mutually exclusive options.
1174
+ */
1032
1175
  interface HTMLCatRadioElement extends Components.CatRadio, HTMLStencilElement {
1033
1176
  }
1034
1177
  var HTMLCatRadioElement: {
1035
1178
  prototype: HTMLCatRadioElement;
1036
1179
  new (): HTMLCatRadioElement;
1037
1180
  };
1181
+ /**
1182
+ * A group of radio buttons.
1183
+ */
1038
1184
  interface HTMLCatRadioGroupElement extends Components.CatRadioGroup, HTMLStencilElement {
1039
1185
  }
1040
1186
  var HTMLCatRadioGroupElement: {
1041
1187
  prototype: HTMLCatRadioGroupElement;
1042
1188
  new (): HTMLCatRadioGroupElement;
1043
1189
  };
1190
+ /**
1191
+ * An element to display scrollable content.
1192
+ */
1044
1193
  interface HTMLCatScrollableElement extends Components.CatScrollable, HTMLStencilElement {
1045
1194
  }
1046
1195
  var HTMLCatScrollableElement: {
1047
1196
  prototype: HTMLCatScrollableElement;
1048
1197
  new (): HTMLCatScrollableElement;
1049
1198
  };
1199
+ /**
1200
+ * Select lets user choose one option from an options' menu. Consider using
1201
+ * select when you have 6 or more options. Select component supports any content
1202
+ * type.
1203
+ */
1050
1204
  interface HTMLCatSelectElement extends Components.CatSelect, HTMLStencilElement {
1051
1205
  }
1052
1206
  var HTMLCatSelectElement: {
@@ -1059,36 +1213,58 @@ declare global {
1059
1213
  prototype: HTMLCatSelectDemoElement;
1060
1214
  new (): HTMLCatSelectDemoElement;
1061
1215
  };
1216
+ /**
1217
+ * Skeletons are used to show where content will eventually be drawn.
1218
+ */
1062
1219
  interface HTMLCatSkeletonElement extends Components.CatSkeleton, HTMLStencilElement {
1063
1220
  }
1064
1221
  var HTMLCatSkeletonElement: {
1065
1222
  prototype: HTMLCatSkeletonElement;
1066
1223
  new (): HTMLCatSkeletonElement;
1067
1224
  };
1225
+ /**
1226
+ * Spinners are used to indicate users that their action is being processed.
1227
+ */
1068
1228
  interface HTMLCatSpinnerElement extends Components.CatSpinner, HTMLStencilElement {
1069
1229
  }
1070
1230
  var HTMLCatSpinnerElement: {
1071
1231
  prototype: HTMLCatSpinnerElement;
1072
1232
  new (): HTMLCatSpinnerElement;
1073
1233
  };
1234
+ /**
1235
+ * A single tab inside a tabs component.
1236
+ */
1074
1237
  interface HTMLCatTabElement extends Components.CatTab, HTMLStencilElement {
1075
1238
  }
1076
1239
  var HTMLCatTabElement: {
1077
1240
  prototype: HTMLCatTabElement;
1078
1241
  new (): HTMLCatTabElement;
1079
1242
  };
1243
+ /**
1244
+ * Tabs are used to display multiple panels to be contained within a single
1245
+ * window, using tabs as a navigational element.
1246
+ */
1080
1247
  interface HTMLCatTabsElement extends Components.CatTabs, HTMLStencilElement {
1081
1248
  }
1082
1249
  var HTMLCatTabsElement: {
1083
1250
  prototype: HTMLCatTabsElement;
1084
1251
  new (): HTMLCatTabsElement;
1085
1252
  };
1253
+ /**
1254
+ * Textarea specifies a control that allows user to write text over multiple
1255
+ * rows. Used when the expected user input is long. For shorter input, use the
1256
+ * input component.
1257
+ */
1086
1258
  interface HTMLCatTextareaElement extends Components.CatTextarea, HTMLStencilElement {
1087
1259
  }
1088
1260
  var HTMLCatTextareaElement: {
1089
1261
  prototype: HTMLCatTextareaElement;
1090
1262
  new (): HTMLCatTextareaElement;
1091
1263
  };
1264
+ /**
1265
+ * Toggles are graphical interface switches that give user control over a
1266
+ * feature or option that can be turned on or off.
1267
+ */
1092
1268
  interface HTMLCatToggleElement extends Components.CatToggle, HTMLStencilElement {
1093
1269
  }
1094
1270
  var HTMLCatToggleElement: {
@@ -1129,6 +1305,10 @@ declare global {
1129
1305
  }
1130
1306
  }
1131
1307
  declare namespace LocalJSX {
1308
+ /**
1309
+ * Informs user about important changes or conditions in the interface. Use this
1310
+ * component if you need to capture user’s attention in a prominent way.
1311
+ */
1132
1312
  interface CatAlert {
1133
1313
  /**
1134
1314
  * The color palette of the alert.
@@ -1143,6 +1323,9 @@ declare namespace LocalJSX {
1143
1323
  */
1144
1324
  "noIcon"?: boolean;
1145
1325
  }
1326
+ /**
1327
+ * Avatars are used to represent a person or object.
1328
+ */
1146
1329
  interface CatAvatar {
1147
1330
  /**
1148
1331
  * An icon to be used instead of the initials.
@@ -1177,6 +1360,10 @@ declare namespace LocalJSX {
1177
1360
  */
1178
1361
  "urlTarget"?: '_blank' | '_self';
1179
1362
  }
1363
+ /**
1364
+ * Badges are used to inform users of the status of an object or of an action
1365
+ * that’s been taken.
1366
+ */
1180
1367
  interface CatBadge {
1181
1368
  /**
1182
1369
  * The color palette of the badge.
@@ -1199,6 +1386,10 @@ declare namespace LocalJSX {
1199
1386
  */
1200
1387
  "variant"?: 'filled' | 'outlined';
1201
1388
  }
1389
+ /**
1390
+ * Buttons are used for interface actions. Primary style should be used only
1391
+ * once per view for main call-to-action.
1392
+ */
1202
1393
  interface CatButton {
1203
1394
  /**
1204
1395
  * Sets the `aria-current` attribute on the button.
@@ -1297,8 +1488,16 @@ declare namespace LocalJSX {
1297
1488
  */
1298
1489
  "variant"?: 'filled' | 'outlined' | 'text';
1299
1490
  }
1491
+ /**
1492
+ * Cards are surfaces that display content and actions on a single topic. They
1493
+ * should be easy to scan for relevant and actionable information.
1494
+ */
1300
1495
  interface CatCard {
1301
1496
  }
1497
+ /**
1498
+ * Checkboxes are used to let a user choose one or more options from a limited
1499
+ * number of options.
1500
+ */
1302
1501
  interface CatCheckbox {
1303
1502
  /**
1304
1503
  * Checked state of the checkbox
@@ -1384,11 +1583,19 @@ declare namespace LocalJSX {
1384
1583
  "placement"?: Placement;
1385
1584
  }
1386
1585
  interface CatFormGroup {
1586
+ /**
1587
+ * The space allocated to the input label
1588
+ */
1589
+ "labelSize"?: string;
1387
1590
  /**
1388
1591
  * Whether the labels need a marker to shown if the forms fields are required or optional.<br /><br /> By default, it is set to auto, it will display the mark depending on the number of required and optional fields: <br /> - If there are more required, the optional will be marked.<br /> - If there are less required, it will mark the required.<br /><br /> If a form field had "!", the requiredMarked of the field would not change.
1389
1592
  */
1390
1593
  "requiredMarker"?: 'none' | 'required' | 'optional' | 'auto';
1391
1594
  }
1595
+ /**
1596
+ * Icons are used to provide additional meaning or in places where text label
1597
+ * doesn't fit.
1598
+ */
1392
1599
  interface CatIcon {
1393
1600
  /**
1394
1601
  * Adds accessible label for the icon that is only shown for screen readers. The `aria-hidden` attribute will be set if no label is present.
@@ -1407,6 +1614,11 @@ declare namespace LocalJSX {
1407
1614
  */
1408
1615
  "size"?: 'xs' | 's' | 'm' | 'l' | 'xl' | 'inline';
1409
1616
  }
1617
+ /**
1618
+ * Inputs are used to allow users to provide text input when the expected input
1619
+ * is short. As well as plain text, Input supports various types of text,
1620
+ * including passwords and numbers.
1621
+ */
1410
1622
  interface CatInput {
1411
1623
  /**
1412
1624
  * Hint for form autofill feature.
@@ -1432,6 +1644,10 @@ declare namespace LocalJSX {
1432
1644
  * Optional hint text(s) to be displayed with the input.
1433
1645
  */
1434
1646
  "hint"?: string | string[];
1647
+ /**
1648
+ * Whether the label is on top or left.
1649
+ */
1650
+ "horizontal"?: boolean;
1435
1651
  /**
1436
1652
  * The name of an icon to be displayed in the input.
1437
1653
  */
@@ -1525,6 +1741,9 @@ declare namespace LocalJSX {
1525
1741
  */
1526
1742
  "value"?: string | number;
1527
1743
  }
1744
+ /**
1745
+ * Labels are used to provide a short description of an input or form element.
1746
+ */
1528
1747
  interface CatLabel {
1529
1748
  /**
1530
1749
  * The unique identifier for a referenced input.
@@ -1539,6 +1758,13 @@ declare namespace LocalJSX {
1539
1758
  */
1540
1759
  "requiredMarker"?: 'none' | 'required' | 'optional' | 'none!' | 'optional!' | 'required!';
1541
1760
  }
1761
+ /**
1762
+ * A navigation component to switch between different pages of paged chunks of
1763
+ * data such as a table. Pagination is built with list HTML elements and a
1764
+ * wrapping `<nav>` element to identify it as a navigation section to screen
1765
+ * readers and other assistive technologies. Furthermore, the current page is
1766
+ * correctly highlighted using `aria-current`.
1767
+ */
1542
1768
  interface CatPagination {
1543
1769
  /**
1544
1770
  * The number of pages to be shown around the current page.
@@ -1581,6 +1807,10 @@ declare namespace LocalJSX {
1581
1807
  */
1582
1808
  "variant"?: 'filled' | 'outlined' | 'text';
1583
1809
  }
1810
+ /**
1811
+ * Radio Buttons are graphical interface elements that allow user to choose
1812
+ * only one of a predefined set of mutually exclusive options.
1813
+ */
1584
1814
  interface CatRadio {
1585
1815
  /**
1586
1816
  * Whether this radio is checked.
@@ -1639,6 +1869,9 @@ declare namespace LocalJSX {
1639
1869
  */
1640
1870
  "value"?: string;
1641
1871
  }
1872
+ /**
1873
+ * A group of radio buttons.
1874
+ */
1642
1875
  interface CatRadioGroup {
1643
1876
  /**
1644
1877
  * Adds an accessible label for the radio group that it is only shown in assistive technologies, like screen readers.
@@ -1669,6 +1902,9 @@ declare namespace LocalJSX {
1669
1902
  */
1670
1903
  "value"?: string;
1671
1904
  }
1905
+ /**
1906
+ * An element to display scrollable content.
1907
+ */
1672
1908
  interface CatScrollable {
1673
1909
  /**
1674
1910
  * Flags to disable/enable overflowX.
@@ -1715,6 +1951,11 @@ declare namespace LocalJSX {
1715
1951
  */
1716
1952
  "scrolledBuffer"?: number;
1717
1953
  }
1954
+ /**
1955
+ * Select lets user choose one option from an options' menu. Consider using
1956
+ * select when you have 6 or more options. Select component supports any content
1957
+ * type.
1958
+ */
1718
1959
  interface CatSelect {
1719
1960
  /**
1720
1961
  * Whether the select should show a clear button.
@@ -1815,6 +2056,9 @@ declare namespace LocalJSX {
1815
2056
  }
1816
2057
  interface CatSelectDemo {
1817
2058
  }
2059
+ /**
2060
+ * Skeletons are used to show where content will eventually be drawn.
2061
+ */
1818
2062
  interface CatSkeleton {
1819
2063
  /**
1820
2064
  * The animation style of the skeleton.
@@ -1833,6 +2077,9 @@ declare namespace LocalJSX {
1833
2077
  */
1834
2078
  "variant"?: 'rectangle' | 'square' | 'circle' | 'head' | 'body';
1835
2079
  }
2080
+ /**
2081
+ * Spinners are used to indicate users that their action is being processed.
2082
+ */
1836
2083
  interface CatSpinner {
1837
2084
  /**
1838
2085
  * Adds accessible label for the spinner that is only shown for screen readers. The `aria-hidden` attribute will be set if no label is present.
@@ -1843,6 +2090,9 @@ declare namespace LocalJSX {
1843
2090
  */
1844
2091
  "size"?: 'xs' | 's' | 'm' | 'l' | 'xl' | 'inline';
1845
2092
  }
2093
+ /**
2094
+ * A single tab inside a tabs component.
2095
+ */
1846
2096
  interface CatTab {
1847
2097
  /**
1848
2098
  * Specifies that the tab should be deactivated.
@@ -1877,6 +2127,10 @@ declare namespace LocalJSX {
1877
2127
  */
1878
2128
  "urlTarget"?: '_blank' | '_self';
1879
2129
  }
2130
+ /**
2131
+ * Tabs are used to display multiple panels to be contained within a single
2132
+ * window, using tabs as a navigational element.
2133
+ */
1880
2134
  interface CatTabs {
1881
2135
  /**
1882
2136
  * The ID of the active tab.
@@ -1887,6 +2141,11 @@ declare namespace LocalJSX {
1887
2141
  */
1888
2142
  "tabsAlign"?: 'left' | 'center' | 'right' | 'justify';
1889
2143
  }
2144
+ /**
2145
+ * Textarea specifies a control that allows user to write text over multiple
2146
+ * rows. Used when the expected user input is long. For shorter input, use the
2147
+ * input component.
2148
+ */
1890
2149
  interface CatTextarea {
1891
2150
  /**
1892
2151
  * Whether the textarea is disabled.
@@ -1904,6 +2163,10 @@ declare namespace LocalJSX {
1904
2163
  * Optional hint text(s) to be displayed with the textarea.
1905
2164
  */
1906
2165
  "hint"?: string | string[];
2166
+ /**
2167
+ * Whether the label is on top or left.
2168
+ */
2169
+ "horizontal"?: boolean;
1907
2170
  /**
1908
2171
  * A unique identifier for the input.
1909
2172
  */
@@ -1969,6 +2232,10 @@ declare namespace LocalJSX {
1969
2232
  */
1970
2233
  "value"?: string | number;
1971
2234
  }
2235
+ /**
2236
+ * Toggles are graphical interface switches that give user control over a
2237
+ * feature or option that can be turned on or off.
2238
+ */
1972
2239
  interface CatToggle {
1973
2240
  /**
1974
2241
  * Checked state of the toggle.
@@ -2092,28 +2359,107 @@ export { LocalJSX as JSX };
2092
2359
  declare module "@stencil/core" {
2093
2360
  export namespace JSX {
2094
2361
  interface IntrinsicElements {
2362
+ /**
2363
+ * Informs user about important changes or conditions in the interface. Use this
2364
+ * component if you need to capture user’s attention in a prominent way.
2365
+ */
2095
2366
  "cat-alert": LocalJSX.CatAlert & JSXBase.HTMLAttributes<HTMLCatAlertElement>;
2367
+ /**
2368
+ * Avatars are used to represent a person or object.
2369
+ */
2096
2370
  "cat-avatar": LocalJSX.CatAvatar & JSXBase.HTMLAttributes<HTMLCatAvatarElement>;
2371
+ /**
2372
+ * Badges are used to inform users of the status of an object or of an action
2373
+ * that’s been taken.
2374
+ */
2097
2375
  "cat-badge": LocalJSX.CatBadge & JSXBase.HTMLAttributes<HTMLCatBadgeElement>;
2376
+ /**
2377
+ * Buttons are used for interface actions. Primary style should be used only
2378
+ * once per view for main call-to-action.
2379
+ */
2098
2380
  "cat-button": LocalJSX.CatButton & JSXBase.HTMLAttributes<HTMLCatButtonElement>;
2381
+ /**
2382
+ * Cards are surfaces that display content and actions on a single topic. They
2383
+ * should be easy to scan for relevant and actionable information.
2384
+ */
2099
2385
  "cat-card": LocalJSX.CatCard & JSXBase.HTMLAttributes<HTMLCatCardElement>;
2386
+ /**
2387
+ * Checkboxes are used to let a user choose one or more options from a limited
2388
+ * number of options.
2389
+ */
2100
2390
  "cat-checkbox": LocalJSX.CatCheckbox & JSXBase.HTMLAttributes<HTMLCatCheckboxElement>;
2101
2391
  "cat-dropdown": LocalJSX.CatDropdown & JSXBase.HTMLAttributes<HTMLCatDropdownElement>;
2102
2392
  "cat-form-group": LocalJSX.CatFormGroup & JSXBase.HTMLAttributes<HTMLCatFormGroupElement>;
2393
+ /**
2394
+ * Icons are used to provide additional meaning or in places where text label
2395
+ * doesn't fit.
2396
+ */
2103
2397
  "cat-icon": LocalJSX.CatIcon & JSXBase.HTMLAttributes<HTMLCatIconElement>;
2398
+ /**
2399
+ * Inputs are used to allow users to provide text input when the expected input
2400
+ * is short. As well as plain text, Input supports various types of text,
2401
+ * including passwords and numbers.
2402
+ */
2104
2403
  "cat-input": LocalJSX.CatInput & JSXBase.HTMLAttributes<HTMLCatInputElement>;
2404
+ /**
2405
+ * Labels are used to provide a short description of an input or form element.
2406
+ */
2105
2407
  "cat-label": LocalJSX.CatLabel & JSXBase.HTMLAttributes<HTMLCatLabelElement>;
2408
+ /**
2409
+ * A navigation component to switch between different pages of paged chunks of
2410
+ * data such as a table. Pagination is built with list HTML elements and a
2411
+ * wrapping `<nav>` element to identify it as a navigation section to screen
2412
+ * readers and other assistive technologies. Furthermore, the current page is
2413
+ * correctly highlighted using `aria-current`.
2414
+ */
2106
2415
  "cat-pagination": LocalJSX.CatPagination & JSXBase.HTMLAttributes<HTMLCatPaginationElement>;
2416
+ /**
2417
+ * Radio Buttons are graphical interface elements that allow user to choose
2418
+ * only one of a predefined set of mutually exclusive options.
2419
+ */
2107
2420
  "cat-radio": LocalJSX.CatRadio & JSXBase.HTMLAttributes<HTMLCatRadioElement>;
2421
+ /**
2422
+ * A group of radio buttons.
2423
+ */
2108
2424
  "cat-radio-group": LocalJSX.CatRadioGroup & JSXBase.HTMLAttributes<HTMLCatRadioGroupElement>;
2425
+ /**
2426
+ * An element to display scrollable content.
2427
+ */
2109
2428
  "cat-scrollable": LocalJSX.CatScrollable & JSXBase.HTMLAttributes<HTMLCatScrollableElement>;
2429
+ /**
2430
+ * Select lets user choose one option from an options' menu. Consider using
2431
+ * select when you have 6 or more options. Select component supports any content
2432
+ * type.
2433
+ */
2110
2434
  "cat-select": LocalJSX.CatSelect & JSXBase.HTMLAttributes<HTMLCatSelectElement>;
2111
2435
  "cat-select-demo": LocalJSX.CatSelectDemo & JSXBase.HTMLAttributes<HTMLCatSelectDemoElement>;
2436
+ /**
2437
+ * Skeletons are used to show where content will eventually be drawn.
2438
+ */
2112
2439
  "cat-skeleton": LocalJSX.CatSkeleton & JSXBase.HTMLAttributes<HTMLCatSkeletonElement>;
2440
+ /**
2441
+ * Spinners are used to indicate users that their action is being processed.
2442
+ */
2113
2443
  "cat-spinner": LocalJSX.CatSpinner & JSXBase.HTMLAttributes<HTMLCatSpinnerElement>;
2444
+ /**
2445
+ * A single tab inside a tabs component.
2446
+ */
2114
2447
  "cat-tab": LocalJSX.CatTab & JSXBase.HTMLAttributes<HTMLCatTabElement>;
2448
+ /**
2449
+ * Tabs are used to display multiple panels to be contained within a single
2450
+ * window, using tabs as a navigational element.
2451
+ */
2115
2452
  "cat-tabs": LocalJSX.CatTabs & JSXBase.HTMLAttributes<HTMLCatTabsElement>;
2453
+ /**
2454
+ * Textarea specifies a control that allows user to write text over multiple
2455
+ * rows. Used when the expected user input is long. For shorter input, use the
2456
+ * input component.
2457
+ */
2116
2458
  "cat-textarea": LocalJSX.CatTextarea & JSXBase.HTMLAttributes<HTMLCatTextareaElement>;
2459
+ /**
2460
+ * Toggles are graphical interface switches that give user control over a
2461
+ * feature or option that can be turned on or off.
2462
+ */
2117
2463
  "cat-toggle": LocalJSX.CatToggle & JSXBase.HTMLAttributes<HTMLCatToggleElement>;
2118
2464
  "cat-tooltip": LocalJSX.CatTooltip & JSXBase.HTMLAttributes<HTMLCatTooltipElement>;
2119
2465
  }