@ukic/web-components 2.1.0-beta.1 → 2.1.0-beta.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (502) hide show
  1. package/dist/cjs/core.cjs.js +1 -1
  2. package/dist/cjs/ic-alert.cjs.entry.js +2 -0
  3. package/dist/cjs/ic-alert.cjs.entry.js.map +1 -1
  4. package/dist/cjs/ic-back-to-top.cjs.entry.js +18 -8
  5. package/dist/cjs/ic-back-to-top.cjs.entry.js.map +1 -1
  6. package/dist/cjs/ic-breadcrumb-group.cjs.entry.js.map +1 -1
  7. package/dist/cjs/ic-breadcrumb.cjs.entry.js +1 -1
  8. package/dist/cjs/ic-breadcrumb.cjs.entry.js.map +1 -1
  9. package/dist/cjs/ic-button_3.cjs.entry.js +29 -11
  10. package/dist/cjs/ic-button_3.cjs.entry.js.map +1 -1
  11. package/dist/cjs/ic-card.cjs.entry.js.map +1 -1
  12. package/dist/cjs/ic-checkbox-group.cjs.entry.js.map +1 -1
  13. package/dist/cjs/ic-checkbox.cjs.entry.js +2 -0
  14. package/dist/cjs/ic-checkbox.cjs.entry.js.map +1 -1
  15. package/dist/cjs/ic-chip.cjs.entry.js +66 -0
  16. package/dist/cjs/ic-chip.cjs.entry.js.map +1 -0
  17. package/dist/cjs/ic-classification-banner.cjs.entry.js.map +1 -1
  18. package/dist/cjs/ic-data-entity.cjs.entry.js.map +1 -1
  19. package/dist/cjs/ic-data-row.cjs.entry.js +1 -1
  20. package/dist/cjs/ic-data-row.cjs.entry.js.map +1 -1
  21. package/dist/cjs/ic-divider.cjs.entry.js.map +1 -1
  22. package/dist/cjs/ic-footer-link-group.cjs.entry.js.map +1 -1
  23. package/dist/cjs/ic-footer-link.cjs.entry.js +1 -1
  24. package/dist/cjs/ic-footer-link.cjs.entry.js.map +1 -1
  25. package/dist/cjs/ic-footer.cjs.entry.js +2 -2
  26. package/dist/cjs/ic-footer.cjs.entry.js.map +1 -1
  27. package/dist/cjs/ic-hero.cjs.entry.js.map +1 -1
  28. package/dist/cjs/ic-input-component-container_3.cjs.entry.js +19 -18
  29. package/dist/cjs/ic-input-component-container_3.cjs.entry.js.map +1 -1
  30. package/dist/cjs/ic-input-label_2.cjs.entry.js.map +1 -1
  31. package/dist/cjs/ic-link.cjs.entry.js.map +1 -1
  32. package/dist/cjs/ic-navigation-button.cjs.entry.js.map +1 -1
  33. package/dist/cjs/ic-navigation-group.cjs.entry.js.map +1 -1
  34. package/dist/cjs/ic-navigation-item.cjs.entry.js +2 -2
  35. package/dist/cjs/ic-navigation-item.cjs.entry.js.map +1 -1
  36. package/dist/cjs/ic-navigation-menu.cjs.entry.js.map +1 -1
  37. package/dist/cjs/ic-page-header.cjs.entry.js.map +1 -1
  38. package/dist/cjs/ic-radio-group.cjs.entry.js.map +1 -1
  39. package/dist/cjs/ic-radio-option.cjs.entry.js +10 -1
  40. package/dist/cjs/ic-radio-option.cjs.entry.js.map +1 -1
  41. package/dist/cjs/ic-search-bar.cjs.entry.js +16 -2
  42. package/dist/cjs/ic-search-bar.cjs.entry.js.map +1 -1
  43. package/dist/cjs/ic-section-container.cjs.entry.js.map +1 -1
  44. package/dist/cjs/ic-select.cjs.entry.js +2 -7
  45. package/dist/cjs/ic-select.cjs.entry.js.map +1 -1
  46. package/dist/cjs/ic-side-navigation.cjs.entry.js +8 -4
  47. package/dist/cjs/ic-side-navigation.cjs.entry.js.map +1 -1
  48. package/dist/cjs/ic-skeleton.cjs.entry.js +1 -1
  49. package/dist/cjs/ic-skeleton.cjs.entry.js.map +1 -1
  50. package/dist/cjs/ic-status-tag.cjs.entry.js.map +1 -1
  51. package/dist/cjs/ic-step.cjs.entry.js +101 -13
  52. package/dist/cjs/ic-step.cjs.entry.js.map +1 -1
  53. package/dist/cjs/ic-stepper.cjs.entry.js +161 -40
  54. package/dist/cjs/ic-stepper.cjs.entry.js.map +1 -1
  55. package/dist/cjs/ic-switch.cjs.entry.js +1 -1
  56. package/dist/cjs/ic-switch.cjs.entry.js.map +1 -1
  57. package/dist/cjs/ic-tab-context.cjs.entry.js +6 -1
  58. package/dist/cjs/ic-tab-context.cjs.entry.js.map +1 -1
  59. package/dist/cjs/ic-tab-group.cjs.entry.js.map +1 -1
  60. package/dist/cjs/ic-tab-panel.cjs.entry.js.map +1 -1
  61. package/dist/cjs/ic-tab.cjs.entry.js.map +1 -1
  62. package/dist/cjs/ic-text-field.cjs.entry.js.map +1 -1
  63. package/dist/cjs/ic-theme.cjs.entry.js +2 -2
  64. package/dist/cjs/ic-theme.cjs.entry.js.map +1 -1
  65. package/dist/cjs/ic-top-navigation.cjs.entry.js.map +1 -1
  66. package/dist/cjs/ic-typography.cjs.entry.js.map +1 -1
  67. package/dist/cjs/index-3ef30d9d.js +4 -0
  68. package/dist/cjs/loader.cjs.js +1 -1
  69. package/dist/collection/assets/dismiss-icon.svg +3 -0
  70. package/dist/collection/assets/warning-icon-outline.svg +3 -0
  71. package/dist/collection/collection-manifest.json +1 -0
  72. package/dist/collection/components/ic-alert/ic-alert.js +27 -8
  73. package/dist/collection/components/ic-alert/ic-alert.js.map +1 -1
  74. package/dist/collection/components/ic-back-to-top/ic-back-to-top.css +1 -1
  75. package/dist/collection/components/ic-back-to-top/ic-back-to-top.js +17 -7
  76. package/dist/collection/components/ic-back-to-top/ic-back-to-top.js.map +1 -1
  77. package/dist/collection/components/ic-breadcrumb/ic-breadcrumb.css +1 -1
  78. package/dist/collection/components/ic-breadcrumb/ic-breadcrumb.js +4 -4
  79. package/dist/collection/components/ic-breadcrumb/ic-breadcrumb.js.map +1 -1
  80. package/dist/collection/components/ic-breadcrumb-group/ic-breadcrumb-group.js +2 -2
  81. package/dist/collection/components/ic-breadcrumb-group/ic-breadcrumb-group.js.map +1 -1
  82. package/dist/collection/components/ic-button/ic-button.js +13 -13
  83. package/dist/collection/components/ic-button/ic-button.js.map +1 -1
  84. package/dist/collection/components/ic-card/ic-card.js +10 -10
  85. package/dist/collection/components/ic-card/ic-card.js.map +1 -1
  86. package/dist/collection/components/ic-checkbox/ic-checkbox.js +29 -10
  87. package/dist/collection/components/ic-checkbox/ic-checkbox.js.map +1 -1
  88. package/dist/collection/components/ic-checkbox-group/ic-checkbox-group.js +10 -10
  89. package/dist/collection/components/ic-checkbox-group/ic-checkbox-group.js.map +1 -1
  90. package/dist/collection/components/ic-chip/ic-chip.css +595 -0
  91. package/dist/collection/components/ic-chip/ic-chip.js +199 -0
  92. package/dist/collection/components/ic-chip/ic-chip.js.map +1 -0
  93. package/dist/collection/components/ic-chip/ic-chip.test.a11y.js +11 -0
  94. package/dist/collection/components/ic-chip/ic-chip.test.a11y.js.map +1 -0
  95. package/dist/collection/components/ic-chip/ic-chip.types.js +2 -0
  96. package/dist/collection/components/ic-chip/ic-chip.types.js.map +1 -0
  97. package/dist/collection/components/ic-classification-banner/ic-classification-banner.js +5 -5
  98. package/dist/collection/components/ic-classification-banner/ic-classification-banner.js.map +1 -1
  99. package/dist/collection/components/ic-data-entity/ic-data-entity.js +2 -2
  100. package/dist/collection/components/ic-data-entity/ic-data-entity.js.map +1 -1
  101. package/dist/collection/components/ic-data-row/ic-data-row.css +12 -0
  102. package/dist/collection/components/ic-data-row/ic-data-row.js +3 -3
  103. package/dist/collection/components/ic-data-row/ic-data-row.js.map +1 -1
  104. package/dist/collection/components/ic-divider/ic-divider.js +1 -1
  105. package/dist/collection/components/ic-divider/ic-divider.js.map +1 -1
  106. package/dist/collection/components/ic-footer/ic-footer.js +19 -16
  107. package/dist/collection/components/ic-footer/ic-footer.js.map +1 -1
  108. package/dist/collection/components/ic-footer-link/ic-footer-link.css +7 -1
  109. package/dist/collection/components/ic-footer-link/ic-footer-link.js +2 -2
  110. package/dist/collection/components/ic-footer-link/ic-footer-link.js.map +1 -1
  111. package/dist/collection/components/ic-footer-link-group/ic-footer-link-group.js +3 -3
  112. package/dist/collection/components/ic-footer-link-group/ic-footer-link-group.js.map +1 -1
  113. package/dist/collection/components/ic-hero/ic-hero.js +10 -10
  114. package/dist/collection/components/ic-hero/ic-hero.js.map +1 -1
  115. package/dist/collection/components/ic-input-component-container/ic-input-component-container.css +0 -2
  116. package/dist/collection/components/ic-input-component-container/ic-input-component-container.js +8 -8
  117. package/dist/collection/components/ic-input-component-container/ic-input-component-container.js.map +1 -1
  118. package/dist/collection/components/ic-input-container/ic-input-container.js +2 -2
  119. package/dist/collection/components/ic-input-container/ic-input-container.js.map +1 -1
  120. package/dist/collection/components/ic-input-label/ic-input-label.js +8 -8
  121. package/dist/collection/components/ic-input-label/ic-input-label.js.map +1 -1
  122. package/dist/collection/components/ic-input-validation/ic-input-validation.js +5 -5
  123. package/dist/collection/components/ic-input-validation/ic-input-validation.js.map +1 -1
  124. package/dist/collection/components/ic-link/ic-link.js +7 -7
  125. package/dist/collection/components/ic-link/ic-link.js.map +1 -1
  126. package/dist/collection/components/ic-loading-indicator/ic-loading-indicator.css +38 -2
  127. package/dist/collection/components/ic-loading-indicator/ic-loading-indicator.js +45 -9
  128. package/dist/collection/components/ic-loading-indicator/ic-loading-indicator.js.map +1 -1
  129. package/dist/collection/components/ic-menu/ic-menu.css +1 -1
  130. package/dist/collection/components/ic-menu/ic-menu.js +35 -31
  131. package/dist/collection/components/ic-menu/ic-menu.js.map +1 -1
  132. package/dist/collection/components/ic-navigation-button/ic-navigation-button.js +5 -5
  133. package/dist/collection/components/ic-navigation-button/ic-navigation-button.js.map +1 -1
  134. package/dist/collection/components/ic-navigation-group/ic-navigation-group.js +4 -4
  135. package/dist/collection/components/ic-navigation-group/ic-navigation-group.js.map +1 -1
  136. package/dist/collection/components/ic-navigation-item/ic-navigation-item.js +10 -10
  137. package/dist/collection/components/ic-navigation-item/ic-navigation-item.js.map +1 -1
  138. package/dist/collection/components/ic-navigation-menu/ic-navigation-menu.js +3 -3
  139. package/dist/collection/components/ic-navigation-menu/ic-navigation-menu.js.map +1 -1
  140. package/dist/collection/components/ic-page-header/ic-page-header.css +1 -0
  141. package/dist/collection/components/ic-page-header/ic-page-header.js +8 -8
  142. package/dist/collection/components/ic-page-header/ic-page-header.js.map +1 -1
  143. package/dist/collection/components/ic-radio-group/ic-radio-group.js +10 -10
  144. package/dist/collection/components/ic-radio-group/ic-radio-group.js.map +1 -1
  145. package/dist/collection/components/ic-radio-option/ic-radio-option.js +34 -17
  146. package/dist/collection/components/ic-radio-option/ic-radio-option.js.map +1 -1
  147. package/dist/collection/components/ic-search-bar/ic-search-bar.js +51 -30
  148. package/dist/collection/components/ic-search-bar/ic-search-bar.js.map +1 -1
  149. package/dist/collection/components/ic-section-container/ic-section-container.js +2 -2
  150. package/dist/collection/components/ic-section-container/ic-section-container.js.map +1 -1
  151. package/dist/collection/components/ic-select/ic-select.css +1 -1
  152. package/dist/collection/components/ic-select/ic-select.js +19 -24
  153. package/dist/collection/components/ic-select/ic-select.js.map +1 -1
  154. package/dist/collection/components/ic-side-navigation/ic-side-navigation.css +5 -13
  155. package/dist/collection/components/ic-side-navigation/ic-side-navigation.js +24 -17
  156. package/dist/collection/components/ic-side-navigation/ic-side-navigation.js.map +1 -1
  157. package/dist/collection/components/ic-skeleton/ic-skeleton.css +1 -1
  158. package/dist/collection/components/ic-skeleton/ic-skeleton.js +2 -2
  159. package/dist/collection/components/ic-skeleton/ic-skeleton.js.map +1 -1
  160. package/dist/collection/components/ic-status-tag/ic-status-tag.js +1 -1
  161. package/dist/collection/components/ic-status-tag/ic-status-tag.js.map +1 -1
  162. package/dist/collection/components/ic-step/ic-step.css +120 -24
  163. package/dist/collection/components/ic-step/ic-step.js +269 -28
  164. package/dist/collection/components/ic-step/ic-step.js.map +1 -1
  165. package/dist/collection/components/ic-step/ic-step.types.js.map +1 -1
  166. package/dist/collection/components/ic-stepper/ic-stepper-test-examples.js +74 -0
  167. package/dist/collection/components/ic-stepper/ic-stepper-test-examples.js.map +1 -0
  168. package/dist/collection/components/ic-stepper/ic-stepper.css +15 -1
  169. package/dist/collection/components/ic-stepper/ic-stepper.js +206 -39
  170. package/dist/collection/components/ic-stepper/ic-stepper.js.map +1 -1
  171. package/dist/collection/components/ic-stepper/ic-stepper.test.a11y.js +13 -1
  172. package/dist/collection/components/ic-stepper/ic-stepper.test.a11y.js.map +1 -1
  173. package/dist/collection/components/ic-switch/ic-switch.css +1 -1
  174. package/dist/collection/components/ic-switch/ic-switch.js +7 -7
  175. package/dist/collection/components/ic-switch/ic-switch.js.map +1 -1
  176. package/dist/collection/components/ic-tab/ic-tab.js +9 -6
  177. package/dist/collection/components/ic-tab/ic-tab.js.map +1 -1
  178. package/dist/collection/components/ic-tab-context/ic-tab-context.js +31 -4
  179. package/dist/collection/components/ic-tab-context/ic-tab-context.js.map +1 -1
  180. package/dist/collection/components/ic-tab-group/ic-tab-group.js +4 -4
  181. package/dist/collection/components/ic-tab-group/ic-tab-group.js.map +1 -1
  182. package/dist/collection/components/ic-tab-panel/ic-tab-panel.js +2 -2
  183. package/dist/collection/components/ic-tab-panel/ic-tab-panel.js.map +1 -1
  184. package/dist/collection/components/ic-text-field/ic-text-field.js +28 -28
  185. package/dist/collection/components/ic-text-field/ic-text-field.js.map +1 -1
  186. package/dist/collection/components/ic-theme/ic-theme.js +9 -6
  187. package/dist/collection/components/ic-theme/ic-theme.js.map +1 -1
  188. package/dist/collection/components/ic-tooltip/ic-tooltip.css +1 -1
  189. package/dist/collection/components/ic-tooltip/ic-tooltip.js +22 -1
  190. package/dist/collection/components/ic-tooltip/ic-tooltip.js.map +1 -1
  191. package/dist/collection/components/ic-top-navigation/ic-top-navigation.css +1 -1
  192. package/dist/collection/components/ic-top-navigation/ic-top-navigation.js +7 -7
  193. package/dist/collection/components/ic-top-navigation/ic-top-navigation.js.map +1 -1
  194. package/dist/collection/components/ic-typography/ic-typography.js +1 -1
  195. package/dist/collection/components/ic-typography/ic-typography.js.map +1 -1
  196. package/dist/collection/testspec.setup.js +8 -0
  197. package/dist/collection/testspec.setup.js.map +1 -1
  198. package/dist/components/ic-alert.js +3 -1
  199. package/dist/components/ic-alert.js.map +1 -1
  200. package/dist/components/ic-back-to-top.js +18 -8
  201. package/dist/components/ic-back-to-top.js.map +1 -1
  202. package/dist/components/ic-breadcrumb-group.js.map +1 -1
  203. package/dist/components/ic-breadcrumb2.js +1 -1
  204. package/dist/components/ic-breadcrumb2.js.map +1 -1
  205. package/dist/components/ic-button2.js +3 -3
  206. package/dist/components/ic-button2.js.map +1 -1
  207. package/dist/components/ic-card.js +1 -1
  208. package/dist/components/ic-card.js.map +1 -1
  209. package/dist/components/ic-checkbox-group.js +1 -1
  210. package/dist/components/ic-checkbox-group.js.map +1 -1
  211. package/dist/components/ic-checkbox.js +2 -0
  212. package/dist/components/ic-checkbox.js.map +1 -1
  213. package/dist/components/ic-chip.d.ts +11 -0
  214. package/dist/components/ic-chip.js +99 -0
  215. package/dist/components/ic-chip.js.map +1 -0
  216. package/dist/components/ic-classification-banner.js.map +1 -1
  217. package/dist/components/ic-data-entity.js.map +1 -1
  218. package/dist/components/ic-data-row.js +1 -1
  219. package/dist/components/ic-data-row.js.map +1 -1
  220. package/dist/components/ic-divider2.js +1 -1
  221. package/dist/components/ic-divider2.js.map +1 -1
  222. package/dist/components/ic-footer-link-group.js +1 -1
  223. package/dist/components/ic-footer-link-group.js.map +1 -1
  224. package/dist/components/ic-footer-link.js +2 -2
  225. package/dist/components/ic-footer-link.js.map +1 -1
  226. package/dist/components/ic-footer.js +3 -3
  227. package/dist/components/ic-footer.js.map +1 -1
  228. package/dist/components/ic-hero.js +1 -1
  229. package/dist/components/ic-hero.js.map +1 -1
  230. package/dist/components/ic-input-component-container2.js +1 -1
  231. package/dist/components/ic-input-component-container2.js.map +1 -1
  232. package/dist/components/ic-input-container2.js.map +1 -1
  233. package/dist/components/ic-input-label2.js.map +1 -1
  234. package/dist/components/ic-input-validation2.js.map +1 -1
  235. package/dist/components/ic-link2.js +1 -1
  236. package/dist/components/ic-link2.js.map +1 -1
  237. package/dist/components/ic-loading-indicator2.js +24 -7
  238. package/dist/components/ic-loading-indicator2.js.map +1 -1
  239. package/dist/components/ic-menu2.js +18 -17
  240. package/dist/components/ic-menu2.js.map +1 -1
  241. package/dist/components/ic-navigation-button.js +1 -1
  242. package/dist/components/ic-navigation-button.js.map +1 -1
  243. package/dist/components/ic-navigation-group.js +1 -1
  244. package/dist/components/ic-navigation-group.js.map +1 -1
  245. package/dist/components/ic-navigation-item.js +3 -3
  246. package/dist/components/ic-navigation-item.js.map +1 -1
  247. package/dist/components/ic-navigation-menu2.js +1 -1
  248. package/dist/components/ic-navigation-menu2.js.map +1 -1
  249. package/dist/components/ic-page-header.js.map +1 -1
  250. package/dist/components/ic-radio-group.js +1 -1
  251. package/dist/components/ic-radio-group.js.map +1 -1
  252. package/dist/components/ic-radio-option.js +10 -1
  253. package/dist/components/ic-radio-option.js.map +1 -1
  254. package/dist/components/ic-search-bar.js +18 -3
  255. package/dist/components/ic-search-bar.js.map +1 -1
  256. package/dist/components/ic-section-container2.js.map +1 -1
  257. package/dist/components/ic-select.js +2 -7
  258. package/dist/components/ic-select.js.map +1 -1
  259. package/dist/components/ic-side-navigation.js +9 -5
  260. package/dist/components/ic-side-navigation.js.map +1 -1
  261. package/dist/components/ic-skeleton.js +1 -1
  262. package/dist/components/ic-skeleton.js.map +1 -1
  263. package/dist/components/ic-status-tag.js.map +1 -1
  264. package/dist/components/ic-step.js +117 -16
  265. package/dist/components/ic-step.js.map +1 -1
  266. package/dist/components/ic-stepper.js +169 -41
  267. package/dist/components/ic-stepper.js.map +1 -1
  268. package/dist/components/ic-switch.js +1 -1
  269. package/dist/components/ic-switch.js.map +1 -1
  270. package/dist/components/ic-tab-context.js +6 -1
  271. package/dist/components/ic-tab-context.js.map +1 -1
  272. package/dist/components/ic-tab-group.js.map +1 -1
  273. package/dist/components/ic-tab-panel.js.map +1 -1
  274. package/dist/components/ic-tab.js.map +1 -1
  275. package/dist/components/ic-text-field2.js +2 -2
  276. package/dist/components/ic-text-field2.js.map +1 -1
  277. package/dist/components/ic-theme.js +2 -2
  278. package/dist/components/ic-theme.js.map +1 -1
  279. package/dist/components/ic-tooltip2.js +7 -3
  280. package/dist/components/ic-tooltip2.js.map +1 -1
  281. package/dist/components/ic-top-navigation.js +1 -1
  282. package/dist/components/ic-top-navigation.js.map +1 -1
  283. package/dist/components/ic-typography2.js.map +1 -1
  284. package/dist/components/index.d.ts +2 -1
  285. package/dist/components/index.js +1 -0
  286. package/dist/components/index.js.map +1 -1
  287. package/dist/core/core.esm.js +1 -1
  288. package/dist/core/core.esm.js.map +1 -1
  289. package/dist/core/p-0118400b.entry.js.map +1 -1
  290. package/dist/core/p-07cd789d.entry.js.map +1 -1
  291. package/dist/core/p-0b125f26.entry.js.map +1 -1
  292. package/dist/core/p-0d77bd0c.entry.js +2 -0
  293. package/dist/core/p-0d77bd0c.entry.js.map +1 -0
  294. package/dist/core/p-10da19d2.entry.js.map +1 -1
  295. package/dist/core/p-272c7abd.entry.js.map +1 -1
  296. package/dist/core/p-2b5c9143.entry.js +2 -0
  297. package/dist/core/p-2b5c9143.entry.js.map +1 -0
  298. package/dist/core/p-2f114521.entry.js.map +1 -1
  299. package/dist/core/p-31a8595f.entry.js.map +1 -1
  300. package/dist/core/{p-7b39977f.entry.js → p-3a068a45.entry.js} +2 -2
  301. package/dist/core/p-3a068a45.entry.js.map +1 -0
  302. package/dist/core/{p-e590f1d2.entry.js → p-4c72f3a9.entry.js} +2 -2
  303. package/dist/core/{p-e590f1d2.entry.js.map → p-4c72f3a9.entry.js.map} +1 -1
  304. package/dist/core/{p-ae81dffa.entry.js → p-5831bb8e.entry.js} +2 -2
  305. package/dist/core/p-5831bb8e.entry.js.map +1 -0
  306. package/dist/core/p-5d76bbad.entry.js +2 -0
  307. package/dist/core/p-5d76bbad.entry.js.map +1 -0
  308. package/dist/core/p-5e261268.entry.js.map +1 -1
  309. package/dist/core/p-60ffb73e.entry.js.map +1 -1
  310. package/dist/core/p-6308f1f2.entry.js +2 -0
  311. package/dist/core/p-6308f1f2.entry.js.map +1 -0
  312. package/dist/core/{p-c6dd4f47.entry.js → p-66f3f02b.entry.js} +2 -2
  313. package/dist/core/p-66f3f02b.entry.js.map +1 -0
  314. package/dist/core/p-69650186.entry.js.map +1 -1
  315. package/dist/core/p-6b34d98f.entry.js.map +1 -1
  316. package/dist/core/p-6be5e06b.entry.js.map +1 -1
  317. package/dist/core/p-6d0eaaeb.entry.js.map +1 -1
  318. package/dist/core/p-6f6bd657.entry.js.map +1 -1
  319. package/dist/core/{p-1337db5e.entry.js → p-6fba90ee.entry.js} +2 -2
  320. package/dist/core/p-6fba90ee.entry.js.map +1 -0
  321. package/dist/core/{p-558552f8.entry.js → p-7881b94e.entry.js} +2 -2
  322. package/dist/core/p-7881b94e.entry.js.map +1 -0
  323. package/dist/core/{p-8ddeb574.entry.js → p-7f04e382.entry.js} +2 -2
  324. package/dist/core/{p-8ddeb574.entry.js.map → p-7f04e382.entry.js.map} +1 -1
  325. package/dist/core/p-7f632414.entry.js.map +1 -1
  326. package/dist/core/p-80cd0a2d.entry.js +2 -0
  327. package/dist/core/p-80cd0a2d.entry.js.map +1 -0
  328. package/dist/core/{p-df5caf13.entry.js → p-8144e941.entry.js} +2 -2
  329. package/dist/core/p-8144e941.entry.js.map +1 -0
  330. package/dist/core/p-9cd04875.entry.js.map +1 -1
  331. package/dist/core/p-9e684c58.entry.js +2 -0
  332. package/dist/core/p-9e684c58.entry.js.map +1 -0
  333. package/dist/core/{p-02799e26.entry.js → p-a2d3e955.entry.js} +2 -2
  334. package/dist/core/{p-02799e26.entry.js.map → p-a2d3e955.entry.js.map} +1 -1
  335. package/dist/core/{p-1721bcf3.entry.js → p-b24145f7.entry.js} +2 -2
  336. package/dist/core/p-b24145f7.entry.js.map +1 -0
  337. package/dist/core/p-b3dec76d.entry.js.map +1 -1
  338. package/dist/core/{p-347ec49e.entry.js → p-bf89bcd3.entry.js} +2 -2
  339. package/dist/core/p-bf89bcd3.entry.js.map +1 -0
  340. package/dist/core/p-c4d3c18c.entry.js.map +1 -1
  341. package/dist/core/p-c85689e3.entry.js +2 -0
  342. package/dist/core/p-c85689e3.entry.js.map +1 -0
  343. package/dist/core/p-c8ce6147.entry.js +2 -0
  344. package/dist/core/p-c8ce6147.entry.js.map +1 -0
  345. package/dist/core/p-cadb531f.entry.js.map +1 -1
  346. package/dist/core/p-cc83692e.entry.js.map +1 -1
  347. package/dist/core/p-dd3c3e3c.entry.js.map +1 -1
  348. package/dist/core/p-e93e9aa3.entry.js.map +1 -1
  349. package/dist/core/p-ecfb2e6b.entry.js.map +1 -1
  350. package/dist/core/p-fa7bc907.entry.js +2 -0
  351. package/dist/core/p-fa7bc907.entry.js.map +1 -0
  352. package/dist/core/p-fbde8a26.entry.js +2 -0
  353. package/dist/core/p-fbde8a26.entry.js.map +1 -0
  354. package/dist/esm/core.js +1 -1
  355. package/dist/esm/ic-alert.entry.js +2 -0
  356. package/dist/esm/ic-alert.entry.js.map +1 -1
  357. package/dist/esm/ic-back-to-top.entry.js +18 -8
  358. package/dist/esm/ic-back-to-top.entry.js.map +1 -1
  359. package/dist/esm/ic-breadcrumb-group.entry.js.map +1 -1
  360. package/dist/esm/ic-breadcrumb.entry.js +1 -1
  361. package/dist/esm/ic-breadcrumb.entry.js.map +1 -1
  362. package/dist/esm/ic-button_3.entry.js +29 -11
  363. package/dist/esm/ic-button_3.entry.js.map +1 -1
  364. package/dist/esm/ic-card.entry.js.map +1 -1
  365. package/dist/esm/ic-checkbox-group.entry.js.map +1 -1
  366. package/dist/esm/ic-checkbox.entry.js +2 -0
  367. package/dist/esm/ic-checkbox.entry.js.map +1 -1
  368. package/dist/esm/ic-chip.entry.js +62 -0
  369. package/dist/esm/ic-chip.entry.js.map +1 -0
  370. package/dist/esm/ic-classification-banner.entry.js.map +1 -1
  371. package/dist/esm/ic-data-entity.entry.js.map +1 -1
  372. package/dist/esm/ic-data-row.entry.js +1 -1
  373. package/dist/esm/ic-data-row.entry.js.map +1 -1
  374. package/dist/esm/ic-divider.entry.js.map +1 -1
  375. package/dist/esm/ic-footer-link-group.entry.js.map +1 -1
  376. package/dist/esm/ic-footer-link.entry.js +1 -1
  377. package/dist/esm/ic-footer-link.entry.js.map +1 -1
  378. package/dist/esm/ic-footer.entry.js +2 -2
  379. package/dist/esm/ic-footer.entry.js.map +1 -1
  380. package/dist/esm/ic-hero.entry.js.map +1 -1
  381. package/dist/esm/ic-input-component-container_3.entry.js +19 -18
  382. package/dist/esm/ic-input-component-container_3.entry.js.map +1 -1
  383. package/dist/esm/ic-input-label_2.entry.js.map +1 -1
  384. package/dist/esm/ic-link.entry.js.map +1 -1
  385. package/dist/esm/ic-navigation-button.entry.js.map +1 -1
  386. package/dist/esm/ic-navigation-group.entry.js.map +1 -1
  387. package/dist/esm/ic-navigation-item.entry.js +2 -2
  388. package/dist/esm/ic-navigation-item.entry.js.map +1 -1
  389. package/dist/esm/ic-navigation-menu.entry.js.map +1 -1
  390. package/dist/esm/ic-page-header.entry.js.map +1 -1
  391. package/dist/esm/ic-radio-group.entry.js.map +1 -1
  392. package/dist/esm/ic-radio-option.entry.js +10 -1
  393. package/dist/esm/ic-radio-option.entry.js.map +1 -1
  394. package/dist/esm/ic-search-bar.entry.js +16 -2
  395. package/dist/esm/ic-search-bar.entry.js.map +1 -1
  396. package/dist/esm/ic-section-container.entry.js.map +1 -1
  397. package/dist/esm/ic-select.entry.js +2 -7
  398. package/dist/esm/ic-select.entry.js.map +1 -1
  399. package/dist/esm/ic-side-navigation.entry.js +8 -4
  400. package/dist/esm/ic-side-navigation.entry.js.map +1 -1
  401. package/dist/esm/ic-skeleton.entry.js +1 -1
  402. package/dist/esm/ic-skeleton.entry.js.map +1 -1
  403. package/dist/esm/ic-status-tag.entry.js.map +1 -1
  404. package/dist/esm/ic-step.entry.js +101 -13
  405. package/dist/esm/ic-step.entry.js.map +1 -1
  406. package/dist/esm/ic-stepper.entry.js +161 -40
  407. package/dist/esm/ic-stepper.entry.js.map +1 -1
  408. package/dist/esm/ic-switch.entry.js +1 -1
  409. package/dist/esm/ic-switch.entry.js.map +1 -1
  410. package/dist/esm/ic-tab-context.entry.js +6 -1
  411. package/dist/esm/ic-tab-context.entry.js.map +1 -1
  412. package/dist/esm/ic-tab-group.entry.js.map +1 -1
  413. package/dist/esm/ic-tab-panel.entry.js.map +1 -1
  414. package/dist/esm/ic-tab.entry.js.map +1 -1
  415. package/dist/esm/ic-text-field.entry.js.map +1 -1
  416. package/dist/esm/ic-theme.entry.js +2 -2
  417. package/dist/esm/ic-theme.entry.js.map +1 -1
  418. package/dist/esm/ic-top-navigation.entry.js.map +1 -1
  419. package/dist/esm/ic-typography.entry.js.map +1 -1
  420. package/dist/esm/index-1500de1f.js +4 -0
  421. package/dist/esm/loader.js +1 -1
  422. package/dist/types/components/ic-alert/ic-alert.d.ts +12 -8
  423. package/dist/types/components/ic-back-to-top/ic-back-to-top.d.ts +1 -0
  424. package/dist/types/components/ic-breadcrumb/ic-breadcrumb.d.ts +5 -5
  425. package/dist/types/components/ic-breadcrumb-group/ic-breadcrumb-group.d.ts +2 -2
  426. package/dist/types/components/ic-button/ic-button.d.ts +10 -10
  427. package/dist/types/components/ic-card/ic-card.d.ts +8 -8
  428. package/dist/types/components/ic-checkbox/ic-checkbox.d.ts +14 -10
  429. package/dist/types/components/ic-checkbox-group/ic-checkbox-group.d.ts +9 -9
  430. package/dist/types/components/ic-chip/ic-chip.d.ts +40 -0
  431. package/dist/types/components/ic-chip/ic-chip.test.a11y.d.ts +1 -0
  432. package/dist/types/components/ic-chip/ic-chip.types.d.ts +2 -0
  433. package/dist/types/components/ic-classification-banner/ic-classification-banner.d.ts +5 -5
  434. package/dist/types/components/ic-data-entity/ic-data-entity.d.ts +2 -2
  435. package/dist/types/components/ic-data-row/ic-data-row.d.ts +3 -3
  436. package/dist/types/components/ic-footer/ic-footer.d.ts +12 -12
  437. package/dist/types/components/ic-footer-link-group/ic-footer-link-group.d.ts +1 -1
  438. package/dist/types/components/ic-hero/ic-hero.d.ts +9 -9
  439. package/dist/types/components/ic-input-component-container/ic-input-component-container.d.ts +8 -8
  440. package/dist/types/components/ic-input-container/ic-input-container.d.ts +2 -2
  441. package/dist/types/components/ic-input-label/ic-input-label.d.ts +8 -8
  442. package/dist/types/components/ic-input-validation/ic-input-validation.d.ts +5 -5
  443. package/dist/types/components/ic-link/ic-link.d.ts +6 -6
  444. package/dist/types/components/ic-loading-indicator/ic-loading-indicator.d.ts +8 -3
  445. package/dist/types/components/ic-menu/ic-menu.d.ts +14 -14
  446. package/dist/types/components/ic-navigation-button/ic-navigation-button.d.ts +5 -5
  447. package/dist/types/components/ic-navigation-group/ic-navigation-group.d.ts +2 -2
  448. package/dist/types/components/ic-navigation-item/ic-navigation-item.d.ts +7 -7
  449. package/dist/types/components/ic-navigation-menu/ic-navigation-menu.d.ts +2 -2
  450. package/dist/types/components/ic-page-header/ic-page-header.d.ts +10 -8
  451. package/dist/types/components/ic-radio-group/ic-radio-group.d.ts +10 -10
  452. package/dist/types/components/ic-radio-option/ic-radio-option.d.ts +13 -11
  453. package/dist/types/components/ic-search-bar/ic-search-bar.d.ts +28 -25
  454. package/dist/types/components/ic-section-container/ic-section-container.d.ts +2 -2
  455. package/dist/types/components/ic-select/ic-select.d.ts +18 -18
  456. package/dist/types/components/ic-side-navigation/ic-side-navigation.d.ts +12 -12
  457. package/dist/types/components/ic-skeleton/ic-skeleton.d.ts +2 -2
  458. package/dist/types/components/ic-status-tag/ic-status-tag.d.ts +1 -1
  459. package/dist/types/components/ic-step/ic-step.d.ts +37 -8
  460. package/dist/types/components/ic-step/ic-step.types.d.ts +2 -0
  461. package/dist/types/components/ic-stepper/ic-stepper-test-examples.d.ts +4 -0
  462. package/dist/types/components/ic-stepper/ic-stepper.d.ts +23 -6
  463. package/dist/types/components/ic-switch/ic-switch.d.ts +7 -7
  464. package/dist/types/components/ic-tab/ic-tab.d.ts +5 -5
  465. package/dist/types/components/ic-tab-context/ic-tab-context.d.ts +8 -4
  466. package/dist/types/components/ic-tab-group/ic-tab-group.d.ts +4 -4
  467. package/dist/types/components/ic-tab-panel/ic-tab-panel.d.ts +2 -2
  468. package/dist/types/components/ic-text-field/ic-text-field.d.ts +30 -30
  469. package/dist/types/components/ic-theme/ic-theme.d.ts +3 -3
  470. package/dist/types/components/ic-tooltip/ic-tooltip.d.ts +4 -0
  471. package/dist/types/components/ic-top-navigation/ic-top-navigation.d.ts +6 -6
  472. package/dist/types/components/ic-typography/ic-typography.d.ts +1 -1
  473. package/dist/types/components.d.ts +625 -535
  474. package/dist/types/testspec.setup.d.ts +1 -0
  475. package/hydrate/index.js +574 -212
  476. package/package.json +3 -3
  477. package/dist/core/p-1337db5e.entry.js.map +0 -1
  478. package/dist/core/p-1721bcf3.entry.js.map +0 -1
  479. package/dist/core/p-33a45ace.entry.js +0 -2
  480. package/dist/core/p-33a45ace.entry.js.map +0 -1
  481. package/dist/core/p-347ec49e.entry.js.map +0 -1
  482. package/dist/core/p-39ae284e.entry.js +0 -2
  483. package/dist/core/p-39ae284e.entry.js.map +0 -1
  484. package/dist/core/p-558552f8.entry.js.map +0 -1
  485. package/dist/core/p-7093d214.entry.js +0 -2
  486. package/dist/core/p-7093d214.entry.js.map +0 -1
  487. package/dist/core/p-7577c6a3.entry.js +0 -2
  488. package/dist/core/p-7577c6a3.entry.js.map +0 -1
  489. package/dist/core/p-7b11e1dc.entry.js +0 -2
  490. package/dist/core/p-7b11e1dc.entry.js.map +0 -1
  491. package/dist/core/p-7b39977f.entry.js.map +0 -1
  492. package/dist/core/p-898607d0.entry.js +0 -2
  493. package/dist/core/p-898607d0.entry.js.map +0 -1
  494. package/dist/core/p-ac43322e.entry.js +0 -2
  495. package/dist/core/p-ac43322e.entry.js.map +0 -1
  496. package/dist/core/p-ae81dffa.entry.js.map +0 -1
  497. package/dist/core/p-b5a988c0.entry.js +0 -2
  498. package/dist/core/p-b5a988c0.entry.js.map +0 -1
  499. package/dist/core/p-c6dd4f47.entry.js.map +0 -1
  500. package/dist/core/p-df5caf13.entry.js.map +0 -1
  501. package/dist/core/p-e106305b.entry.js +0 -2
  502. package/dist/core/p-e106305b.entry.js.map +0 -1
@@ -9,6 +9,7 @@ import { IcAlertVariants } from "./components/ic-alert/ic-alert.types";
9
9
  import { IcButtonSizes, IcButtonTooltipPlacement, IcButtonTypes, IcButtonVariants } from "./components/ic-button/ic-button.types";
10
10
  import { IcActivationTypes, IcAdditionalFieldTypes, IcAlignment, IcAutocompleteTypes, IcAutocorrectStates, IcInformationStatusOrEmpty, IcMenuOption, IcSearchMatchPositions, IcTheme, IcThemeForeground, IcThemeForegroundNoDefault, IcTypographyVariants } from "./utils/types";
11
11
  import { IcChangeEventDetail } from "./components/ic-checkbox-group/ic-checkbox-group.types";
12
+ import { IcChipAppearance, IcChipSizes } from "./components/ic-chip/ic-chip.types";
12
13
  import { IcProtectiveMarkings } from "./components/ic-classification-banner/ic-classification-banner.types";
13
14
  import { IcFooterBreakpoints } from "./components/ic-footer/ic-footer.types";
14
15
  import { IcHeroContentAlignments } from "./components/ic-hero/ic-hero.types";
@@ -19,7 +20,7 @@ import { IcAutocompleteTypes as IcAutocompleteTypes1, IcAutocorrectStates as IcA
19
20
  import { IcSearchBarBlurEventDetail } from "./components/ic-search-bar/ic-search-bar.types";
20
21
  import { IcSkeletonVariants } from "./components/ic-skeleton/ic-skeleton.types";
21
22
  import { IcStatusTagAppearance, IcStatusTagStatuses } from "./components/ic-status-tag/ic-status-tag.types";
22
- import { IcStepTypes } from "./components/ic-step/ic-step.types";
23
+ import { IcStepStatuses, IcStepTypes, IcStepVariants } from "./components/ic-step/ic-step.types";
23
24
  import { IcStepperAlignment } from "./components/ic-stepper/ic-stepper.types";
24
25
  import { IcSwitchChangeEventDetail } from "./components/ic-switch/ic-switch.types";
25
26
  import { IcTabClickEventDetail, IcTabSelectEventDetail } from "./components/ic-tab/ic-tab.types";
@@ -28,27 +29,27 @@ import { IcTooltipPlacements } from "./components/ic-tooltip/ic-tooltip.types";
28
29
  export namespace Components {
29
30
  interface IcAlert {
30
31
  /**
31
- * Set whether the alert has the 'alert' aria role and will be announced to screen readers
32
+ * If `true`, the alert will have the 'alert' ARIA role and will be announced to screen readers.
32
33
  */
33
34
  "announced"?: boolean;
34
35
  /**
35
- * Set whether the alert has a close icon at the end to dismiss it
36
+ * If `true`, the alert will have a close icon at the end to dismiss it.
36
37
  */
37
38
  "dismissible"?: boolean;
38
39
  /**
39
- * Optional title to display at the start of the alert
40
+ * The optional title to display at the start of the alert.
40
41
  */
41
42
  "heading"?: string;
42
43
  /**
43
- * Main body message of the alert
44
+ * The main body message of the alert.
44
45
  */
45
46
  "message"?: string;
46
47
  /**
47
- * Set whether the title and message appear inline or above and below
48
+ * If `true`, the title and message will appear inline instead of above and below.
48
49
  */
49
50
  "titleAbove"?: boolean;
50
51
  /**
51
- * Set which variant of the alert will be rendered
52
+ * The variant of the alert which will be rendered.
52
53
  */
53
54
  "variant"?: IcAlertVariants;
54
55
  }
@@ -60,48 +61,48 @@ export namespace Components {
60
61
  }
61
62
  interface IcBreadcrumb {
62
63
  /**
63
- * If true, aria-current will be set on the breadcrumb
64
+ * If `true`, aria-current will be set on the breadcrumb.
64
65
  */
65
66
  "current"?: boolean;
66
67
  /**
67
- * Set breadcrumb location
68
+ * The URL that the breadcrumb link points to.
68
69
  */
69
70
  "href"?: string;
70
71
  /**
71
- * Set breadcrumb title
72
+ * The title of the breadcrumb.
72
73
  */
73
74
  "pageTitle": string;
74
75
  "showBackIcon": boolean;
75
76
  }
76
77
  interface IcBreadcrumbGroup {
77
78
  /**
78
- * If true, display the parent page and back icon as breadcrumb
79
+ * If `true`, display only a single breadcrumb for the parent page with a back icon.
79
80
  */
80
81
  "backBreadcrumbOnly": boolean;
81
82
  /**
82
- * If true, all breadcrumbs between the first and last breadcrumb will be collapsed
83
+ * If `true`, all breadcrumbs between the first and last breadcrumb will be collapsed.
83
84
  */
84
85
  "collapsed": boolean;
85
86
  }
86
87
  interface IcButton {
87
88
  /**
88
- * Determines the whether the appearance of the button is dark, light, or the default.
89
+ * The appearance of the button, e.g. dark, light, or the default.
89
90
  */
90
91
  "appearance"?: IcThemeForeground;
91
92
  /**
92
- * Disable ic-tooltip which is shown for icon variant. Title or aria-label must be set if this prop is not applied.
93
+ * If `true`, the ic-tooltip which is shown for icon variant will be disabled. Title or aria-label must be set if this prop is not applied.
93
94
  */
94
95
  "disableTooltip"?: boolean;
95
96
  /**
96
- * Determines whether the button should be in disabled state.
97
+ * If `true`, the button will be in disabled state.
97
98
  */
98
99
  "disabled"?: boolean;
99
100
  /**
100
- * Prompts the user to save the linked URL instead of navigating to it.
101
+ * If `true`, the user can save the linked URL instead of navigating to it.
101
102
  */
102
103
  "download"?: string | boolean;
103
104
  /**
104
- * Fill the width of the container if true.
105
+ * If `true`, the button will fill the width of the container.
105
106
  */
106
107
  "fullWidth"?: boolean;
107
108
  /**
@@ -109,11 +110,11 @@ export namespace Components {
109
110
  */
110
111
  "href"?: string;
111
112
  /**
112
- * Hints at the human language of the linked URL.
113
+ * The human language of the linked URL.
113
114
  */
114
115
  "hreflang"?: string;
115
116
  /**
116
- * Determines whether the button should be in loading state.
117
+ * If `true`, the button will be in loading state.
117
118
  */
118
119
  "loading"?: boolean;
119
120
  /**
@@ -133,7 +134,7 @@ export namespace Components {
133
134
  */
134
135
  "size"?: IcButtonSizes;
135
136
  /**
136
- * Where to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
137
+ * The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
137
138
  */
138
139
  "target"?: string;
139
140
  /**
@@ -146,37 +147,37 @@ export namespace Components {
146
147
  "type"?: IcButtonTypes;
147
148
  "updateAriaLabel": (newValue: string) => Promise<void>;
148
149
  /**
149
- * The button variant to be displayed.
150
+ * The variant of the button to be displayed.
150
151
  */
151
152
  "variant"?: IcButtonVariants;
152
153
  }
153
154
  interface IcCard {
154
155
  /**
155
- * Set the variant to static or clickable
156
+ * If `true`, the card will be a clickable variant, instead of static.
156
157
  */
157
158
  "clickable"?: boolean;
158
159
  /**
159
- * Whether the card is disabled if it is clickable
160
+ * If `true`, the card will be disabled if it is clickable.
160
161
  */
161
162
  "disabled"?: boolean;
162
163
  /**
163
- * If true then fill width of container
164
+ * If `true`, the card will fill the width of the container.
164
165
  */
165
166
  "fullWidth": boolean;
166
167
  /**
167
- * Title for the card
168
+ * The title for the card.
168
169
  */
169
170
  "heading": string;
170
171
  /**
171
- * URL for clickable cards
172
+ * The URL that the clickable card link points to.
172
173
  */
173
174
  "href"?: string | undefined;
174
175
  /**
175
- * Human readable explanation of the URL
176
+ * The human language of the linked URL.
176
177
  */
177
178
  "hreflang"?: string;
178
179
  /**
179
- * Main body message of the card
180
+ * The main body message of the card.
180
181
  */
181
182
  "message"?: string;
182
183
  /**
@@ -188,129 +189,151 @@ export namespace Components {
188
189
  */
189
190
  "rel"?: string;
190
191
  /**
191
- * Where to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
192
+ * The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
192
193
  */
193
194
  "target"?: string;
194
195
  }
195
196
  interface IcCheckbox {
196
197
  /**
197
- * Set which style of additionalField will be displayed if used
198
+ * The style of additionalField that will be displayed if used.
198
199
  */
199
200
  "additionalFieldDisplay": IcAdditionalFieldTypes;
200
201
  /**
201
- * Set the checkbox to the checked state
202
+ * If `true`, the checkbox will be set to the checked state.
202
203
  */
203
204
  "checked"?: boolean;
204
205
  /**
205
- * Set the checkbox to the disabled state
206
+ * If `true`, the checkbox will be set to the disabled state.
206
207
  */
207
208
  "disabled"?: boolean;
208
209
  /**
209
- * Provide a text prop for the dynamic text
210
+ * The text to be displayed when dynamic.
210
211
  */
211
212
  "dynamicText": string;
212
213
  /**
213
- * Provide a group label for the input
214
+ * The group label for the checkbox.
214
215
  */
215
216
  "groupLabel": string;
216
217
  /**
217
- * Display the indeterminate state when checked
218
+ * If `true`, the indeterminate state will be displayed when checked.
218
219
  */
219
220
  "indeterminate": boolean;
220
221
  /**
221
- * Provide a label for the input
222
+ * The label for the checkbox.
222
223
  */
223
224
  "label": string;
224
225
  /**
225
- * Provide a name for the input. If not set when used in a checkbox group, the name will be based on the group name.
226
+ * The name for the checkbox. If not set when used in a checkbox group, the name will be based on the group name.
226
227
  */
227
228
  "name": string;
228
229
  /**
229
- * Provide a value for the input
230
+ * The value for the checkbox.
230
231
  */
231
232
  "value": string;
232
233
  }
233
234
  interface IcCheckboxGroup {
234
235
  /**
235
- * Specify whether the input is disabled.
236
+ * If `true`, the checkbox group will be set to the disabled state.
236
237
  */
237
238
  "disabled": boolean;
238
239
  /**
239
- * Provide helper text to display additional field guidance.
240
+ * The helper text that will be displayed for additional field guidance.
240
241
  */
241
242
  "helperText": string;
242
243
  /**
243
- * Hides the label and applies the required label value as an aria-label.
244
+ * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
244
245
  */
245
246
  "hideLabel": boolean;
246
247
  /**
247
- * Provide a label for the input.
248
+ * The label for the checkbox group to be displayed.
248
249
  */
249
250
  "label": string;
250
251
  /**
251
- * Provide a name for the input.
252
+ * The name for the checkbox group to differentiate from other groups.
252
253
  */
253
254
  "name": string;
254
255
  /**
255
- * Specify if the input requires a value.
256
+ * If `true`, the checkbox group will require a value.
256
257
  */
257
258
  "required": boolean;
258
259
  /**
259
- * Specify whether small styling to be applied to element.
260
+ * If `true`, the small styling will be applied to the checkbox group.
260
261
  */
261
262
  "small": boolean;
262
263
  /**
263
- * Provide validation status - 'error'
264
+ * The validation status - e.g. 'error' | 'warning' | 'success'.
264
265
  */
265
266
  "validationStatus": IcInformationStatusOrEmpty;
266
267
  /**
267
- * Provide validation text - 'error'
268
+ * The validation text - e.g. 'error' | 'warning' | 'success'.
268
269
  */
269
270
  "validationText": string;
270
271
  }
272
+ interface IcChip {
273
+ /**
274
+ * The emphasis of the chip.
275
+ */
276
+ "appearance"?: IcChipAppearance;
277
+ /**
278
+ * If `true`, the chip will appear disabled.
279
+ */
280
+ "disabled"?: boolean;
281
+ /**
282
+ * If `true`, the chip will have a close button at the end to dismiss it.
283
+ */
284
+ "dismissible"?: boolean;
285
+ /**
286
+ * The text rendered within the chip.
287
+ */
288
+ "label": string;
289
+ /**
290
+ * The size of the chip.
291
+ */
292
+ "size"?: IcChipSizes;
293
+ }
271
294
  interface IcClassificationBanner {
272
295
  /**
273
- * Additional information to display after the classification
296
+ * The additional information that will be displayed after the classification.
274
297
  */
275
298
  "additionalSelectors"?: string;
276
299
  /**
277
- * The classification level to be displayed also determines the banner and text colour
300
+ * The classification level to be displayed - also determines the banner and text colour.
278
301
  */
279
302
  "classification"?: IcProtectiveMarkings;
280
303
  /**
281
- * Optional text displayed before classification to specify relevant country/countries
304
+ * The optional text that will be displayed before classification to specify relevant country/countries.
282
305
  */
283
306
  "country"?: string;
284
307
  /**
285
- * Determines whether the banner appears inline with the page or sticks to the bottom of the page
308
+ * If `true`, the banner will appear inline with the page, instead of sticking to the bottom of the page.
286
309
  */
287
310
  "inline"?: boolean;
288
311
  /**
289
- * Optionally display "Up to" before classification and country if set
312
+ * If `true`, "Up to" will be displayed before the classification and country.
290
313
  */
291
314
  "upTo"?: boolean;
292
315
  }
293
316
  interface IcDataEntity {
294
317
  /**
295
- * Title for the data entity
318
+ * The title for the data entity.
296
319
  */
297
320
  "heading": string;
298
321
  /**
299
- * Set the data heading and all child data rows to small styling
322
+ * If `true`, the small styling will be applied to the data heading and all child data rows.
300
323
  */
301
324
  "small": boolean;
302
325
  }
303
326
  interface IcDataRow {
304
327
  /**
305
- * Set the label in the leftmost cell of the row
328
+ * The label in the leftmost cell of the row.
306
329
  */
307
330
  "label": string;
308
331
  /**
309
- * Set the row to small styling, this is automatically applied if small is set on the parent data heading
332
+ * If `true`, the small styling will be applied to the row. This is automatically applied if small is set on the parent data heading.
310
333
  */
311
334
  "small": boolean;
312
335
  /**
313
- * Set the value of the middle (right if no addition supplied) cell of the row
336
+ * The value of the middle (right if no end-component supplied) cell of the row.
314
337
  */
315
338
  "value": string;
316
339
  }
@@ -318,27 +341,27 @@ export namespace Components {
318
341
  }
319
342
  interface IcFooter {
320
343
  /**
321
- * Sets the aligned parameter for the section containers used within the footer
344
+ * The alignment of the section containers used within the footer.
322
345
  */
323
346
  "aligned"?: IcAlignment;
324
347
  /**
325
- * Sets the screen size breakpoint at which to switch to the small layout
348
+ * The screen size breakpoint at which to switch to the small layout.
326
349
  */
327
350
  "breakpoint"?: IcFooterBreakpoints;
328
351
  /**
329
- * The caption displayed at the bottom of the footer
352
+ * The caption displayed at the bottom of the footer.
330
353
  */
331
354
  "caption": string;
332
355
  /**
333
- * Whether the footer displays the crown copyright at the bottom
356
+ * If `true`, the footer will display the crown copyright at the bottom.
334
357
  */
335
358
  "copyright": boolean;
336
359
  /**
337
- * The description displayed at the top of the footer
360
+ * The description displayed at the top of the footer.
338
361
  */
339
362
  "description": string;
340
363
  /**
341
- * Sets the footer up to handle link groups instead of standalone links
364
+ * If `true`, the footer will be set up to handle link groups instead of standalone links.
342
365
  */
343
366
  "groupLinks"?: boolean;
344
367
  }
@@ -350,155 +373,155 @@ export namespace Components {
350
373
  }
351
374
  interface IcFooterLinkGroup {
352
375
  /**
353
- * Sets the title of the link group for display
376
+ * The title of the link group to be displayed.
354
377
  */
355
378
  "groupTitle": string;
356
379
  }
357
380
  interface IcHero {
358
381
  /**
359
- * The alignment of the hero content
382
+ * The alignment of the hero.
360
383
  */
361
384
  "aligned": IcAlignment;
362
385
  /**
363
- * Optional background image
386
+ * The optional background image.
364
387
  */
365
388
  "backgroundImage"?: string;
366
389
  /**
367
- * The alignment of the hero content
390
+ * The alignment of the hero content.
368
391
  */
369
392
  "contentAligned": IcHeroContentAlignments;
370
393
  /**
371
- * Whether the background image (if set) scrolls using a parallax effect.
394
+ * If `true`, the background image (if set) will not scroll using a parallax effect.
372
395
  */
373
396
  "disableBackgroundParallax"?: boolean;
374
397
  /**
375
- * The heading of the hero
398
+ * The heading of the hero.
376
399
  */
377
400
  "heading": string;
378
401
  /**
379
- * Optional secondary heading, replaced by slotted right content
402
+ * The optional secondary heading, replaced by slotted right content.
380
403
  */
381
404
  "secondaryHeading"?: string;
382
405
  /**
383
- * Optional secondary subheading, replaced by slotted right content
406
+ * The optional secondary subheading, replaced by slotted right content.
384
407
  */
385
408
  "secondarySubheading"?: string;
386
409
  /**
387
- * Alter styling for use with small content/pages
410
+ * If `true`, the small styling will be applied to the hero.
388
411
  */
389
412
  "small": boolean;
390
413
  /**
391
- * Description for the hero
414
+ * The description for the hero.
392
415
  */
393
416
  "subheading"?: string;
394
417
  }
395
418
  interface IcInputComponentContainer {
396
419
  /**
397
- * Determines whether the dark variant of the input-component-container focus indicator should be displayed.
420
+ * If `true`, the dark variant of the input component container will be displayed.
398
421
  */
399
422
  "dark"?: boolean;
400
423
  /**
401
- * disabled
424
+ * If `true`, the disabled state will be set.
402
425
  */
403
426
  "disabled": boolean;
404
427
  /**
405
- * If true then fill width of container
428
+ * If `true`, the input component container will fill the width of the container it is in.
406
429
  */
407
430
  "fullWidth": boolean;
408
431
  /**
409
- * multiLine
432
+ * If `true`, the input component container will allow for multiple lines.
410
433
  */
411
434
  "multiLine": boolean;
412
435
  /**
413
- * readonly
436
+ * If `true`, the readonly state will be set.
414
437
  */
415
438
  "readonly": boolean;
416
439
  /**
417
- * small
440
+ * If `true`, the small styling will be applied to the input component container.
418
441
  */
419
442
  "small": boolean;
420
443
  /**
421
- * validationInline
444
+ * If `true`, the validation will display inline.
422
445
  */
423
446
  "validationInline": boolean;
424
447
  /**
425
- * validationStatus
448
+ * The validation status of the input component container - e.g. 'error' | 'warning' | 'success'.
426
449
  */
427
450
  "validationStatus": IcInformationStatusOrEmpty;
428
451
  }
429
452
  interface IcInputContainer {
430
453
  /**
431
- * disabled
454
+ * If `true`, the disabled state will be set.
432
455
  */
433
456
  "disabled"?: boolean;
434
457
  /**
435
- * readonly
458
+ * If `true`, the readonly state will be set.
436
459
  */
437
460
  "readonly"?: boolean;
438
461
  }
439
462
  interface IcInputLabel {
440
463
  /**
441
- * dark
464
+ * If `true`, the dark variant of the input label will be displayed.
442
465
  */
443
466
  "dark"?: boolean;
444
467
  /**
445
- * disabled
468
+ * If `true`, the disabled state will be set.
446
469
  */
447
470
  "disabled": boolean;
448
471
  /**
449
- * error
472
+ * If `true`, the input label will display with error styling.
450
473
  */
451
474
  "error"?: boolean;
452
475
  /**
453
- * for
476
+ * The ID of the form element the label is bound to.
454
477
  */
455
478
  "for": string;
456
479
  /**
457
- * helperText
480
+ * The helper text that will be displayed.
458
481
  */
459
482
  "helperText": string;
460
483
  /**
461
- * label
484
+ * The text content of the label.
462
485
  */
463
486
  "label": string;
464
487
  /**
465
- * readonly
488
+ * If `true`, the readonly state will be set.
466
489
  */
467
490
  "readonly": boolean;
468
491
  /**
469
- * required
492
+ * If `true`, the input label will require a value.
470
493
  */
471
494
  "required": boolean;
472
495
  }
473
496
  interface IcInputValidation {
474
497
  /**
475
- * aria live mode to apply to message
498
+ * The ARIA live mode to apply to the message.
476
499
  */
477
500
  "ariaLiveMode": IcAriaLiveModeVariants;
478
501
  /**
479
- * The id of the input field the message relates to
502
+ * The ID of the form element the validation is bound to.
480
503
  */
481
504
  "for": string;
482
505
  /**
483
- * If true then fill width of container
506
+ * If `true`, the input validation will fill the width of the container.
484
507
  */
485
508
  "fullWidth": boolean;
486
509
  /**
487
- * The validation message to display
510
+ * The validation message to display.
488
511
  */
489
512
  "message": string;
490
513
  /**
491
- * The status
514
+ * The status of the validation - e.g. 'error' | 'warning' | 'success'.
492
515
  */
493
516
  "status": IcInformationStatusOrEmpty;
494
517
  }
495
518
  interface IcLink {
496
519
  /**
497
- * Determines the whether the appearance is dark, light, or the default.
520
+ * The appearance of the link, e.g. dark, light, or default.
498
521
  */
499
522
  "appearance"?: IcThemeForeground;
500
523
  /**
501
- * Prompts the user to save the linked URL instead of navigating to it.
524
+ * If `true`, the user can save the linked URL instead of navigating to it.
502
525
  */
503
526
  "download"?: string | boolean;
504
527
  /**
@@ -506,7 +529,7 @@ export namespace Components {
506
529
  */
507
530
  "href"?: string;
508
531
  /**
509
- * Hints at the human language of the linked URL.
532
+ * The human language of the linked URL.
510
533
  */
511
534
  "hreflang"?: string;
512
535
  /**
@@ -518,27 +541,28 @@ export namespace Components {
518
541
  */
519
542
  "rel"?: string;
520
543
  /**
521
- * Determines whether the 'open in new tab/window' icon is to be displayed.
544
+ * If `true`, the 'open in new tab/window' icon will be displayed.
522
545
  */
523
546
  "showIcon"?: boolean;
524
547
  /**
525
- * Where to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
548
+ * The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
526
549
  */
527
550
  "target"?: string;
528
551
  }
529
552
  interface IcLoadingIndicator {
530
553
  /**
531
- * Determines whether the dark or light loading indicator should be displayed.
554
+ * The appearance of the loading indicator, e.g. dark or light.
532
555
  */
533
556
  "appearance"?: IcThemeForegroundNoDefault;
534
557
  /**
535
- * Provide a description to be set as the aria-label of the loading indicator when not using a visible label.
558
+ * The description that will be set as the aria-label of the loading indicator when not using a visible label.
536
559
  */
537
560
  "description"?: string;
538
561
  /**
539
- * When linear, determines whether the full-width version (i.e. without a border radius) should be displayed.
562
+ * If `true`, when linear, the full-width variant (i.e. without a border radius) will be displayed.
540
563
  */
541
564
  "fullWidth"?: boolean;
565
+ "innerLabel"?: number;
542
566
  /**
543
567
  * The label to be displayed beneath the loading indicator. Display a changing label by separating multiple messages with forward slashes.
544
568
  */
@@ -574,16 +598,16 @@ export namespace Components {
574
598
  */
575
599
  "activationType"?: IcActivationTypes;
576
600
  /**
577
- * Reference to an anchor element the menu will position itself from when rendered.
601
+ * The reference to an anchor element the menu will position itself from when rendered.
578
602
  */
579
603
  "anchorEl": HTMLElement;
580
604
  "autoFocusOnSelected": boolean;
581
605
  /**
582
- * If true then fill width of container
606
+ * If `true`, the menu will fill the width of the container.
583
607
  */
584
608
  "fullWidth": boolean;
585
609
  /**
586
- * If menu is opened with the mouse, emit menuChange custom event.
610
+ * If menu is opened with the mouse, emit icMenuStateChange custom event.
587
611
  */
588
612
  "handleClickOpen": () => Promise<void>;
589
613
  /**
@@ -593,28 +617,28 @@ export namespace Components {
593
617
  "handleKeyboardOpen": (event: KeyboardEvent) => Promise<void>;
594
618
  "handleSetFirstOption": () => Promise<void>;
595
619
  /**
596
- * Reference to the input element.
620
+ * The reference to the input element.
597
621
  */
598
622
  "inputEl": HTMLElement;
599
623
  /**
600
- * Label for the input element.
624
+ * The label for the input element.
601
625
  */
602
626
  "inputLabel": string;
603
627
  /**
604
- * Id of the menu.
628
+ * The ID of the menu.
605
629
  */
606
630
  "menuId": string;
607
631
  /**
608
- * Specify whether the menu is open.
632
+ * If `true`, the menu will be displayed open.
609
633
  */
610
634
  "open": boolean;
611
635
  /**
612
- * Provide the possible selection options.
636
+ * The possible menu selection options.
613
637
  */
614
638
  "options": IcMenuOption[];
615
639
  "parentEl"?: HTMLElement;
616
640
  /**
617
- * Specify whether small styling is to be applied to the element.
641
+ * If `true`, the small styling will be applied to the menu.
618
642
  */
619
643
  "small"?: boolean;
620
644
  /**
@@ -624,7 +648,7 @@ export namespace Components {
624
648
  }
625
649
  interface IcNavigationButton {
626
650
  /**
627
- * Prompts the user to save the linked URL instead of navigating to it.
651
+ * If `true`, the user can save the linked URL instead of navigating to it.
628
652
  */
629
653
  "download"?: string | boolean;
630
654
  /**
@@ -632,11 +656,11 @@ export namespace Components {
632
656
  */
633
657
  "href"?: string;
634
658
  /**
635
- * Hints at the human language of the linked URL.
659
+ * The human language of the linked URL.
636
660
  */
637
661
  "hreflang"?: string;
638
662
  /**
639
- * label info to display
663
+ * The label info to display.
640
664
  */
641
665
  "label": string;
642
666
  /**
@@ -652,17 +676,17 @@ export namespace Components {
652
676
  */
653
677
  "setFocus": () => Promise<void>;
654
678
  /**
655
- * Where to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
679
+ * The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
656
680
  */
657
681
  "target"?: string;
658
682
  }
659
683
  interface IcNavigationGroup {
660
684
  /**
661
- * whether the group should be expandable/collapsible in the side menu
685
+ * If `true`, the group will be expandable in the side menu.
662
686
  */
663
687
  "expandable": boolean;
664
688
  /**
665
- * label to display on the group
689
+ * The label to display on the group.
666
690
  */
667
691
  "label": string;
668
692
  /**
@@ -675,15 +699,15 @@ export namespace Components {
675
699
  "displayNavigationTooltip": boolean;
676
700
  "expandable": boolean;
677
701
  /**
678
- * Destination of the navigation item
702
+ * The destination of the navigation item.
679
703
  */
680
704
  "href": string;
681
705
  /**
682
- * Label of the navigation item
706
+ * The label of the navigation item.
683
707
  */
684
708
  "label": string;
685
709
  /**
686
- * If true, sets the navigation item in a selected state
710
+ * If `true`, the navigation item will be set in a selected state.
687
711
  */
688
712
  "selected": boolean;
689
713
  /**
@@ -693,179 +717,179 @@ export namespace Components {
693
717
  }
694
718
  interface IcNavigationMenu {
695
719
  /**
696
- * Status info to display
720
+ * The status info to display.
697
721
  */
698
722
  "status": string;
699
723
  /**
700
- * Version info to display
724
+ * The version info to display.
701
725
  */
702
726
  "version": string;
703
727
  }
704
728
  interface IcPageHeader {
705
729
  /**
706
- * How the component should be aligned.
730
+ * The alignment of the page header.
707
731
  */
708
732
  "aligned"?: IcAlignment;
709
733
  /**
710
- * Set whether the bottom border is used
734
+ * If `true`, a border will be displayed along the bottom of the page header.
711
735
  */
712
736
  "border"?: boolean;
713
737
  /**
714
- * The title to render on the component.
738
+ * The title to render on the page header.
715
739
  */
716
740
  "heading"?: string;
717
741
  /**
718
- * Set whether the reading pattern and tab order change in the action area for viewport widths of above 576px and when actions have not wrapped
742
+ * If `true`, the reading pattern and tab order will change in the action area for viewport widths of above 576px and when actions have not wrapped.
719
743
  */
720
744
  "reverseOrder"?: boolean;
721
745
  /**
722
- * Whether the component uses small styling.
746
+ * If `true`, the small styling will be applied to the page header.
723
747
  */
724
748
  "small"?: boolean;
725
749
  /**
726
- * Set whether the header is sticky at all breakpoints
750
+ * If `true`, the page header will be sticky at all breakpoints.
727
751
  */
728
752
  "sticky"?: boolean;
729
753
  /**
730
- * Set whether the header is only sticky for viewport widths of 992px and above
754
+ * If `true`, the page header will only be sticky for viewport widths of 992px and above.
731
755
  */
732
756
  "stickyDesktopOnly"?: boolean;
733
757
  /**
734
- * The subtitle to render on the component.
758
+ * The subtitle to render on the page header.
735
759
  */
736
760
  "subheading"?: string;
737
761
  }
738
762
  interface IcRadioGroup {
739
763
  /**
740
- * Specify whether the input is disabled.
764
+ * If `true`, the disabled state will be set.
741
765
  */
742
766
  "disabled": boolean;
743
767
  /**
744
- * Provide helper text to display additional field guidance.
768
+ * The helper text that will be displayed for additional field guidance.
745
769
  */
746
770
  "helperText": string;
747
771
  /**
748
- * Hides the label and applies the required label value as an aria-label.
772
+ * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
749
773
  */
750
774
  "hideLabel": boolean;
751
775
  /**
752
- * Provide a label for the input.
776
+ * The label for the radio group to be displayed.
753
777
  */
754
778
  "label": string;
755
779
  /**
756
- * Provide a name for the input.
780
+ * The name for the radio group to differentiate from other groups.
757
781
  */
758
782
  "name": string;
759
783
  /**
760
- * Specify if the input requires a value.
784
+ * If `true`, the radio group will require a value.
761
785
  */
762
786
  "required": boolean;
763
787
  /**
764
- * Specify whether small styling is to be applied to the element.
788
+ * If `true`, the small styling will be applied to the radio group.
765
789
  */
766
790
  "small": boolean;
767
791
  /**
768
- * Provide validation status - 'error'
792
+ * The validation status - e.g. 'error' | 'warning' | 'success'.
769
793
  */
770
794
  "validationStatus": IcInformationStatusOrEmpty;
771
795
  /**
772
- * Provide validation text - 'error'
796
+ * The validation text - e.g. 'error' | 'warning' | 'success'.
773
797
  */
774
798
  "validationText": string;
775
799
  }
776
800
  interface IcRadioOption {
777
801
  /**
778
- * Determines type of additional text field in relation to radio option
802
+ * The style of additionalField that will be displayed if used.
779
803
  */
780
804
  "additionalFieldDisplay": IcAdditionalFieldTypes;
781
805
  /**
782
- * Determines whether the radio should be in disabled state.
806
+ * If `true`, the disabled state will be set.
783
807
  */
784
808
  "disabled"?: boolean;
785
809
  /**
786
- * Provide a text prop for the dynamic text.
810
+ * The text to be displayed when dynamic.
787
811
  */
788
812
  "dynamicText": string;
789
813
  /**
790
- * Provide a group label for the input.
814
+ * The group label for the radio option.
791
815
  */
792
816
  "groupLabel": string;
793
817
  /**
794
- * Provide a label for the input.
818
+ * The label for the radio option.
795
819
  */
796
820
  "label"?: string;
797
821
  /**
798
- * Provide a name for the input.
822
+ * The name for the radio option.
799
823
  */
800
824
  "name": string;
801
825
  /**
802
- * Determines whether the radio should be in selected state.
826
+ * If `true`, the radio option will be displayed in a selected state.
803
827
  */
804
828
  "selected"?: boolean;
805
829
  /**
806
- * Provide a value for the input.
830
+ * The value for the radio option.
807
831
  */
808
832
  "value": string;
809
833
  }
810
834
  interface IcSearchBar {
811
835
  /**
812
- * Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user. Available options: "off", "none", "on", "sentences", "words", "characters".
836
+ * The automatic capitalisation of the text value as it is entered/edited by the user. Available options: "off", "none", "on", "sentences", "words", "characters".
813
837
  */
814
838
  "autocapitalize": string;
815
839
  /**
816
- * Indicates whether the value of the control can be automatically completed by the browser.
840
+ * The state of autocompletion the browser can apply on the text value.
817
841
  */
818
842
  "autocomplete"?: IcAutocompleteTypes;
819
843
  /**
820
- * Whether auto correction should be enabled when the user is entering/editing the text value.
844
+ * The state of autocorrection the browser can apply when the user is entering/editing the text value.
821
845
  */
822
846
  "autocorrect"?: IcAutocorrectStates;
823
847
  /**
824
- * This Boolean attribute lets you specify that a form control should have input focus when the page loads.
848
+ * If `true`, the form control will have input focus when the page loads.
825
849
  */
826
850
  "autofocus": boolean;
827
851
  /**
828
- * Number of characters until suggestions appear
852
+ * The number of characters until suggestions appear.
829
853
  */
830
854
  "charactersUntilSuggestion": number;
831
855
  /**
832
- * Set the amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.
856
+ * The amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.
833
857
  */
834
858
  "debounce"?: number;
835
859
  /**
836
- * Specify whether to disable the built in filtering. For example, if options will already be filtered from external source. If true, all options provided will be displayed.
860
+ * Specify whether to disable the built in filtering. For example, if options will already be filtered from external source. If `true`, all options provided will be displayed.
837
861
  */
838
862
  "disableFilter"?: boolean;
839
863
  /**
840
- * Specify whether the input is disabled.
864
+ * If `true`, the disabled state will be set.
841
865
  */
842
866
  "disabled"?: boolean;
843
867
  /**
844
- * Provide text for empty results list
868
+ * The text displayed when there are no options in the option list.
845
869
  */
846
870
  "emptyOptionListText": string;
847
871
  /**
848
- * Specify whether the input should be focussed when component loaded.
872
+ * If `true`, the search bar will be focused when component loaded.
849
873
  */
850
874
  "focusOnLoad"?: boolean;
851
875
  /**
852
- * Specify whether the component fills the full width of the container. If true, this overrides the --input-width css prop.
876
+ * Specify whether the search bar fills the full width of the container. If `true`, this overrides the --input-width CSS variable.
853
877
  */
854
878
  "fullWidth"?: boolean;
855
879
  /**
856
- * Provide helper text to display additional field guidance.
880
+ * The helper text that will be displayed for additional field guidance.
857
881
  */
858
882
  "helperText"?: string;
859
883
  /**
860
- * Hides the label and applies the required label value as an aria-label.
884
+ * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
861
885
  */
862
886
  "hideLabel"?: boolean;
863
887
  /**
864
- * Provide hint text for hidden assistive description element.
888
+ * The hint text for the hidden assistive description element.
865
889
  */
866
890
  "hintText"?: string;
867
891
  /**
868
- * Provide a label for the input.
892
+ * The label for the search bar.
869
893
  */
870
894
  "label": string;
871
895
  /**
@@ -873,19 +897,19 @@ export namespace Components {
873
897
  */
874
898
  "name": string;
875
899
  /**
876
- * Provide the suggested search options
900
+ * The suggested search options.
877
901
  */
878
902
  "options"?: IcMenuOption[];
879
903
  /**
880
- * Provide a placeholder value to display.
904
+ * The placeholder value to display.
881
905
  */
882
906
  "placeholder"?: string;
883
907
  /**
884
- * Specify whether the input is read only.
908
+ * If `true`, the readonly state will be set.
885
909
  */
886
910
  "readonly"?: boolean;
887
911
  /**
888
- * Specify if the input requires a value.
912
+ * If `true`, the search bar will require a value.
889
913
  */
890
914
  "required"?: boolean;
891
915
  /**
@@ -893,63 +917,63 @@ export namespace Components {
893
917
  */
894
918
  "setFocus": () => Promise<void>;
895
919
  /**
896
- * Specify whether small styling is to be applied to the element.
920
+ * If `true`, the small styling will be applied to the search bar.
897
921
  */
898
922
  "small"?: boolean;
899
923
  /**
900
- * If `true`, the element will have its spelling and grammar checked.
924
+ * If `true`, the value of the search will have its spelling and grammar checked.
901
925
  */
902
926
  "spellcheck": boolean;
903
927
  /**
904
- * Value of Search input.
928
+ * The value of the search input.
905
929
  */
906
930
  "value": string;
907
931
  }
908
932
  interface IcSectionContainer {
909
933
  /**
910
- * How the container should be aligned.
934
+ * The alignment of the container.
911
935
  */
912
936
  "aligned"?: IcAlignment;
913
937
  /**
914
- * Removes the standard vertical padding from the container.
938
+ * If `true`, the standard vertical padding from the container will be removed.
915
939
  */
916
940
  "fullHeight"?: boolean;
917
941
  }
918
942
  interface IcSelect {
919
943
  /**
920
- * Number of characters until suggestions appear for a searchable select.
944
+ * The number of characters until suggestions appear for a searchable select.
921
945
  */
922
946
  "charactersUntilSuggestions"?: number;
923
947
  /**
924
- * Specify whether the input is disabled.
948
+ * If `true`, the disabled state will be set.
925
949
  */
926
950
  "disabled"?: boolean;
927
951
  /**
928
- * Provide text for empty results list
952
+ * The text displayed when there are no options in the option list.
929
953
  */
930
954
  "emptyOptionListText": string;
931
955
  /**
932
- * If true, then fill width of container.
956
+ * If `true`, the select element will fill the width of the container.
933
957
  */
934
958
  "fullWidth": boolean;
935
959
  /**
936
- * Provide helper text to display additional field guidance.
960
+ * The helper text that will be displayed for additional field guidance.
937
961
  */
938
962
  "helperText"?: string;
939
963
  /**
940
- * Hides the label and applies the required label value as an aria-label.
964
+ * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
941
965
  */
942
966
  "hideLabel"?: boolean;
943
967
  /**
944
- * If true, descriptions of options are included when filtering options in a searchable select.
968
+ * If `true`, descriptions of options will be included when filtering options in a searchable select.
945
969
  */
946
970
  "includeDescriptionsInSearch"?: boolean;
947
971
  /**
948
- * If true, group titles of grouped options are included when filtering options in a searchable select.
972
+ * If `true`, group titles of grouped options will be included when filtering options in a searchable select.
949
973
  */
950
974
  "includeGroupTitlesInSearch"?: boolean;
951
975
  /**
952
- * Provide a label for the input.
976
+ * The label for the select.
953
977
  */
954
978
  "label": string;
955
979
  /**
@@ -957,19 +981,19 @@ export namespace Components {
957
981
  */
958
982
  "name"?: string;
959
983
  /**
960
- * Provide the possible selection options.
984
+ * The possible selection options.
961
985
  */
962
986
  "options"?: IcMenuOption[];
963
987
  /**
964
- * Provide a placeholder value to display.
988
+ * The placeholder value to be displayed.
965
989
  */
966
990
  "placeholder"?: string;
967
991
  /**
968
- * Specify whether the input is read only.
992
+ * If `true`, the readonly state will be set.
969
993
  */
970
994
  "readonly"?: boolean;
971
995
  /**
972
- * Specify if the input requires a value.
996
+ * If `true`, the select will require a value.
973
997
  */
974
998
  "required"?: boolean;
975
999
  /**
@@ -977,7 +1001,7 @@ export namespace Components {
977
1001
  */
978
1002
  "searchMatchPosition"?: IcSearchMatchPositions;
979
1003
  /**
980
- * If true, the select can be typed in to filter options.
1004
+ * If `true`, a searchable variant of the select will be displayed which can be typed in to filter options.
981
1005
  */
982
1006
  "searchable"?: boolean;
983
1007
  /**
@@ -985,19 +1009,19 @@ export namespace Components {
985
1009
  */
986
1010
  "setFocus": () => Promise<void>;
987
1011
  /**
988
- * Display a button which clears the input when clicked. The button will always appear on the searchable select.
1012
+ * If `true`, a button which clears the select input when clicked will be displayed. The button will always appear on the searchable select.
989
1013
  */
990
1014
  "showClearButton"?: boolean;
991
1015
  /**
992
- * Specify whether small styling is to be applied to the element.
1016
+ * If `true`, the small styling will be applied to the select.
993
1017
  */
994
1018
  "small"?: boolean;
995
1019
  /**
996
- * Provide a validation status.
1020
+ * The validation status - e.g. 'error' | 'warning' | 'success'.
997
1021
  */
998
1022
  "validationStatus"?: IcInformationStatusOrEmpty;
999
1023
  /**
1000
- * Provide the text to display as the validation message.
1024
+ * The text to display as the validation message.
1001
1025
  */
1002
1026
  "validationText"?: string;
1003
1027
  /**
@@ -1007,49 +1031,46 @@ export namespace Components {
1007
1031
  }
1008
1032
  interface IcSideNavigation {
1009
1033
  /**
1010
- * Title to display.
1034
+ * The title of the app to be displayed.
1011
1035
  */
1012
1036
  "appTitle": string;
1013
1037
  /**
1014
- * If true, the icon and label will appear when side navigation is collapsed
1038
+ * If `true`, the icon and label will appear when side navigation is collapsed.
1015
1039
  */
1016
1040
  "collapsedIconLabels": boolean;
1017
1041
  /**
1018
- * If true, disable automatic parent wrapper styling
1042
+ * If `true`, automatic parent wrapper styling will be disabled.
1019
1043
  */
1020
1044
  "disableAutoParentStyling": boolean;
1021
1045
  /**
1022
- * If true, the ic-side-navigation will load in an expanded state
1046
+ * If `true`, the side navigation will load in an expanded state.
1023
1047
  */
1024
1048
  "expanded": boolean;
1025
1049
  /**
1026
- * Set application title link
1050
+ * The URL that the app title link points to.
1027
1051
  */
1028
1052
  "href": string;
1029
- /**
1030
- * If true, side navigation will be contained by parent element
1031
- */
1032
1053
  "inline": boolean;
1033
1054
  /**
1034
- * If true, the menu expand button is removed (PLEASE NOTE: This takes effect on screen sizes 992px and above)
1055
+ * If `true`, the menu expand button will be removed (PLEASE NOTE: This takes effect on screen sizes 992px and above).
1035
1056
  */
1036
1057
  "static": boolean;
1037
1058
  /**
1038
- * Status of application
1059
+ * The status of the app to be displayed.
1039
1060
  */
1040
1061
  "status": string;
1041
1062
  /**
1042
- * Version of application
1063
+ * The version of the app to be displayed.
1043
1064
  */
1044
1065
  "version": string;
1045
1066
  }
1046
1067
  interface IcSkeleton {
1047
1068
  /**
1048
- * Set the skeleton to the light variant
1069
+ * If `true`, the skeleton will be set to the light variant.
1049
1070
  */
1050
1071
  "light"?: boolean;
1051
1072
  /**
1052
- * The variant of the skeleton that will be displayed
1073
+ * The variant of the skeleton that will be displayed.
1053
1074
  */
1054
1075
  "variant"?: IcSkeletonVariants;
1055
1076
  }
@@ -1063,7 +1084,7 @@ export namespace Components {
1063
1084
  */
1064
1085
  "label": string;
1065
1086
  /**
1066
- * The size of the status tag.
1087
+ * If `true`, the small styling will be applied to the status tag.
1067
1088
  */
1068
1089
  "small"?: boolean;
1069
1090
  /**
@@ -1072,50 +1093,68 @@ export namespace Components {
1072
1093
  "status"?: IcStatusTagStatuses;
1073
1094
  }
1074
1095
  interface IcStep {
1075
- "lastStep"?: boolean;
1096
+ "compactStepStyling"?: IcStepTypes;
1097
+ "current"?: boolean;
1098
+ "lastStep": boolean;
1099
+ "lastStepNum"?: number;
1100
+ "nextStepTitle"?: string;
1101
+ "progress"?: number;
1076
1102
  "stepNum"?: number;
1077
1103
  /**
1078
- * Additional information about step
1104
+ * The status of the step. Use this prop to display a status message on the step if it is required or optional.
1105
+ */
1106
+ "stepStatus"?: IcStepStatuses;
1107
+ /**
1108
+ * Additional information about the step. Use this prop to override the default step status messaging displayed when selecting a step type or step status.
1079
1109
  */
1080
1110
  "stepSubtitle"?: string;
1081
1111
  /**
1082
- * Name of step
1112
+ * The title of the step within the stepper.
1083
1113
  */
1084
1114
  "stepTitle"?: string;
1085
1115
  /**
1086
- * State of step
1116
+ * The state of the step within the stepper.
1087
1117
  */
1088
1118
  "stepType"?: IcStepTypes;
1119
+ "variant": IcStepVariants;
1089
1120
  }
1090
1121
  interface IcStepper {
1091
1122
  /**
1092
- * How the stepper should be aligned in its container.
1123
+ * The alignment of the default stepper within its container.
1093
1124
  */
1094
1125
  "aligned"?: IcStepperAlignment;
1095
1126
  /**
1096
1127
  * The length of the connnector between each step in pixels. Minimum length is 100px.
1097
1128
  */
1098
1129
  "connectorWidth"?: number;
1130
+ /**
1131
+ * If `true`, the information about each step, i.e. step title, step subtitle and step status, will be hidden on all default steps. The information about each step will still be visible in the compact variant of the stepper.
1132
+ */
1133
+ "hideStepInfo"?: boolean;
1134
+ /**
1135
+ * The variant of the stepper.
1136
+ */
1137
+ "variant"?: IcStepVariants;
1099
1138
  }
1100
1139
  interface IcSwitch {
1101
1140
  /**
1102
- * If true, the component is checked.
1141
+ * If `true`, the switch will display as checked.
1103
1142
  */
1104
1143
  "checked"?: boolean;
1105
1144
  /**
1106
- * If true, the component is not interactive.
1145
+ * If `true`, the disabled state will be set.
1107
1146
  */
1108
1147
  "disabled"?: boolean;
1109
1148
  /**
1110
- * Provide helper text to display additional field guidance.
1149
+ * The helper text that will be displayed for additional field guidance.
1111
1150
  */
1112
1151
  "helperText"?: string;
1113
1152
  /**
1114
- * Hides the label and applies the required label value as an aria-label.
1153
+ * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
1115
1154
  */
1116
1155
  "hideLabel"?: boolean;
1117
1156
  /**
1118
- * Applies an aria-label to the component, for when no visual 'name' is provided.
1157
+ * The aria-label applied to the switch when no visual 'name' is provided.
1119
1158
  */
1120
1159
  "label": string;
1121
1160
  /**
@@ -1123,11 +1162,11 @@ export namespace Components {
1123
1162
  */
1124
1163
  "name"?: string;
1125
1164
  /**
1126
- * If true, the component will render the On/Off state text.
1165
+ * If `true`, the switch will render the On/Off state text.
1127
1166
  */
1128
1167
  "showState"?: boolean;
1129
1168
  /**
1130
- * If true, the component reduces in size to the small state.
1169
+ * If `true`, the small styling will be applied to the switch.
1131
1170
  */
1132
1171
  "small"?: boolean;
1133
1172
  /**
@@ -1139,7 +1178,7 @@ export namespace Components {
1139
1178
  "appearance"?: IcThemeForegroundNoDefault;
1140
1179
  "contextId"?: string;
1141
1180
  /**
1142
- * Disables the tab.
1181
+ * If `true`, the disabled state will be set.
1143
1182
  */
1144
1183
  "disabled"?: boolean;
1145
1184
  "selected"?: boolean;
@@ -1152,30 +1191,30 @@ export namespace Components {
1152
1191
  */
1153
1192
  "activationType"?: IcActivationTypes;
1154
1193
  /**
1155
- * Determines whether the light or dark variant of the tabs should be displayed.
1194
+ * The appearance of the tab context, e.g dark, or light.
1156
1195
  */
1157
1196
  "appearance"?: IcThemeForegroundNoDefault;
1158
1197
  /**
1159
- * Provide a unique context if using multiple tabs inside one another i.e. rendering another set of tabs inside a tab panel.
1198
+ * The unique context needed if using multiple tabs inside one another i.e. rendering another set of tabs inside a tab panel.
1160
1199
  */
1161
1200
  "contextId"?: string;
1162
1201
  /**
1163
- * Allows the user to control the selected tab. Must be used alongside the tabSelect event to manage tab selection.
1202
+ * The selected tab to be controlled by the user. Must be used alongside the icTabSelect event to manage tab selection.
1164
1203
  */
1165
1204
  "selectedTabIndex"?: number;
1166
1205
  }
1167
1206
  interface IcTabGroup {
1168
1207
  "appearance"?: IcThemeForegroundNoDefault;
1169
1208
  /**
1170
- * Provide a unique context if using multiple tabs inside one another i.e. rendering another set of tabs inside a tab panel.
1209
+ * The unique context needed if using multiple tabs inside one another i.e. rendering another set of tabs inside a tab panel.
1171
1210
  */
1172
1211
  "contextId"?: string;
1173
1212
  /**
1174
- * Use when tabs and tab panels are to be positioned separately.
1213
+ * If `true`, the tabs and tab panels will be positioned separately.
1175
1214
  */
1176
1215
  "inline"?: boolean;
1177
1216
  /**
1178
- * Provide a label to describe the purpose of the set of tabs to screen reader users.
1217
+ * The label to describe the purpose of the set of tabs to screen reader users.
1179
1218
  */
1180
1219
  "label": string;
1181
1220
  "scrollTabIntoView": (tabNumber: number) => Promise<void>;
@@ -1183,7 +1222,7 @@ export namespace Components {
1183
1222
  interface IcTabPanel {
1184
1223
  "appearance"?: IcThemeForegroundNoDefault;
1185
1224
  /**
1186
- * Provide a unique context if using multiple tabs inside one another i.e. rendering another tabs inside a tab panel.
1225
+ * The unique context needed if using multiple tabs inside one another i.e. rendering another tabs inside a tab panel.
1187
1226
  */
1188
1227
  "contextId"?: string;
1189
1228
  "panelId"?: string;
@@ -1196,44 +1235,44 @@ export namespace Components {
1196
1235
  "ariaExpanded": string;
1197
1236
  "ariaOwns": string;
1198
1237
  /**
1199
- * This Boolean attribute lets you specify that a form control should have input focus when the page loads.
1238
+ * If `true`, the form control will have input focus when the page loads.
1200
1239
  */
1201
1240
  "autoFocus": boolean;
1202
1241
  /**
1203
- * Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user. Available options: "off", "none", "on", "sentences", "words", "characters".
1242
+ * The automatic capitalisation of the text value as it is entered/edited by the user. Available options: "off", "none", "on", "sentences", "words", "characters".
1204
1243
  */
1205
1244
  "autocapitalize": string;
1206
1245
  /**
1207
- * Indicates whether the value of the control can be automatically completed by the browser.
1246
+ * The state of autocompletion the browser can apply on the text value.
1208
1247
  */
1209
1248
  "autocomplete": IcAutocompleteTypes1;
1210
1249
  /**
1211
- * Whether auto correction should be enabled when the user is entering/editing the text value.
1250
+ * The state of autocorrection the browser can apply when the user is entering/editing the text value.
1212
1251
  */
1213
1252
  "autocorrect": IcAutocorrectStates1;
1214
1253
  /**
1215
- * Set the amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.
1254
+ * The amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.
1216
1255
  */
1217
1256
  "debounce": number;
1218
1257
  /**
1219
- * Specify whether the input is disabled.
1258
+ * If `true`, the disabled state will be set.
1220
1259
  */
1221
1260
  "disabled": boolean;
1222
1261
  /**
1223
- * Specify whether the component fills the full width of the container. If true, this overrides the --input-width css prop.
1262
+ * Specify whether the text field fills the full width of the container. If `true`, this overrides the --input-width CSS variable.
1224
1263
  */
1225
1264
  "fullWidth": boolean;
1226
1265
  /**
1227
- * Provide helper text to display additional field guidance.
1266
+ * The helper text that will be displayed for additional field guidance.
1228
1267
  */
1229
1268
  "helperText": string;
1230
1269
  "hiddenInput": boolean;
1231
1270
  /**
1232
- * Hides the label and applies the required label value as an aria-label.
1271
+ * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
1233
1272
  */
1234
1273
  "hideLabel": boolean;
1235
1274
  /**
1236
- * Provide an id for the input
1275
+ * The ID for the input.
1237
1276
  */
1238
1277
  "inputId"?: string;
1239
1278
  /**
@@ -1241,11 +1280,11 @@ export namespace Components {
1241
1280
  */
1242
1281
  "inputmode": IcTextFieldInputModes;
1243
1282
  /**
1244
- * Provide a label for the input.
1283
+ * The label for the input.
1245
1284
  */
1246
1285
  "label": string;
1247
1286
  /**
1248
- * Maximum number of characters that can be entered in the field.
1287
+ * The maximum number of characters that can be entered in the field.
1249
1288
  */
1250
1289
  "maxLength": number;
1251
1290
  /**
@@ -1253,24 +1292,24 @@ export namespace Components {
1253
1292
  */
1254
1293
  "name": string;
1255
1294
  /**
1256
- * Provide a placeholder value to display.
1295
+ * The placeholder value to be displayed.
1257
1296
  */
1258
1297
  "placeholder": string;
1259
1298
  /**
1260
- * Specify whether the input is read only.
1299
+ * If `true`, the read only state will be set.
1261
1300
  */
1262
1301
  "readonly": boolean;
1263
1302
  /**
1264
- * Specify if the input requires a value.
1303
+ * If `true`, the input will require a value.
1265
1304
  */
1266
1305
  "required": boolean;
1267
1306
  /**
1268
- * Allow resizing of a multiline text area
1307
+ * If `true`, the multiline text area will be resizeable.
1269
1308
  */
1270
1309
  "resize": boolean;
1271
1310
  "role": string;
1272
1311
  /**
1273
- * Specify the number of rows to transform the text field into a text area with a specific height.
1312
+ * The number of rows to transform the text field into a text area with a specific height.
1274
1313
  */
1275
1314
  "rows": number;
1276
1315
  /**
@@ -1278,11 +1317,11 @@ export namespace Components {
1278
1317
  */
1279
1318
  "setFocus": () => Promise<void>;
1280
1319
  /**
1281
- * Specify whether small styling is to be applied to the element.
1320
+ * If `true`, the small styling will be applied to the text field.
1282
1321
  */
1283
1322
  "small": boolean;
1284
1323
  /**
1285
- * If `true`, the element will have its spelling and grammar checked.
1324
+ * If `true`, the value of the text field will have its spelling and grammar checked.
1286
1325
  */
1287
1326
  "spellcheck": boolean;
1288
1327
  "truncateValue"?: boolean;
@@ -1291,29 +1330,33 @@ export namespace Components {
1291
1330
  */
1292
1331
  "type": IcTextFieldTypes;
1293
1332
  /**
1294
- * Show icon in input control - only applies when validationStatus ='success'
1333
+ * If `true`, the icon in input control will be displayed - only applies when validationStatus ='success'.
1295
1334
  */
1296
1335
  "validationInline": boolean;
1297
1336
  /**
1298
- * Provide validation state - 'error' | 'warning' | 'success'
1337
+ * The validation state - e.g. 'error' | 'warning' | 'success'.
1299
1338
  */
1300
1339
  "validationStatus": IcInformationStatusOrEmpty1;
1301
1340
  /**
1302
- * Provide validation state - 'error' | 'warning' | 'success'
1341
+ * The validation state - e.g. 'error' | 'warning' | 'success'.
1303
1342
  */
1304
1343
  "validationText": string;
1305
1344
  /**
1306
- * Value of TextField.
1345
+ * The value of the text field.
1307
1346
  */
1308
1347
  "value": string;
1309
1348
  }
1310
1349
  interface IcTheme {
1311
1350
  /**
1312
- * The theme colour. Can be a hex value eg "#ff0000" or RGB eg "rgb(255, 0, 0)"
1351
+ * The theme colour. Can be a hex value e.g. "#ff0000", RGB e.g. "rgb(255, 0, 0)", or RGBA e.g. "rgba(255, 0, 0, 1)".
1313
1352
  */
1314
1353
  "color"?: string;
1315
1354
  }
1316
1355
  interface IcTooltip {
1356
+ /**
1357
+ * If `true`, the tooltip will not be displayed on hover, it will require a click.
1358
+ */
1359
+ "disableHover"?: boolean;
1317
1360
  /**
1318
1361
  * The text to display on the tooltip.
1319
1362
  */
@@ -1329,33 +1372,33 @@ export namespace Components {
1329
1372
  }
1330
1373
  interface IcTopNavigation {
1331
1374
  /**
1332
- * Title to display
1375
+ * The app title to be displayed.
1333
1376
  */
1334
1377
  "appTitle": string;
1335
1378
  /**
1336
- * The alignment of the top nav content
1379
+ * The alignment of the top navigation content.
1337
1380
  */
1338
1381
  "contentAligned": IcAlignment;
1339
1382
  /**
1340
- * The url to navigate to when title is clicked
1383
+ * The URL to navigate to when the app title is clicked.
1341
1384
  */
1342
1385
  "href": string;
1343
1386
  /**
1344
- * If true, the flyout navigation menu on small devices will be contained by the parent element
1387
+ * If `true`, the flyout navigation menu on small devices will be contained by the parent element.
1345
1388
  */
1346
1389
  "inline": boolean;
1347
1390
  /**
1348
- * Status info to display
1391
+ * The status info to be displayed.
1349
1392
  */
1350
1393
  "status": string;
1351
1394
  /**
1352
- * Version info to display
1395
+ * The version info to be displayed.
1353
1396
  */
1354
1397
  "version": string;
1355
1398
  }
1356
1399
  interface IcTypography {
1357
1400
  /**
1358
- * Adds appropriate margins to the top and bottom of the typography.
1401
+ * If `true`, appropriate top and bottom margins will be applied to the typography.
1359
1402
  */
1360
1403
  "applyVerticalMargins"?: boolean;
1361
1404
  /**
@@ -1380,6 +1423,10 @@ export interface IcCheckboxGroupCustomEvent<T> extends CustomEvent<T> {
1380
1423
  detail: T;
1381
1424
  target: HTMLIcCheckboxGroupElement;
1382
1425
  }
1426
+ export interface IcChipCustomEvent<T> extends CustomEvent<T> {
1427
+ detail: T;
1428
+ target: HTMLIcChipElement;
1429
+ }
1383
1430
  export interface IcFooterCustomEvent<T> extends CustomEvent<T> {
1384
1431
  detail: T;
1385
1432
  target: HTMLIcFooterElement;
@@ -1485,6 +1532,12 @@ declare global {
1485
1532
  prototype: HTMLIcCheckboxGroupElement;
1486
1533
  new (): HTMLIcCheckboxGroupElement;
1487
1534
  };
1535
+ interface HTMLIcChipElement extends Components.IcChip, HTMLStencilElement {
1536
+ }
1537
+ var HTMLIcChipElement: {
1538
+ prototype: HTMLIcChipElement;
1539
+ new (): HTMLIcChipElement;
1540
+ };
1488
1541
  interface HTMLIcClassificationBannerElement extends Components.IcClassificationBanner, HTMLStencilElement {
1489
1542
  }
1490
1543
  var HTMLIcClassificationBannerElement: {
@@ -1734,6 +1787,7 @@ declare global {
1734
1787
  "ic-card": HTMLIcCardElement;
1735
1788
  "ic-checkbox": HTMLIcCheckboxElement;
1736
1789
  "ic-checkbox-group": HTMLIcCheckboxGroupElement;
1790
+ "ic-chip": HTMLIcChipElement;
1737
1791
  "ic-classification-banner": HTMLIcClassificationBannerElement;
1738
1792
  "ic-data-entity": HTMLIcDataEntityElement;
1739
1793
  "ic-data-row": HTMLIcDataRowElement;
@@ -1779,31 +1833,35 @@ declare global {
1779
1833
  declare namespace LocalJSX {
1780
1834
  interface IcAlert {
1781
1835
  /**
1782
- * Set whether the alert has the 'alert' aria role and will be announced to screen readers
1836
+ * If `true`, the alert will have the 'alert' ARIA role and will be announced to screen readers.
1783
1837
  */
1784
1838
  "announced"?: boolean;
1785
1839
  /**
1786
- * Set whether the alert has a close icon at the end to dismiss it
1840
+ * If `true`, the alert will have a close icon at the end to dismiss it.
1787
1841
  */
1788
1842
  "dismissible"?: boolean;
1789
1843
  /**
1790
- * Optional title to display at the start of the alert
1844
+ * The optional title to display at the start of the alert.
1791
1845
  */
1792
1846
  "heading"?: string;
1793
1847
  /**
1794
- * Main body message of the alert
1848
+ * The main body message of the alert.
1795
1849
  */
1796
1850
  "message"?: string;
1797
1851
  /**
1798
- * Is emitted when the user dismisses the alert.
1852
+ * @deprecated This event should not be used anymore. Use icDismiss instead.
1799
1853
  */
1800
1854
  "onDismiss"?: (event: IcAlertCustomEvent<void>) => void;
1801
1855
  /**
1802
- * Set whether the title and message appear inline or above and below
1856
+ * Is emitted when the user dismisses the alert.
1857
+ */
1858
+ "onIcDismiss"?: (event: IcAlertCustomEvent<void>) => void;
1859
+ /**
1860
+ * If `true`, the title and message will appear inline instead of above and below.
1803
1861
  */
1804
1862
  "titleAbove"?: boolean;
1805
1863
  /**
1806
- * Set which variant of the alert will be rendered
1864
+ * The variant of the alert which will be rendered.
1807
1865
  */
1808
1866
  "variant"?: IcAlertVariants;
1809
1867
  }
@@ -1815,47 +1873,47 @@ declare namespace LocalJSX {
1815
1873
  }
1816
1874
  interface IcBreadcrumb {
1817
1875
  /**
1818
- * If true, aria-current will be set on the breadcrumb
1876
+ * If `true`, aria-current will be set on the breadcrumb.
1819
1877
  */
1820
1878
  "current"?: boolean;
1821
1879
  /**
1822
- * Set breadcrumb location
1880
+ * The URL that the breadcrumb link points to.
1823
1881
  */
1824
1882
  "href"?: string;
1825
1883
  /**
1826
- * Set breadcrumb title
1884
+ * The title of the breadcrumb.
1827
1885
  */
1828
1886
  "pageTitle": string;
1829
1887
  }
1830
1888
  interface IcBreadcrumbGroup {
1831
1889
  /**
1832
- * If true, display the parent page and back icon as breadcrumb
1890
+ * If `true`, display only a single breadcrumb for the parent page with a back icon.
1833
1891
  */
1834
1892
  "backBreadcrumbOnly"?: boolean;
1835
1893
  /**
1836
- * If true, all breadcrumbs between the first and last breadcrumb will be collapsed
1894
+ * If `true`, all breadcrumbs between the first and last breadcrumb will be collapsed.
1837
1895
  */
1838
1896
  "collapsed"?: boolean;
1839
1897
  }
1840
1898
  interface IcButton {
1841
1899
  /**
1842
- * Determines the whether the appearance of the button is dark, light, or the default.
1900
+ * The appearance of the button, e.g. dark, light, or the default.
1843
1901
  */
1844
1902
  "appearance"?: IcThemeForeground;
1845
1903
  /**
1846
- * Disable ic-tooltip which is shown for icon variant. Title or aria-label must be set if this prop is not applied.
1904
+ * If `true`, the ic-tooltip which is shown for icon variant will be disabled. Title or aria-label must be set if this prop is not applied.
1847
1905
  */
1848
1906
  "disableTooltip"?: boolean;
1849
1907
  /**
1850
- * Determines whether the button should be in disabled state.
1908
+ * If `true`, the button will be in disabled state.
1851
1909
  */
1852
1910
  "disabled"?: boolean;
1853
1911
  /**
1854
- * Prompts the user to save the linked URL instead of navigating to it.
1912
+ * If `true`, the user can save the linked URL instead of navigating to it.
1855
1913
  */
1856
1914
  "download"?: string | boolean;
1857
1915
  /**
1858
- * Fill the width of the container if true.
1916
+ * If `true`, the button will fill the width of the container.
1859
1917
  */
1860
1918
  "fullWidth"?: boolean;
1861
1919
  /**
@@ -1863,11 +1921,11 @@ declare namespace LocalJSX {
1863
1921
  */
1864
1922
  "href"?: string;
1865
1923
  /**
1866
- * Hints at the human language of the linked URL.
1924
+ * The human language of the linked URL.
1867
1925
  */
1868
1926
  "hreflang"?: string;
1869
1927
  /**
1870
- * Determines whether the button should be in loading state.
1928
+ * If `true`, the button will be in loading state.
1871
1929
  */
1872
1930
  "loading"?: boolean;
1873
1931
  /**
@@ -1891,7 +1949,7 @@ declare namespace LocalJSX {
1891
1949
  */
1892
1950
  "size"?: IcButtonSizes;
1893
1951
  /**
1894
- * Where to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
1952
+ * The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
1895
1953
  */
1896
1954
  "target"?: string;
1897
1955
  /**
@@ -1903,37 +1961,37 @@ declare namespace LocalJSX {
1903
1961
  */
1904
1962
  "type"?: IcButtonTypes;
1905
1963
  /**
1906
- * The button variant to be displayed.
1964
+ * The variant of the button to be displayed.
1907
1965
  */
1908
1966
  "variant"?: IcButtonVariants;
1909
1967
  }
1910
1968
  interface IcCard {
1911
1969
  /**
1912
- * Set the variant to static or clickable
1970
+ * If `true`, the card will be a clickable variant, instead of static.
1913
1971
  */
1914
1972
  "clickable"?: boolean;
1915
1973
  /**
1916
- * Whether the card is disabled if it is clickable
1974
+ * If `true`, the card will be disabled if it is clickable.
1917
1975
  */
1918
1976
  "disabled"?: boolean;
1919
1977
  /**
1920
- * If true then fill width of container
1978
+ * If `true`, the card will fill the width of the container.
1921
1979
  */
1922
1980
  "fullWidth"?: boolean;
1923
1981
  /**
1924
- * Title for the card
1982
+ * The title for the card.
1925
1983
  */
1926
1984
  "heading": string;
1927
1985
  /**
1928
- * URL for clickable cards
1986
+ * The URL that the clickable card link points to.
1929
1987
  */
1930
1988
  "href"?: string | undefined;
1931
1989
  /**
1932
- * Human readable explanation of the URL
1990
+ * The human language of the linked URL.
1933
1991
  */
1934
1992
  "hreflang"?: string;
1935
1993
  /**
1936
- * Main body message of the card
1994
+ * The main body message of the card.
1937
1995
  */
1938
1996
  "message"?: string;
1939
1997
  /**
@@ -1945,71 +2003,75 @@ declare namespace LocalJSX {
1945
2003
  */
1946
2004
  "rel"?: string;
1947
2005
  /**
1948
- * Where to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
2006
+ * The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
1949
2007
  */
1950
2008
  "target"?: string;
1951
2009
  }
1952
2010
  interface IcCheckbox {
1953
2011
  /**
1954
- * Set which style of additionalField will be displayed if used
2012
+ * The style of additionalField that will be displayed if used.
1955
2013
  */
1956
2014
  "additionalFieldDisplay"?: IcAdditionalFieldTypes;
1957
2015
  /**
1958
- * Set the checkbox to the checked state
2016
+ * If `true`, the checkbox will be set to the checked state.
1959
2017
  */
1960
2018
  "checked"?: boolean;
1961
2019
  /**
1962
- * Set the checkbox to the disabled state
2020
+ * If `true`, the checkbox will be set to the disabled state.
1963
2021
  */
1964
2022
  "disabled"?: boolean;
1965
2023
  /**
1966
- * Provide a text prop for the dynamic text
2024
+ * The text to be displayed when dynamic.
1967
2025
  */
1968
2026
  "dynamicText"?: string;
1969
2027
  /**
1970
- * Provide a group label for the input
2028
+ * The group label for the checkbox.
1971
2029
  */
1972
2030
  "groupLabel"?: string;
1973
2031
  /**
1974
- * Display the indeterminate state when checked
2032
+ * If `true`, the indeterminate state will be displayed when checked.
1975
2033
  */
1976
2034
  "indeterminate"?: boolean;
1977
2035
  /**
1978
- * Provide a label for the input
2036
+ * The label for the checkbox.
1979
2037
  */
1980
2038
  "label": string;
1981
2039
  /**
1982
- * Provide a name for the input. If not set when used in a checkbox group, the name will be based on the group name.
2040
+ * The name for the checkbox. If not set when used in a checkbox group, the name will be based on the group name.
1983
2041
  */
1984
2042
  "name"?: string;
1985
2043
  /**
1986
- * Emitted when a checkbox has been checked
2044
+ * @deprecated This event should not be used anymore. Use icCheck instead.
1987
2045
  */
1988
2046
  "onCheckboxChecked"?: (event: IcCheckboxCustomEvent<void>) => void;
1989
2047
  /**
1990
- * Provide a value for the input
2048
+ * Emitted when a checkbox has been checked.
2049
+ */
2050
+ "onIcCheck"?: (event: IcCheckboxCustomEvent<void>) => void;
2051
+ /**
2052
+ * The value for the checkbox.
1991
2053
  */
1992
2054
  "value": string;
1993
2055
  }
1994
2056
  interface IcCheckboxGroup {
1995
2057
  /**
1996
- * Specify whether the input is disabled.
2058
+ * If `true`, the checkbox group will be set to the disabled state.
1997
2059
  */
1998
2060
  "disabled"?: boolean;
1999
2061
  /**
2000
- * Provide helper text to display additional field guidance.
2062
+ * The helper text that will be displayed for additional field guidance.
2001
2063
  */
2002
2064
  "helperText"?: string;
2003
2065
  /**
2004
- * Hides the label and applies the required label value as an aria-label.
2066
+ * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
2005
2067
  */
2006
2068
  "hideLabel"?: boolean;
2007
2069
  /**
2008
- * Provide a label for the input.
2070
+ * The label for the checkbox group to be displayed.
2009
2071
  */
2010
2072
  "label": string;
2011
2073
  /**
2012
- * Provide a name for the input.
2074
+ * The name for the checkbox group to differentiate from other groups.
2013
2075
  */
2014
2076
  "name": string;
2015
2077
  /**
@@ -2017,65 +2079,91 @@ declare namespace LocalJSX {
2017
2079
  */
2018
2080
  "onIcChange"?: (event: IcCheckboxGroupCustomEvent<IcChangeEventDetail>) => void;
2019
2081
  /**
2020
- * Specify if the input requires a value.
2082
+ * If `true`, the checkbox group will require a value.
2021
2083
  */
2022
2084
  "required"?: boolean;
2023
2085
  /**
2024
- * Specify whether small styling to be applied to element.
2086
+ * If `true`, the small styling will be applied to the checkbox group.
2025
2087
  */
2026
2088
  "small"?: boolean;
2027
2089
  /**
2028
- * Provide validation status - 'error'
2090
+ * The validation status - e.g. 'error' | 'warning' | 'success'.
2029
2091
  */
2030
2092
  "validationStatus"?: IcInformationStatusOrEmpty;
2031
2093
  /**
2032
- * Provide validation text - 'error'
2094
+ * The validation text - e.g. 'error' | 'warning' | 'success'.
2033
2095
  */
2034
2096
  "validationText"?: string;
2035
2097
  }
2098
+ interface IcChip {
2099
+ /**
2100
+ * The emphasis of the chip.
2101
+ */
2102
+ "appearance"?: IcChipAppearance;
2103
+ /**
2104
+ * If `true`, the chip will appear disabled.
2105
+ */
2106
+ "disabled"?: boolean;
2107
+ /**
2108
+ * If `true`, the chip will have a close button at the end to dismiss it.
2109
+ */
2110
+ "dismissible"?: boolean;
2111
+ /**
2112
+ * The text rendered within the chip.
2113
+ */
2114
+ "label": string;
2115
+ /**
2116
+ * Is emitted when the user dismisses the chip.
2117
+ */
2118
+ "onDismiss"?: (event: IcChipCustomEvent<void>) => void;
2119
+ /**
2120
+ * The size of the chip.
2121
+ */
2122
+ "size"?: IcChipSizes;
2123
+ }
2036
2124
  interface IcClassificationBanner {
2037
2125
  /**
2038
- * Additional information to display after the classification
2126
+ * The additional information that will be displayed after the classification.
2039
2127
  */
2040
2128
  "additionalSelectors"?: string;
2041
2129
  /**
2042
- * The classification level to be displayed also determines the banner and text colour
2130
+ * The classification level to be displayed - also determines the banner and text colour.
2043
2131
  */
2044
2132
  "classification"?: IcProtectiveMarkings;
2045
2133
  /**
2046
- * Optional text displayed before classification to specify relevant country/countries
2134
+ * The optional text that will be displayed before classification to specify relevant country/countries.
2047
2135
  */
2048
2136
  "country"?: string;
2049
2137
  /**
2050
- * Determines whether the banner appears inline with the page or sticks to the bottom of the page
2138
+ * If `true`, the banner will appear inline with the page, instead of sticking to the bottom of the page.
2051
2139
  */
2052
2140
  "inline"?: boolean;
2053
2141
  /**
2054
- * Optionally display "Up to" before classification and country if set
2142
+ * If `true`, "Up to" will be displayed before the classification and country.
2055
2143
  */
2056
2144
  "upTo"?: boolean;
2057
2145
  }
2058
2146
  interface IcDataEntity {
2059
2147
  /**
2060
- * Title for the data entity
2148
+ * The title for the data entity.
2061
2149
  */
2062
2150
  "heading"?: string;
2063
2151
  /**
2064
- * Set the data heading and all child data rows to small styling
2152
+ * If `true`, the small styling will be applied to the data heading and all child data rows.
2065
2153
  */
2066
2154
  "small"?: boolean;
2067
2155
  }
2068
2156
  interface IcDataRow {
2069
2157
  /**
2070
- * Set the label in the leftmost cell of the row
2158
+ * The label in the leftmost cell of the row.
2071
2159
  */
2072
2160
  "label"?: string;
2073
2161
  /**
2074
- * Set the row to small styling, this is automatically applied if small is set on the parent data heading
2162
+ * If `true`, the small styling will be applied to the row. This is automatically applied if small is set on the parent data heading.
2075
2163
  */
2076
2164
  "small"?: boolean;
2077
2165
  /**
2078
- * Set the value of the middle (right if no addition supplied) cell of the row
2166
+ * The value of the middle (right if no end-component supplied) cell of the row.
2079
2167
  */
2080
2168
  "value"?: string;
2081
2169
  }
@@ -2083,33 +2171,29 @@ declare namespace LocalJSX {
2083
2171
  }
2084
2172
  interface IcFooter {
2085
2173
  /**
2086
- * Sets the aligned parameter for the section containers used within the footer
2174
+ * The alignment of the section containers used within the footer.
2087
2175
  */
2088
2176
  "aligned"?: IcAlignment;
2089
2177
  /**
2090
- * Sets the screen size breakpoint at which to switch to the small layout
2178
+ * The screen size breakpoint at which to switch to the small layout.
2091
2179
  */
2092
2180
  "breakpoint"?: IcFooterBreakpoints;
2093
2181
  /**
2094
- * The caption displayed at the bottom of the footer
2182
+ * The caption displayed at the bottom of the footer.
2095
2183
  */
2096
2184
  "caption"?: string;
2097
2185
  /**
2098
- * Whether the footer displays the crown copyright at the bottom
2186
+ * If `true`, the footer will display the crown copyright at the bottom.
2099
2187
  */
2100
2188
  "copyright"?: boolean;
2101
2189
  /**
2102
- * The description displayed at the top of the footer
2190
+ * The description displayed at the top of the footer.
2103
2191
  */
2104
2192
  "description"?: string;
2105
2193
  /**
2106
- * Sets the footer up to handle link groups instead of standalone links
2194
+ * If `true`, the footer will be set up to handle link groups instead of standalone links.
2107
2195
  */
2108
2196
  "groupLinks"?: boolean;
2109
- /**
2110
- * Triggers on page resize and triggers style changes in footer links and link groups
2111
- */
2112
- "onIcFooterResized"?: (event: IcFooterCustomEvent<void>) => void;
2113
2197
  }
2114
2198
  interface IcFooterLink {
2115
2199
  /**
@@ -2119,155 +2203,155 @@ declare namespace LocalJSX {
2119
2203
  }
2120
2204
  interface IcFooterLinkGroup {
2121
2205
  /**
2122
- * Sets the title of the link group for display
2206
+ * The title of the link group to be displayed.
2123
2207
  */
2124
2208
  "groupTitle": string;
2125
2209
  }
2126
2210
  interface IcHero {
2127
2211
  /**
2128
- * The alignment of the hero content
2212
+ * The alignment of the hero.
2129
2213
  */
2130
2214
  "aligned"?: IcAlignment;
2131
2215
  /**
2132
- * Optional background image
2216
+ * The optional background image.
2133
2217
  */
2134
2218
  "backgroundImage"?: string;
2135
2219
  /**
2136
- * The alignment of the hero content
2220
+ * The alignment of the hero content.
2137
2221
  */
2138
2222
  "contentAligned"?: IcHeroContentAlignments;
2139
2223
  /**
2140
- * Whether the background image (if set) scrolls using a parallax effect.
2224
+ * If `true`, the background image (if set) will not scroll using a parallax effect.
2141
2225
  */
2142
2226
  "disableBackgroundParallax"?: boolean;
2143
2227
  /**
2144
- * The heading of the hero
2228
+ * The heading of the hero.
2145
2229
  */
2146
2230
  "heading": string;
2147
2231
  /**
2148
- * Optional secondary heading, replaced by slotted right content
2232
+ * The optional secondary heading, replaced by slotted right content.
2149
2233
  */
2150
2234
  "secondaryHeading"?: string;
2151
2235
  /**
2152
- * Optional secondary subheading, replaced by slotted right content
2236
+ * The optional secondary subheading, replaced by slotted right content.
2153
2237
  */
2154
2238
  "secondarySubheading"?: string;
2155
2239
  /**
2156
- * Alter styling for use with small content/pages
2240
+ * If `true`, the small styling will be applied to the hero.
2157
2241
  */
2158
2242
  "small"?: boolean;
2159
2243
  /**
2160
- * Description for the hero
2244
+ * The description for the hero.
2161
2245
  */
2162
2246
  "subheading"?: string;
2163
2247
  }
2164
2248
  interface IcInputComponentContainer {
2165
2249
  /**
2166
- * Determines whether the dark variant of the input-component-container focus indicator should be displayed.
2250
+ * If `true`, the dark variant of the input component container will be displayed.
2167
2251
  */
2168
2252
  "dark"?: boolean;
2169
2253
  /**
2170
- * disabled
2254
+ * If `true`, the disabled state will be set.
2171
2255
  */
2172
2256
  "disabled"?: boolean;
2173
2257
  /**
2174
- * If true then fill width of container
2258
+ * If `true`, the input component container will fill the width of the container it is in.
2175
2259
  */
2176
2260
  "fullWidth"?: boolean;
2177
2261
  /**
2178
- * multiLine
2262
+ * If `true`, the input component container will allow for multiple lines.
2179
2263
  */
2180
2264
  "multiLine"?: boolean;
2181
2265
  /**
2182
- * readonly
2266
+ * If `true`, the readonly state will be set.
2183
2267
  */
2184
2268
  "readonly"?: boolean;
2185
2269
  /**
2186
- * small
2270
+ * If `true`, the small styling will be applied to the input component container.
2187
2271
  */
2188
2272
  "small"?: boolean;
2189
2273
  /**
2190
- * validationInline
2274
+ * If `true`, the validation will display inline.
2191
2275
  */
2192
2276
  "validationInline"?: boolean;
2193
2277
  /**
2194
- * validationStatus
2278
+ * The validation status of the input component container - e.g. 'error' | 'warning' | 'success'.
2195
2279
  */
2196
2280
  "validationStatus"?: IcInformationStatusOrEmpty;
2197
2281
  }
2198
2282
  interface IcInputContainer {
2199
2283
  /**
2200
- * disabled
2284
+ * If `true`, the disabled state will be set.
2201
2285
  */
2202
2286
  "disabled"?: boolean;
2203
2287
  /**
2204
- * readonly
2288
+ * If `true`, the readonly state will be set.
2205
2289
  */
2206
2290
  "readonly"?: boolean;
2207
2291
  }
2208
2292
  interface IcInputLabel {
2209
2293
  /**
2210
- * dark
2294
+ * If `true`, the dark variant of the input label will be displayed.
2211
2295
  */
2212
2296
  "dark"?: boolean;
2213
2297
  /**
2214
- * disabled
2298
+ * If `true`, the disabled state will be set.
2215
2299
  */
2216
2300
  "disabled"?: boolean;
2217
2301
  /**
2218
- * error
2302
+ * If `true`, the input label will display with error styling.
2219
2303
  */
2220
2304
  "error"?: boolean;
2221
2305
  /**
2222
- * for
2306
+ * The ID of the form element the label is bound to.
2223
2307
  */
2224
2308
  "for"?: string;
2225
2309
  /**
2226
- * helperText
2310
+ * The helper text that will be displayed.
2227
2311
  */
2228
2312
  "helperText"?: string;
2229
2313
  /**
2230
- * label
2314
+ * The text content of the label.
2231
2315
  */
2232
2316
  "label": string;
2233
2317
  /**
2234
- * readonly
2318
+ * If `true`, the readonly state will be set.
2235
2319
  */
2236
2320
  "readonly"?: boolean;
2237
2321
  /**
2238
- * required
2322
+ * If `true`, the input label will require a value.
2239
2323
  */
2240
2324
  "required"?: boolean;
2241
2325
  }
2242
2326
  interface IcInputValidation {
2243
2327
  /**
2244
- * aria live mode to apply to message
2328
+ * The ARIA live mode to apply to the message.
2245
2329
  */
2246
2330
  "ariaLiveMode"?: IcAriaLiveModeVariants;
2247
2331
  /**
2248
- * The id of the input field the message relates to
2332
+ * The ID of the form element the validation is bound to.
2249
2333
  */
2250
2334
  "for"?: string;
2251
2335
  /**
2252
- * If true then fill width of container
2336
+ * If `true`, the input validation will fill the width of the container.
2253
2337
  */
2254
2338
  "fullWidth"?: boolean;
2255
2339
  /**
2256
- * The validation message to display
2340
+ * The validation message to display.
2257
2341
  */
2258
2342
  "message": string;
2259
2343
  /**
2260
- * The status
2344
+ * The status of the validation - e.g. 'error' | 'warning' | 'success'.
2261
2345
  */
2262
2346
  "status"?: IcInformationStatusOrEmpty;
2263
2347
  }
2264
2348
  interface IcLink {
2265
2349
  /**
2266
- * Determines the whether the appearance is dark, light, or the default.
2350
+ * The appearance of the link, e.g. dark, light, or default.
2267
2351
  */
2268
2352
  "appearance"?: IcThemeForeground;
2269
2353
  /**
2270
- * Prompts the user to save the linked URL instead of navigating to it.
2354
+ * If `true`, the user can save the linked URL instead of navigating to it.
2271
2355
  */
2272
2356
  "download"?: string | boolean;
2273
2357
  /**
@@ -2275,7 +2359,7 @@ declare namespace LocalJSX {
2275
2359
  */
2276
2360
  "href"?: string;
2277
2361
  /**
2278
- * Hints at the human language of the linked URL.
2362
+ * The human language of the linked URL.
2279
2363
  */
2280
2364
  "hreflang"?: string;
2281
2365
  /**
@@ -2287,25 +2371,25 @@ declare namespace LocalJSX {
2287
2371
  */
2288
2372
  "rel"?: string;
2289
2373
  /**
2290
- * Determines whether the 'open in new tab/window' icon is to be displayed.
2374
+ * If `true`, the 'open in new tab/window' icon will be displayed.
2291
2375
  */
2292
2376
  "showIcon"?: boolean;
2293
2377
  /**
2294
- * Where to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
2378
+ * The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
2295
2379
  */
2296
2380
  "target"?: string;
2297
2381
  }
2298
2382
  interface IcLoadingIndicator {
2299
2383
  /**
2300
- * Determines whether the dark or light loading indicator should be displayed.
2384
+ * The appearance of the loading indicator, e.g. dark or light.
2301
2385
  */
2302
2386
  "appearance"?: IcThemeForegroundNoDefault;
2303
2387
  /**
2304
- * Provide a description to be set as the aria-label of the loading indicator when not using a visible label.
2388
+ * The description that will be set as the aria-label of the loading indicator when not using a visible label.
2305
2389
  */
2306
2390
  "description"?: string;
2307
2391
  /**
2308
- * When linear, determines whether the full-width version (i.e. without a border radius) should be displayed.
2392
+ * If `true`, when linear, the full-width variant (i.e. without a border radius) will be displayed.
2309
2393
  */
2310
2394
  "fullWidth"?: boolean;
2311
2395
  /**
@@ -2343,47 +2427,43 @@ declare namespace LocalJSX {
2343
2427
  */
2344
2428
  "activationType"?: IcActivationTypes;
2345
2429
  /**
2346
- * Reference to an anchor element the menu will position itself from when rendered.
2430
+ * The reference to an anchor element the menu will position itself from when rendered.
2347
2431
  */
2348
2432
  "anchorEl": HTMLElement;
2349
2433
  /**
2350
- * If true then fill width of container
2434
+ * If `true`, the menu will fill the width of the container.
2351
2435
  */
2352
2436
  "fullWidth"?: boolean;
2353
2437
  /**
2354
- * Reference to the input element.
2438
+ * The reference to the input element.
2355
2439
  */
2356
2440
  "inputEl": HTMLElement;
2357
2441
  /**
2358
- * Label for the input element.
2442
+ * The label for the input element.
2359
2443
  */
2360
2444
  "inputLabel": string;
2361
2445
  /**
2362
- * Id of the menu.
2446
+ * The ID of the menu.
2363
2447
  */
2364
2448
  "menuId": string;
2365
2449
  /**
2366
2450
  * Emitted when state of menu changes (i.e. open or close).
2367
2451
  */
2368
- "onMenuChange"?: (event: IcMenuCustomEvent<IcMenuChangeEventDetail>) => void;
2369
- /**
2370
- * Emitted when an option has been highlighted
2371
- */
2372
- "onMenuOptionId"?: (event: IcMenuCustomEvent<IcMenuOptionIdEventDetail>) => void;
2452
+ "onIcMenuStateChange"?: (event: IcMenuCustomEvent<IcMenuChangeEventDetail>) => void;
2373
2453
  /**
2374
2454
  * Emitted when an option is selected.
2375
2455
  */
2376
- "onOptionSelect"?: (event: IcMenuCustomEvent<IcOptionSelectEventDetail>) => void;
2456
+ "onIcOptionSelect"?: (event: IcMenuCustomEvent<IcOptionSelectEventDetail>) => void;
2377
2457
  /**
2378
- * Specify whether the menu is open.
2458
+ * If `true`, the menu will be displayed open.
2379
2459
  */
2380
2460
  "open": boolean;
2381
2461
  /**
2382
- * Provide the possible selection options.
2462
+ * The possible menu selection options.
2383
2463
  */
2384
2464
  "options": IcMenuOption[];
2385
2465
  /**
2386
- * Specify whether small styling is to be applied to the element.
2466
+ * If `true`, the small styling will be applied to the menu.
2387
2467
  */
2388
2468
  "small"?: boolean;
2389
2469
  /**
@@ -2393,7 +2473,7 @@ declare namespace LocalJSX {
2393
2473
  }
2394
2474
  interface IcNavigationButton {
2395
2475
  /**
2396
- * Prompts the user to save the linked URL instead of navigating to it.
2476
+ * If `true`, the user can save the linked URL instead of navigating to it.
2397
2477
  */
2398
2478
  "download"?: string | boolean;
2399
2479
  /**
@@ -2401,11 +2481,11 @@ declare namespace LocalJSX {
2401
2481
  */
2402
2482
  "href"?: string;
2403
2483
  /**
2404
- * Hints at the human language of the linked URL.
2484
+ * The human language of the linked URL.
2405
2485
  */
2406
2486
  "hreflang"?: string;
2407
2487
  /**
2408
- * label info to display
2488
+ * The label info to display.
2409
2489
  */
2410
2490
  "label": string;
2411
2491
  /**
@@ -2417,97 +2497,97 @@ declare namespace LocalJSX {
2417
2497
  */
2418
2498
  "rel"?: string;
2419
2499
  /**
2420
- * Where to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
2500
+ * The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).
2421
2501
  */
2422
2502
  "target"?: string;
2423
2503
  }
2424
2504
  interface IcNavigationGroup {
2425
2505
  /**
2426
- * whether the group should be expandable/collapsible in the side menu
2506
+ * If `true`, the group will be expandable in the side menu.
2427
2507
  */
2428
2508
  "expandable"?: boolean;
2429
2509
  /**
2430
- * label to display on the group
2510
+ * The label to display on the group.
2431
2511
  */
2432
2512
  "label"?: string;
2433
2513
  }
2434
2514
  interface IcNavigationItem {
2435
2515
  /**
2436
- * Destination of the navigation item
2516
+ * The destination of the navigation item.
2437
2517
  */
2438
2518
  "href"?: string;
2439
2519
  /**
2440
- * Label of the navigation item
2520
+ * The label of the navigation item.
2441
2521
  */
2442
2522
  "label"?: string;
2443
2523
  /**
2444
- * If true, sets the navigation item in a selected state
2524
+ * If `true`, the navigation item will be set in a selected state.
2445
2525
  */
2446
2526
  "selected"?: boolean;
2447
2527
  }
2448
2528
  interface IcNavigationMenu {
2449
2529
  /**
2450
- * Status info to display
2530
+ * The status info to display.
2451
2531
  */
2452
2532
  "status"?: string;
2453
2533
  /**
2454
- * Version info to display
2534
+ * The version info to display.
2455
2535
  */
2456
2536
  "version"?: string;
2457
2537
  }
2458
2538
  interface IcPageHeader {
2459
2539
  /**
2460
- * How the component should be aligned.
2540
+ * The alignment of the page header.
2461
2541
  */
2462
2542
  "aligned"?: IcAlignment;
2463
2543
  /**
2464
- * Set whether the bottom border is used
2544
+ * If `true`, a border will be displayed along the bottom of the page header.
2465
2545
  */
2466
2546
  "border"?: boolean;
2467
2547
  /**
2468
- * The title to render on the component.
2548
+ * The title to render on the page header.
2469
2549
  */
2470
2550
  "heading"?: string;
2471
2551
  /**
2472
- * Set whether the reading pattern and tab order change in the action area for viewport widths of above 576px and when actions have not wrapped
2552
+ * If `true`, the reading pattern and tab order will change in the action area for viewport widths of above 576px and when actions have not wrapped.
2473
2553
  */
2474
2554
  "reverseOrder"?: boolean;
2475
2555
  /**
2476
- * Whether the component uses small styling.
2556
+ * If `true`, the small styling will be applied to the page header.
2477
2557
  */
2478
2558
  "small"?: boolean;
2479
2559
  /**
2480
- * Set whether the header is sticky at all breakpoints
2560
+ * If `true`, the page header will be sticky at all breakpoints.
2481
2561
  */
2482
2562
  "sticky"?: boolean;
2483
2563
  /**
2484
- * Set whether the header is only sticky for viewport widths of 992px and above
2564
+ * If `true`, the page header will only be sticky for viewport widths of 992px and above.
2485
2565
  */
2486
2566
  "stickyDesktopOnly"?: boolean;
2487
2567
  /**
2488
- * The subtitle to render on the component.
2568
+ * The subtitle to render on the page header.
2489
2569
  */
2490
2570
  "subheading"?: string;
2491
2571
  }
2492
2572
  interface IcRadioGroup {
2493
2573
  /**
2494
- * Specify whether the input is disabled.
2574
+ * If `true`, the disabled state will be set.
2495
2575
  */
2496
2576
  "disabled"?: boolean;
2497
2577
  /**
2498
- * Provide helper text to display additional field guidance.
2578
+ * The helper text that will be displayed for additional field guidance.
2499
2579
  */
2500
2580
  "helperText"?: string;
2501
2581
  /**
2502
- * Hides the label and applies the required label value as an aria-label.
2582
+ * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
2503
2583
  */
2504
2584
  "hideLabel"?: boolean;
2505
2585
  /**
2506
- * Provide a label for the input.
2586
+ * The label for the radio group to be displayed.
2507
2587
  */
2508
2588
  "label": string;
2509
2589
  /**
2510
- * Provide a name for the input.
2590
+ * The name for the radio group to differentiate from other groups.
2511
2591
  */
2512
2592
  "name": string;
2513
2593
  /**
@@ -2515,123 +2595,123 @@ declare namespace LocalJSX {
2515
2595
  */
2516
2596
  "onIcChange"?: (event: IcRadioGroupCustomEvent<IcValueEventDetail>) => void;
2517
2597
  /**
2518
- * Specify if the input requires a value.
2598
+ * If `true`, the radio group will require a value.
2519
2599
  */
2520
2600
  "required"?: boolean;
2521
2601
  /**
2522
- * Specify whether small styling is to be applied to the element.
2602
+ * If `true`, the small styling will be applied to the radio group.
2523
2603
  */
2524
2604
  "small"?: boolean;
2525
2605
  /**
2526
- * Provide validation status - 'error'
2606
+ * The validation status - e.g. 'error' | 'warning' | 'success'.
2527
2607
  */
2528
2608
  "validationStatus"?: IcInformationStatusOrEmpty;
2529
2609
  /**
2530
- * Provide validation text - 'error'
2610
+ * The validation text - e.g. 'error' | 'warning' | 'success'.
2531
2611
  */
2532
2612
  "validationText"?: string;
2533
2613
  }
2534
2614
  interface IcRadioOption {
2535
2615
  /**
2536
- * Determines type of additional text field in relation to radio option
2616
+ * The style of additionalField that will be displayed if used.
2537
2617
  */
2538
2618
  "additionalFieldDisplay"?: IcAdditionalFieldTypes;
2539
2619
  /**
2540
- * Determines whether the radio should be in disabled state.
2620
+ * If `true`, the disabled state will be set.
2541
2621
  */
2542
2622
  "disabled"?: boolean;
2543
2623
  /**
2544
- * Provide a text prop for the dynamic text.
2624
+ * The text to be displayed when dynamic.
2545
2625
  */
2546
2626
  "dynamicText"?: string;
2547
2627
  /**
2548
- * Provide a group label for the input.
2628
+ * The group label for the radio option.
2549
2629
  */
2550
2630
  "groupLabel"?: string;
2551
2631
  /**
2552
- * Provide a label for the input.
2632
+ * The label for the radio option.
2553
2633
  */
2554
2634
  "label"?: string;
2555
2635
  /**
2556
- * Provide a name for the input.
2636
+ * The name for the radio option.
2557
2637
  */
2558
2638
  "name"?: string;
2559
2639
  /**
2560
- * Emitted when radio is checked
2640
+ * Emitted when a radio is selected.
2561
2641
  */
2562
- "onIcCheck"?: (event: IcRadioOptionCustomEvent<void>) => void;
2642
+ "onIcCheck"?: (event: IcRadioOptionCustomEvent<IcValueEventDetail>) => void;
2563
2643
  /**
2564
- * Emitted when a radio is selected.
2644
+ * @deprecated This event should not be used anymore. Use icCheck instead.
2565
2645
  */
2566
2646
  "onRadioOptionSelect"?: (event: IcRadioOptionCustomEvent<IcValueEventDetail>) => void;
2567
2647
  /**
2568
- * Determines whether the radio should be in selected state.
2648
+ * If `true`, the radio option will be displayed in a selected state.
2569
2649
  */
2570
2650
  "selected"?: boolean;
2571
2651
  /**
2572
- * Provide a value for the input.
2652
+ * The value for the radio option.
2573
2653
  */
2574
2654
  "value": string;
2575
2655
  }
2576
2656
  interface IcSearchBar {
2577
2657
  /**
2578
- * Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user. Available options: "off", "none", "on", "sentences", "words", "characters".
2658
+ * The automatic capitalisation of the text value as it is entered/edited by the user. Available options: "off", "none", "on", "sentences", "words", "characters".
2579
2659
  */
2580
2660
  "autocapitalize"?: string;
2581
2661
  /**
2582
- * Indicates whether the value of the control can be automatically completed by the browser.
2662
+ * The state of autocompletion the browser can apply on the text value.
2583
2663
  */
2584
2664
  "autocomplete"?: IcAutocompleteTypes;
2585
2665
  /**
2586
- * Whether auto correction should be enabled when the user is entering/editing the text value.
2666
+ * The state of autocorrection the browser can apply when the user is entering/editing the text value.
2587
2667
  */
2588
2668
  "autocorrect"?: IcAutocorrectStates;
2589
2669
  /**
2590
- * This Boolean attribute lets you specify that a form control should have input focus when the page loads.
2670
+ * If `true`, the form control will have input focus when the page loads.
2591
2671
  */
2592
2672
  "autofocus"?: boolean;
2593
2673
  /**
2594
- * Number of characters until suggestions appear
2674
+ * The number of characters until suggestions appear.
2595
2675
  */
2596
2676
  "charactersUntilSuggestion"?: number;
2597
2677
  /**
2598
- * Set the amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.
2678
+ * The amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.
2599
2679
  */
2600
2680
  "debounce"?: number;
2601
2681
  /**
2602
- * Specify whether to disable the built in filtering. For example, if options will already be filtered from external source. If true, all options provided will be displayed.
2682
+ * Specify whether to disable the built in filtering. For example, if options will already be filtered from external source. If `true`, all options provided will be displayed.
2603
2683
  */
2604
2684
  "disableFilter"?: boolean;
2605
2685
  /**
2606
- * Specify whether the input is disabled.
2686
+ * If `true`, the disabled state will be set.
2607
2687
  */
2608
2688
  "disabled"?: boolean;
2609
2689
  /**
2610
- * Provide text for empty results list
2690
+ * The text displayed when there are no options in the option list.
2611
2691
  */
2612
2692
  "emptyOptionListText"?: string;
2613
2693
  /**
2614
- * Specify whether the input should be focussed when component loaded.
2694
+ * If `true`, the search bar will be focused when component loaded.
2615
2695
  */
2616
2696
  "focusOnLoad"?: boolean;
2617
2697
  /**
2618
- * Specify whether the component fills the full width of the container. If true, this overrides the --input-width css prop.
2698
+ * Specify whether the search bar fills the full width of the container. If `true`, this overrides the --input-width CSS variable.
2619
2699
  */
2620
2700
  "fullWidth"?: boolean;
2621
2701
  /**
2622
- * Provide helper text to display additional field guidance.
2702
+ * The helper text that will be displayed for additional field guidance.
2623
2703
  */
2624
2704
  "helperText"?: string;
2625
2705
  /**
2626
- * Hides the label and applies the required label value as an aria-label.
2706
+ * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
2627
2707
  */
2628
2708
  "hideLabel"?: boolean;
2629
2709
  /**
2630
- * Provide hint text for hidden assistive description element.
2710
+ * The hint text for the hidden assistive description element.
2631
2711
  */
2632
2712
  "hintText"?: string;
2633
2713
  /**
2634
- * Provide a label for the input.
2714
+ * The label for the search bar.
2635
2715
  */
2636
2716
  "label": string;
2637
2717
  /**
@@ -2651,11 +2731,11 @@ declare namespace LocalJSX {
2651
2731
  */
2652
2732
  "onIcInput"?: (event: IcSearchBarCustomEvent<IcValueEventDetail>) => void;
2653
2733
  /**
2654
- * Emitted when input loses focus.
2734
+ * @deprecated This event should not be used anymore. Use icSearchBarBlur instead.
2655
2735
  */
2656
2736
  "onIcInputBlur"?: (event: IcSearchBarCustomEvent<IcSearchBarBlurEventDetail>) => void;
2657
2737
  /**
2658
- * Emitted when input gains focus.
2738
+ * @deprecated This event should not be used anymore. Use icSearchBarFocus instead.
2659
2739
  */
2660
2740
  "onIcInputFocus"?: (event: IcSearchBarCustomEvent<IcValueEventDetail>) => void;
2661
2741
  /**
@@ -2679,79 +2759,79 @@ declare namespace LocalJSX {
2679
2759
  */
2680
2760
  "onIcSubmitSearch"?: (event: IcSearchBarCustomEvent<IcValueEventDetail>) => void;
2681
2761
  /**
2682
- * Provide the suggested search options
2762
+ * The suggested search options.
2683
2763
  */
2684
2764
  "options"?: IcMenuOption[];
2685
2765
  /**
2686
- * Provide a placeholder value to display.
2766
+ * The placeholder value to display.
2687
2767
  */
2688
2768
  "placeholder"?: string;
2689
2769
  /**
2690
- * Specify whether the input is read only.
2770
+ * If `true`, the readonly state will be set.
2691
2771
  */
2692
2772
  "readonly"?: boolean;
2693
2773
  /**
2694
- * Specify if the input requires a value.
2774
+ * If `true`, the search bar will require a value.
2695
2775
  */
2696
2776
  "required"?: boolean;
2697
2777
  /**
2698
- * Specify whether small styling is to be applied to the element.
2778
+ * If `true`, the small styling will be applied to the search bar.
2699
2779
  */
2700
2780
  "small"?: boolean;
2701
2781
  /**
2702
- * If `true`, the element will have its spelling and grammar checked.
2782
+ * If `true`, the value of the search will have its spelling and grammar checked.
2703
2783
  */
2704
2784
  "spellcheck"?: boolean;
2705
2785
  /**
2706
- * Value of Search input.
2786
+ * The value of the search input.
2707
2787
  */
2708
2788
  "value"?: string;
2709
2789
  }
2710
2790
  interface IcSectionContainer {
2711
2791
  /**
2712
- * How the container should be aligned.
2792
+ * The alignment of the container.
2713
2793
  */
2714
2794
  "aligned"?: IcAlignment;
2715
2795
  /**
2716
- * Removes the standard vertical padding from the container.
2796
+ * If `true`, the standard vertical padding from the container will be removed.
2717
2797
  */
2718
2798
  "fullHeight"?: boolean;
2719
2799
  }
2720
2800
  interface IcSelect {
2721
2801
  /**
2722
- * Number of characters until suggestions appear for a searchable select.
2802
+ * The number of characters until suggestions appear for a searchable select.
2723
2803
  */
2724
2804
  "charactersUntilSuggestions"?: number;
2725
2805
  /**
2726
- * Specify whether the input is disabled.
2806
+ * If `true`, the disabled state will be set.
2727
2807
  */
2728
2808
  "disabled"?: boolean;
2729
2809
  /**
2730
- * Provide text for empty results list
2810
+ * The text displayed when there are no options in the option list.
2731
2811
  */
2732
2812
  "emptyOptionListText"?: string;
2733
2813
  /**
2734
- * If true, then fill width of container.
2814
+ * If `true`, the select element will fill the width of the container.
2735
2815
  */
2736
2816
  "fullWidth"?: boolean;
2737
2817
  /**
2738
- * Provide helper text to display additional field guidance.
2818
+ * The helper text that will be displayed for additional field guidance.
2739
2819
  */
2740
2820
  "helperText"?: string;
2741
2821
  /**
2742
- * Hides the label and applies the required label value as an aria-label.
2822
+ * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
2743
2823
  */
2744
2824
  "hideLabel"?: boolean;
2745
2825
  /**
2746
- * If true, descriptions of options are included when filtering options in a searchable select.
2826
+ * If `true`, descriptions of options will be included when filtering options in a searchable select.
2747
2827
  */
2748
2828
  "includeDescriptionsInSearch"?: boolean;
2749
2829
  /**
2750
- * If true, group titles of grouped options are included when filtering options in a searchable select.
2830
+ * If `true`, group titles of grouped options will be included when filtering options in a searchable select.
2751
2831
  */
2752
2832
  "includeGroupTitlesInSearch"?: boolean;
2753
2833
  /**
2754
- * Provide a label for the input.
2834
+ * The label for the select.
2755
2835
  */
2756
2836
  "label": string;
2757
2837
  /**
@@ -2771,19 +2851,19 @@ declare namespace LocalJSX {
2771
2851
  */
2772
2852
  "onIcFocus"?: (event: IcSelectCustomEvent<void>) => void;
2773
2853
  /**
2774
- * Provide the possible selection options.
2854
+ * The possible selection options.
2775
2855
  */
2776
2856
  "options"?: IcMenuOption[];
2777
2857
  /**
2778
- * Provide a placeholder value to display.
2858
+ * The placeholder value to be displayed.
2779
2859
  */
2780
2860
  "placeholder"?: string;
2781
2861
  /**
2782
- * Specify whether the input is read only.
2862
+ * If `true`, the readonly state will be set.
2783
2863
  */
2784
2864
  "readonly"?: boolean;
2785
2865
  /**
2786
- * Specify if the input requires a value.
2866
+ * If `true`, the select will require a value.
2787
2867
  */
2788
2868
  "required"?: boolean;
2789
2869
  /**
@@ -2791,23 +2871,23 @@ declare namespace LocalJSX {
2791
2871
  */
2792
2872
  "searchMatchPosition"?: IcSearchMatchPositions;
2793
2873
  /**
2794
- * If true, the select can be typed in to filter options.
2874
+ * If `true`, a searchable variant of the select will be displayed which can be typed in to filter options.
2795
2875
  */
2796
2876
  "searchable"?: boolean;
2797
2877
  /**
2798
- * Display a button which clears the input when clicked. The button will always appear on the searchable select.
2878
+ * If `true`, a button which clears the select input when clicked will be displayed. The button will always appear on the searchable select.
2799
2879
  */
2800
2880
  "showClearButton"?: boolean;
2801
2881
  /**
2802
- * Specify whether small styling is to be applied to the element.
2882
+ * If `true`, the small styling will be applied to the select.
2803
2883
  */
2804
2884
  "small"?: boolean;
2805
2885
  /**
2806
- * Provide a validation status.
2886
+ * The validation status - e.g. 'error' | 'warning' | 'success'.
2807
2887
  */
2808
2888
  "validationStatus"?: IcInformationStatusOrEmpty;
2809
2889
  /**
2810
- * Provide the text to display as the validation message.
2890
+ * The text to display as the validation message.
2811
2891
  */
2812
2892
  "validationText"?: string;
2813
2893
  /**
@@ -2817,49 +2897,45 @@ declare namespace LocalJSX {
2817
2897
  }
2818
2898
  interface IcSideNavigation {
2819
2899
  /**
2820
- * Title to display.
2900
+ * The title of the app to be displayed.
2821
2901
  */
2822
2902
  "appTitle": string;
2823
2903
  /**
2824
- * If true, the icon and label will appear when side navigation is collapsed
2904
+ * If `true`, the icon and label will appear when side navigation is collapsed.
2825
2905
  */
2826
2906
  "collapsedIconLabels"?: boolean;
2827
2907
  /**
2828
- * If true, disable automatic parent wrapper styling
2908
+ * If `true`, automatic parent wrapper styling will be disabled.
2829
2909
  */
2830
2910
  "disableAutoParentStyling"?: boolean;
2831
2911
  /**
2832
- * If true, the ic-side-navigation will load in an expanded state
2912
+ * If `true`, the side navigation will load in an expanded state.
2833
2913
  */
2834
2914
  "expanded"?: boolean;
2835
2915
  /**
2836
- * Set application title link
2916
+ * The URL that the app title link points to.
2837
2917
  */
2838
2918
  "href"?: string;
2839
2919
  /**
2840
- * If true, side navigation will be contained by parent element
2841
- */
2842
- "inline"?: boolean;
2843
- /**
2844
- * If true, the menu expand button is removed (PLEASE NOTE: This takes effect on screen sizes 992px and above)
2920
+ * If `true`, the menu expand button will be removed (PLEASE NOTE: This takes effect on screen sizes 992px and above).
2845
2921
  */
2846
2922
  "static"?: boolean;
2847
2923
  /**
2848
- * Status of application
2924
+ * The status of the app to be displayed.
2849
2925
  */
2850
2926
  "status"?: string;
2851
2927
  /**
2852
- * Version of application
2928
+ * The version of the app to be displayed.
2853
2929
  */
2854
2930
  "version"?: string;
2855
2931
  }
2856
2932
  interface IcSkeleton {
2857
2933
  /**
2858
- * Set the skeleton to the light variant
2934
+ * If `true`, the skeleton will be set to the light variant.
2859
2935
  */
2860
2936
  "light"?: boolean;
2861
2937
  /**
2862
- * The variant of the skeleton that will be displayed
2938
+ * The variant of the skeleton that will be displayed.
2863
2939
  */
2864
2940
  "variant"?: IcSkeletonVariants;
2865
2941
  }
@@ -2873,7 +2949,7 @@ declare namespace LocalJSX {
2873
2949
  */
2874
2950
  "label": string;
2875
2951
  /**
2876
- * The size of the status tag.
2952
+ * If `true`, the small styling will be applied to the status tag.
2877
2953
  */
2878
2954
  "small"?: boolean;
2879
2955
  /**
@@ -2883,47 +2959,59 @@ declare namespace LocalJSX {
2883
2959
  }
2884
2960
  interface IcStep {
2885
2961
  /**
2886
- * Additional information about step
2962
+ * The status of the step. Use this prop to display a status message on the step if it is required or optional.
2963
+ */
2964
+ "stepStatus"?: IcStepStatuses;
2965
+ /**
2966
+ * Additional information about the step. Use this prop to override the default step status messaging displayed when selecting a step type or step status.
2887
2967
  */
2888
2968
  "stepSubtitle"?: string;
2889
2969
  /**
2890
- * Name of step
2970
+ * The title of the step within the stepper.
2891
2971
  */
2892
2972
  "stepTitle"?: string;
2893
2973
  /**
2894
- * State of step
2974
+ * The state of the step within the stepper.
2895
2975
  */
2896
2976
  "stepType"?: IcStepTypes;
2897
2977
  }
2898
2978
  interface IcStepper {
2899
2979
  /**
2900
- * How the stepper should be aligned in its container.
2980
+ * The alignment of the default stepper within its container.
2901
2981
  */
2902
2982
  "aligned"?: IcStepperAlignment;
2903
2983
  /**
2904
2984
  * The length of the connnector between each step in pixels. Minimum length is 100px.
2905
2985
  */
2906
2986
  "connectorWidth"?: number;
2987
+ /**
2988
+ * If `true`, the information about each step, i.e. step title, step subtitle and step status, will be hidden on all default steps. The information about each step will still be visible in the compact variant of the stepper.
2989
+ */
2990
+ "hideStepInfo"?: boolean;
2991
+ /**
2992
+ * The variant of the stepper.
2993
+ */
2994
+ "variant"?: IcStepVariants;
2907
2995
  }
2908
2996
  interface IcSwitch {
2909
2997
  /**
2910
- * If true, the component is checked.
2998
+ * If `true`, the switch will display as checked.
2911
2999
  */
2912
3000
  "checked"?: boolean;
2913
3001
  /**
2914
- * If true, the component is not interactive.
3002
+ * If `true`, the disabled state will be set.
2915
3003
  */
2916
3004
  "disabled"?: boolean;
2917
3005
  /**
2918
- * Provide helper text to display additional field guidance.
3006
+ * The helper text that will be displayed for additional field guidance.
2919
3007
  */
2920
3008
  "helperText"?: string;
2921
3009
  /**
2922
- * Hides the label and applies the required label value as an aria-label.
3010
+ * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
2923
3011
  */
2924
3012
  "hideLabel"?: boolean;
2925
3013
  /**
2926
- * Applies an aria-label to the component, for when no visual 'name' is provided.
3014
+ * The aria-label applied to the switch when no visual 'name' is provided.
2927
3015
  */
2928
3016
  "label": string;
2929
3017
  /**
@@ -2943,11 +3031,11 @@ declare namespace LocalJSX {
2943
3031
  */
2944
3032
  "onIcFocus"?: (event: IcSwitchCustomEvent<void>) => void;
2945
3033
  /**
2946
- * If true, the component will render the On/Off state text.
3034
+ * If `true`, the switch will render the On/Off state text.
2947
3035
  */
2948
3036
  "showState"?: boolean;
2949
3037
  /**
2950
- * If true, the component reduces in size to the small state.
3038
+ * If `true`, the small styling will be applied to the switch.
2951
3039
  */
2952
3040
  "small"?: boolean;
2953
3041
  /**
@@ -2957,13 +3045,9 @@ declare namespace LocalJSX {
2957
3045
  }
2958
3046
  interface IcTab {
2959
3047
  /**
2960
- * Disables the tab.
3048
+ * If `true`, the disabled state will be set.
2961
3049
  */
2962
3050
  "disabled"?: boolean;
2963
- /**
2964
- * Called when a tab is selected.
2965
- */
2966
- "onTabClick"?: (event: IcTabCustomEvent<IcTabClickEventDetail>) => void;
2967
3051
  }
2968
3052
  interface IcTabContext {
2969
3053
  /**
@@ -2971,81 +3055,85 @@ declare namespace LocalJSX {
2971
3055
  */
2972
3056
  "activationType"?: IcActivationTypes;
2973
3057
  /**
2974
- * Determines whether the light or dark variant of the tabs should be displayed.
3058
+ * The appearance of the tab context, e.g dark, or light.
2975
3059
  */
2976
3060
  "appearance"?: IcThemeForegroundNoDefault;
2977
3061
  /**
2978
- * Provide a unique context if using multiple tabs inside one another i.e. rendering another set of tabs inside a tab panel.
3062
+ * The unique context needed if using multiple tabs inside one another i.e. rendering another set of tabs inside a tab panel.
2979
3063
  */
2980
3064
  "contextId"?: string;
2981
3065
  /**
2982
3066
  * Emitted when a user selects a tab.
2983
3067
  */
3068
+ "onIcTabSelect"?: (event: IcTabContextCustomEvent<IcTabSelectEventDetail>) => void;
3069
+ /**
3070
+ * @deprecated This event should not be used anymore. Use icTabSelect instead.
3071
+ */
2984
3072
  "onTabSelect"?: (event: IcTabContextCustomEvent<IcTabSelectEventDetail>) => void;
2985
3073
  /**
2986
- * Allows the user to control the selected tab. Must be used alongside the tabSelect event to manage tab selection.
3074
+ * The selected tab to be controlled by the user. Must be used alongside the icTabSelect event to manage tab selection.
2987
3075
  */
2988
3076
  "selectedTabIndex"?: number;
2989
3077
  }
2990
3078
  interface IcTabGroup {
2991
3079
  /**
2992
- * Provide a unique context if using multiple tabs inside one another i.e. rendering another set of tabs inside a tab panel.
3080
+ * The unique context needed if using multiple tabs inside one another i.e. rendering another set of tabs inside a tab panel.
2993
3081
  */
2994
3082
  "contextId"?: string;
2995
3083
  /**
2996
- * Use when tabs and tab panels are to be positioned separately.
3084
+ * If `true`, the tabs and tab panels will be positioned separately.
2997
3085
  */
2998
3086
  "inline"?: boolean;
2999
3087
  /**
3000
- * Provide a label to describe the purpose of the set of tabs to screen reader users.
3088
+ * The label to describe the purpose of the set of tabs to screen reader users.
3001
3089
  */
3002
3090
  "label": string;
3003
3091
  }
3004
3092
  interface IcTabPanel {
3005
3093
  /**
3006
- * Provide a unique context if using multiple tabs inside one another i.e. rendering another tabs inside a tab panel.
3094
+ * The unique context needed if using multiple tabs inside one another i.e. rendering another tabs inside a tab panel.
3007
3095
  */
3008
3096
  "contextId"?: string;
3009
3097
  }
3010
3098
  interface IcTextField {
3011
3099
  /**
3012
- * This Boolean attribute lets you specify that a form control should have input focus when the page loads.
3100
+ * If `true`, the form control will have input focus when the page loads.
3013
3101
  */
3014
3102
  "autoFocus"?: boolean;
3015
3103
  /**
3016
- * Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user. Available options: "off", "none", "on", "sentences", "words", "characters".
3104
+ * The automatic capitalisation of the text value as it is entered/edited by the user. Available options: "off", "none", "on", "sentences", "words", "characters".
3017
3105
  */
3018
3106
  "autocapitalize"?: string;
3019
3107
  /**
3020
- * Indicates whether the value of the control can be automatically completed by the browser.
3108
+ * The state of autocompletion the browser can apply on the text value.
3021
3109
  */
3022
3110
  "autocomplete"?: IcAutocompleteTypes1;
3023
3111
  /**
3024
- * Whether auto correction should be enabled when the user is entering/editing the text value.
3112
+ * The state of autocorrection the browser can apply when the user is entering/editing the text value.
3025
3113
  */
3026
3114
  "autocorrect"?: IcAutocorrectStates1;
3027
3115
  /**
3028
- * Set the amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.
3116
+ * The amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.
3029
3117
  */
3030
3118
  "debounce"?: number;
3031
3119
  /**
3032
- * Specify whether the input is disabled.
3120
+ * If `true`, the disabled state will be set.
3033
3121
  */
3034
3122
  "disabled"?: boolean;
3035
3123
  /**
3036
- * Specify whether the component fills the full width of the container. If true, this overrides the --input-width css prop.
3124
+ * Specify whether the text field fills the full width of the container. If `true`, this overrides the --input-width CSS variable.
3037
3125
  */
3038
3126
  "fullWidth"?: boolean;
3039
3127
  /**
3040
- * Provide helper text to display additional field guidance.
3128
+ * The helper text that will be displayed for additional field guidance.
3041
3129
  */
3042
3130
  "helperText"?: string;
3043
3131
  /**
3044
- * Hides the label and applies the required label value as an aria-label.
3132
+ * If `true`, the label will be hidden and the required label value will be applied as an aria-label.
3045
3133
  */
3046
3134
  "hideLabel"?: boolean;
3047
3135
  /**
3048
- * Provide an id for the input
3136
+ * The ID for the input.
3049
3137
  */
3050
3138
  "inputId"?: string;
3051
3139
  /**
@@ -3053,11 +3141,11 @@ declare namespace LocalJSX {
3053
3141
  */
3054
3142
  "inputmode"?: IcTextFieldInputModes;
3055
3143
  /**
3056
- * Provide a label for the input.
3144
+ * The label for the input.
3057
3145
  */
3058
3146
  "label": string;
3059
3147
  /**
3060
- * Maximum number of characters that can be entered in the field.
3148
+ * The maximum number of characters that can be entered in the field.
3061
3149
  */
3062
3150
  "maxLength"?: number;
3063
3151
  /**
@@ -3085,31 +3173,31 @@ declare namespace LocalJSX {
3085
3173
  */
3086
3174
  "onIcKeydown"?: (event: IcTextFieldCustomEvent<{ event: KeyboardEvent }>) => void;
3087
3175
  /**
3088
- * Provide a placeholder value to display.
3176
+ * The placeholder value to be displayed.
3089
3177
  */
3090
3178
  "placeholder"?: string;
3091
3179
  /**
3092
- * Specify whether the input is read only.
3180
+ * If `true`, the read only state will be set.
3093
3181
  */
3094
3182
  "readonly"?: boolean;
3095
3183
  /**
3096
- * Specify if the input requires a value.
3184
+ * If `true`, the input will require a value.
3097
3185
  */
3098
3186
  "required"?: boolean;
3099
3187
  /**
3100
- * Allow resizing of a multiline text area
3188
+ * If `true`, the multiline text area will be resizeable.
3101
3189
  */
3102
3190
  "resize"?: boolean;
3103
3191
  /**
3104
- * Specify the number of rows to transform the text field into a text area with a specific height.
3192
+ * The number of rows to transform the text field into a text area with a specific height.
3105
3193
  */
3106
3194
  "rows"?: number;
3107
3195
  /**
3108
- * Specify whether small styling is to be applied to the element.
3196
+ * If `true`, the small styling will be applied to the text field.
3109
3197
  */
3110
3198
  "small"?: boolean;
3111
3199
  /**
3112
- * If `true`, the element will have its spelling and grammar checked.
3200
+ * If `true`, the value of the text field will have its spelling and grammar checked.
3113
3201
  */
3114
3202
  "spellcheck"?: boolean;
3115
3203
  /**
@@ -3117,33 +3205,33 @@ declare namespace LocalJSX {
3117
3205
  */
3118
3206
  "type"?: IcTextFieldTypes;
3119
3207
  /**
3120
- * Show icon in input control - only applies when validationStatus ='success'
3208
+ * If `true`, the icon in input control will be displayed - only applies when validationStatus ='success'.
3121
3209
  */
3122
3210
  "validationInline"?: boolean;
3123
3211
  /**
3124
- * Provide validation state - 'error' | 'warning' | 'success'
3212
+ * The validation state - e.g. 'error' | 'warning' | 'success'.
3125
3213
  */
3126
3214
  "validationStatus"?: IcInformationStatusOrEmpty1;
3127
3215
  /**
3128
- * Provide validation state - 'error' | 'warning' | 'success'
3216
+ * The validation state - e.g. 'error' | 'warning' | 'success'.
3129
3217
  */
3130
3218
  "validationText"?: string;
3131
3219
  /**
3132
- * Value of TextField.
3220
+ * The value of the text field.
3133
3221
  */
3134
3222
  "value"?: string;
3135
3223
  }
3136
3224
  interface IcTheme {
3137
3225
  /**
3138
- * The theme colour. Can be a hex value eg "#ff0000" or RGB eg "rgb(255, 0, 0)"
3226
+ * The theme colour. Can be a hex value e.g. "#ff0000", RGB e.g. "rgb(255, 0, 0)", or RGBA e.g. "rgba(255, 0, 0, 1)".
3139
3227
  */
3140
3228
  "color"?: string;
3141
- /**
3142
- * Emitted when the theme is changed.
3143
- */
3144
- "onIcThemeChange"?: (event: IcThemeCustomEvent<IcTheme>) => void;
3145
3229
  }
3146
3230
  interface IcTooltip {
3231
+ /**
3232
+ * If `true`, the tooltip will not be displayed on hover, it will require a click.
3233
+ */
3234
+ "disableHover"?: boolean;
3147
3235
  /**
3148
3236
  * The text to display on the tooltip.
3149
3237
  */
@@ -3159,33 +3247,33 @@ declare namespace LocalJSX {
3159
3247
  }
3160
3248
  interface IcTopNavigation {
3161
3249
  /**
3162
- * Title to display
3250
+ * The app title to be displayed.
3163
3251
  */
3164
3252
  "appTitle": string;
3165
3253
  /**
3166
- * The alignment of the top nav content
3254
+ * The alignment of the top navigation content.
3167
3255
  */
3168
3256
  "contentAligned"?: IcAlignment;
3169
3257
  /**
3170
- * The url to navigate to when title is clicked
3258
+ * The URL to navigate to when the app title is clicked.
3171
3259
  */
3172
3260
  "href"?: string;
3173
3261
  /**
3174
- * If true, the flyout navigation menu on small devices will be contained by the parent element
3262
+ * If `true`, the flyout navigation menu on small devices will be contained by the parent element.
3175
3263
  */
3176
3264
  "inline"?: boolean;
3177
3265
  /**
3178
- * Status info to display
3266
+ * The status info to be displayed.
3179
3267
  */
3180
3268
  "status"?: string;
3181
3269
  /**
3182
- * Version info to display
3270
+ * The version info to be displayed.
3183
3271
  */
3184
3272
  "version"?: string;
3185
3273
  }
3186
3274
  interface IcTypography {
3187
3275
  /**
3188
- * Adds appropriate margins to the top and bottom of the typography.
3276
+ * If `true`, appropriate top and bottom margins will be applied to the typography.
3189
3277
  */
3190
3278
  "applyVerticalMargins"?: boolean;
3191
3279
  /**
@@ -3202,6 +3290,7 @@ declare namespace LocalJSX {
3202
3290
  "ic-card": IcCard;
3203
3291
  "ic-checkbox": IcCheckbox;
3204
3292
  "ic-checkbox-group": IcCheckboxGroup;
3293
+ "ic-chip": IcChip;
3205
3294
  "ic-classification-banner": IcClassificationBanner;
3206
3295
  "ic-data-entity": IcDataEntity;
3207
3296
  "ic-data-row": IcDataRow;
@@ -3256,6 +3345,7 @@ declare module "@stencil/core" {
3256
3345
  "ic-card": LocalJSX.IcCard & JSXBase.HTMLAttributes<HTMLIcCardElement>;
3257
3346
  "ic-checkbox": LocalJSX.IcCheckbox & JSXBase.HTMLAttributes<HTMLIcCheckboxElement>;
3258
3347
  "ic-checkbox-group": LocalJSX.IcCheckboxGroup & JSXBase.HTMLAttributes<HTMLIcCheckboxGroupElement>;
3348
+ "ic-chip": LocalJSX.IcChip & JSXBase.HTMLAttributes<HTMLIcChipElement>;
3259
3349
  "ic-classification-banner": LocalJSX.IcClassificationBanner & JSXBase.HTMLAttributes<HTMLIcClassificationBannerElement>;
3260
3350
  "ic-data-entity": LocalJSX.IcDataEntity & JSXBase.HTMLAttributes<HTMLIcDataEntityElement>;
3261
3351
  "ic-data-row": LocalJSX.IcDataRow & JSXBase.HTMLAttributes<HTMLIcDataRowElement>;