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

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