@ukic/canary-docs 3.0.0-canary.2 → 3.0.0-canary.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/docs.json +461 -1640
  2. package/package.json +2 -2
package/docs.json CHANGED
@@ -305,6 +305,43 @@
305
305
  ],
306
306
  "optional": true,
307
307
  "required": false
308
+ },
309
+ {
310
+ "name": "theme",
311
+ "type": "\"dark\" | \"inherit\" | \"light\"",
312
+ "complexType": {
313
+ "original": "IcThemeMode",
314
+ "resolved": "\"dark\" | \"inherit\" | \"light\"",
315
+ "references": {
316
+ "IcThemeMode": {
317
+ "location": "import",
318
+ "path": "../../utils/types",
319
+ "id": "src/utils/types.ts::IcThemeMode"
320
+ }
321
+ }
322
+ },
323
+ "mutable": false,
324
+ "attr": "theme",
325
+ "reflectToAttr": false,
326
+ "docs": "Sets the theme color to the dark or light theme color. \"inherit\" will set the color based on the system settings or ic-theme component.",
327
+ "docsTags": [],
328
+ "default": "\"inherit\"",
329
+ "values": [
330
+ {
331
+ "value": "dark",
332
+ "type": "string"
333
+ },
334
+ {
335
+ "value": "inherit",
336
+ "type": "string"
337
+ },
338
+ {
339
+ "value": "light",
340
+ "type": "string"
341
+ }
342
+ ],
343
+ "optional": true,
344
+ "required": false
308
345
  }
309
346
  ],
310
347
  "methods": [
@@ -436,6 +473,28 @@
436
473
  "optional": false,
437
474
  "required": true
438
475
  },
476
+ {
477
+ "name": "columnHeaderTruncation",
478
+ "type": "boolean",
479
+ "complexType": {
480
+ "original": "boolean",
481
+ "resolved": "boolean",
482
+ "references": {}
483
+ },
484
+ "mutable": false,
485
+ "attr": "column-header-truncation",
486
+ "reflectToAttr": false,
487
+ "docs": "Determines whether the column header should be truncated and display a tooltip. Default is `false`.",
488
+ "docsTags": [],
489
+ "default": "false",
490
+ "values": [
491
+ {
492
+ "type": "boolean"
493
+ }
494
+ ],
495
+ "optional": false,
496
+ "required": false
497
+ },
439
498
  {
440
499
  "name": "columns",
441
500
  "type": "IcDataTableColumnObject[]",
@@ -752,7 +811,7 @@
752
811
  "reflectToAttr": false,
753
812
  "docs": "Sets the props for the built-in pagination bar. If the `pagination-bar` slot is used then this prop is ignored.",
754
813
  "docsTags": [],
755
- "default": "{\n itemsPerPageOptions: [\n { label: \"10\", value: \"10\" },\n { label: \"25\", value: \"25\" },\n { label: \"50\", value: \"50\" },\n ],\n rangeLabelType: \"page\",\n type: \"simple\",\n showItemsPerPageControl: true,\n showGoToPageControl: true,\n alignment: \"right\",\n appearance: \"default\",\n itemLabel: \"Item\",\n pageLabel: \"Page\",\n hideRangeLabel: false,\n }",
814
+ "default": "{\n itemsPerPageOptions: [\n { label: \"10\", value: \"10\" },\n { label: \"25\", value: \"25\" },\n { label: \"50\", value: \"50\" },\n ],\n rangeLabelType: \"page\",\n type: \"simple\",\n showItemsPerPageControl: true,\n showGoToPageControl: true,\n alignment: \"right\",\n itemLabel: \"Item\",\n pageLabel: \"Page\",\n hideRangeLabel: false,\n hideAllFromItemsPerPage: false,\n theme: \"inherit\",\n monochrome: false,\n }",
756
815
  "values": [
757
816
  {
758
817
  "type": "IcPaginationBarOptions"
@@ -1160,8 +1219,8 @@
1160
1219
  "ic-loading-indicator",
1161
1220
  "ic-typography",
1162
1221
  "ic-link",
1163
- "ic-button",
1164
1222
  "ic-tooltip",
1223
+ "ic-button",
1165
1224
  "ic-empty-state",
1166
1225
  "ic-pagination-bar"
1167
1226
  ],
@@ -1170,21 +1229,21 @@
1170
1229
  "ic-loading-indicator",
1171
1230
  "ic-typography",
1172
1231
  "ic-link",
1173
- "ic-button",
1174
1232
  "ic-tooltip",
1233
+ "ic-button",
1175
1234
  "ic-empty-state",
1176
1235
  "ic-pagination-bar"
1177
1236
  ],
1178
1237
  "ic-loading-indicator": [
1179
1238
  "ic-typography"
1180
1239
  ],
1240
+ "ic-tooltip": [
1241
+ "ic-typography"
1242
+ ],
1181
1243
  "ic-button": [
1182
1244
  "ic-loading-indicator",
1183
1245
  "ic-tooltip"
1184
1246
  ],
1185
- "ic-tooltip": [
1186
- "ic-typography"
1187
- ],
1188
1247
  "ic-empty-state": [
1189
1248
  "ic-typography"
1190
1249
  ],
@@ -1679,6 +1738,28 @@
1679
1738
  "optional": false,
1680
1739
  "required": false
1681
1740
  },
1741
+ {
1742
+ "name": "hideLabel",
1743
+ "type": "boolean",
1744
+ "complexType": {
1745
+ "original": "boolean",
1746
+ "resolved": "boolean",
1747
+ "references": {}
1748
+ },
1749
+ "mutable": false,
1750
+ "attr": "hide-label",
1751
+ "reflectToAttr": false,
1752
+ "docs": "If `true`, the label will be visually hidden, but will still be read out by screen readers.",
1753
+ "docsTags": [],
1754
+ "default": "false",
1755
+ "values": [
1756
+ {
1757
+ "type": "boolean"
1758
+ }
1759
+ ],
1760
+ "optional": true,
1761
+ "required": false
1762
+ },
1682
1763
  {
1683
1764
  "name": "inputId",
1684
1765
  "type": "string",
@@ -2383,6 +2464,28 @@
2383
2464
  "optional": false,
2384
2465
  "required": false
2385
2466
  },
2467
+ {
2468
+ "name": "hideLabel",
2469
+ "type": "boolean",
2470
+ "complexType": {
2471
+ "original": "boolean",
2472
+ "resolved": "boolean",
2473
+ "references": {}
2474
+ },
2475
+ "mutable": false,
2476
+ "attr": "hide-label",
2477
+ "reflectToAttr": false,
2478
+ "docs": "If `true`, the label will be visually hidden, but the required label will still be read out by screen readers.",
2479
+ "docsTags": [],
2480
+ "default": "false",
2481
+ "values": [
2482
+ {
2483
+ "type": "boolean"
2484
+ }
2485
+ ],
2486
+ "optional": true,
2487
+ "required": false
2488
+ },
2386
2489
  {
2387
2490
  "name": "inputId",
2388
2491
  "type": "string",
@@ -2909,41 +3012,45 @@
2909
3012
  }
2910
3013
  },
2911
3014
  {
2912
- "filePath": "src/components/ic-menu-with-multi/ic-menu.tsx",
2913
- "encapsulation": "scoped",
2914
- "tag": "ic-menu-with-multi",
2915
- "readme": "# ic-menu-with-multi\r\n\r\n\r\n\r",
3015
+ "filePath": "src/components/ic-pagination-bar/ic-pagination-bar.tsx",
3016
+ "encapsulation": "shadow",
3017
+ "tag": "ic-pagination-bar",
3018
+ "readme": "# ic-pagination-bar\r\n\r\n\r\n\r",
2916
3019
  "docs": "",
2917
3020
  "docsTags": [],
2918
3021
  "usage": {},
2919
3022
  "props": [
2920
3023
  {
2921
- "name": "activationType",
2922
- "type": "\"automatic\" | \"manual\"",
3024
+ "name": "alignment",
3025
+ "type": "\"left\" | \"right\" | \"space-between\"",
2923
3026
  "complexType": {
2924
- "original": "IcActivationTypes",
2925
- "resolved": "\"automatic\" | \"manual\"",
3027
+ "original": "IcPaginationAlignmentOptions",
3028
+ "resolved": "\"left\" | \"right\" | \"space-between\"",
2926
3029
  "references": {
2927
- "IcActivationTypes": {
3030
+ "IcPaginationAlignmentOptions": {
2928
3031
  "location": "import",
2929
- "path": "@ukic/web-components/dist/types/utils/types",
2930
- "id": "../web-components/dist/types/utils/types.d.ts::IcActivationTypes"
3032
+ "path": "@ukic/web-components/dist/types/components/ic-pagination/ic-pagination.types",
3033
+ "id": "../web-components/dist/types/components/ic-pagination/ic-pagination.types.d.ts::IcPaginationAlignmentOptions"
2931
3034
  }
2932
3035
  }
2933
3036
  },
2934
3037
  "mutable": false,
2935
- "attr": "activation-type",
3038
+ "attr": "alignment",
2936
3039
  "reflectToAttr": false,
2937
- "docs": "Determines whether options manually set as values (by pressing 'Enter') when they receive focus using keyboard navigation.",
3040
+ "docs": "Sets the alignment of the items in the pagination bar.",
2938
3041
  "docsTags": [],
2939
- "default": "\"automatic\"",
3042
+ "default": "\"right\"",
2940
3043
  "values": [
2941
3044
  {
2942
- "value": "automatic",
3045
+ "value": "left",
3046
+ "type": "string"
3047
+ },
3048
+ {
3049
+ "value": "right",
2943
3050
  "type": "string"
2944
3051
  },
2945
3052
  {
2946
- "value": "manual",
3053
+ "value": "space-between",
2947
3054
  "type": "string"
2948
3055
  }
2949
3056
  ],
@@ -2951,32 +3058,29 @@
2951
3058
  "required": false
2952
3059
  },
2953
3060
  {
2954
- "name": "anchorEl",
2955
- "type": "HTMLElement",
3061
+ "name": "currentPage",
3062
+ "type": "number",
2956
3063
  "complexType": {
2957
- "original": "HTMLElement",
2958
- "resolved": "HTMLElement",
2959
- "references": {
2960
- "HTMLElement": {
2961
- "location": "global",
2962
- "id": "global::HTMLElement"
2963
- }
2964
- }
3064
+ "original": "number",
3065
+ "resolved": "number",
3066
+ "references": {}
2965
3067
  },
2966
3068
  "mutable": false,
3069
+ "attr": "current-page",
2967
3070
  "reflectToAttr": false,
2968
- "docs": "The reference to an anchor element the menu will position itself from when rendered.",
3071
+ "docs": "The current page number to be displayed on the pagination bar.",
2969
3072
  "docsTags": [],
3073
+ "default": "1",
2970
3074
  "values": [
2971
3075
  {
2972
- "type": "HTMLElement"
3076
+ "type": "number"
2973
3077
  }
2974
3078
  ],
2975
- "optional": false,
2976
- "required": true
3079
+ "optional": true,
3080
+ "required": false
2977
3081
  },
2978
3082
  {
2979
- "name": "closeOnSelect",
3083
+ "name": "hideAllFromItemsPerPage",
2980
3084
  "type": "boolean",
2981
3085
  "complexType": {
2982
3086
  "original": "boolean",
@@ -2984,21 +3088,21 @@
2984
3088
  "references": {}
2985
3089
  },
2986
3090
  "mutable": false,
2987
- "attr": "close-on-select",
3091
+ "attr": "hide-all-from-items-per-page",
2988
3092
  "reflectToAttr": false,
2989
- "docs": "If `true`, the menu will close when an option is selected.",
3093
+ "docs": "If `true`, the 'All' option will be hidden from the 'items per page' select input.",
2990
3094
  "docsTags": [],
2991
- "default": "true",
3095
+ "default": "false",
2992
3096
  "values": [
2993
3097
  {
2994
3098
  "type": "boolean"
2995
3099
  }
2996
3100
  ],
2997
- "optional": false,
3101
+ "optional": true,
2998
3102
  "required": false
2999
3103
  },
3000
3104
  {
3001
- "name": "fullWidth",
3105
+ "name": "hideRangeLabel",
3002
3106
  "type": "boolean",
3003
3107
  "complexType": {
3004
3108
  "original": "boolean",
@@ -3006,9 +3110,9 @@
3006
3110
  "references": {}
3007
3111
  },
3008
3112
  "mutable": false,
3009
- "attr": "full-width",
3113
+ "attr": "hide-range-label",
3010
3114
  "reflectToAttr": false,
3011
- "docs": "If `true`, the menu will fill the width of the container.",
3115
+ "docs": "If `true`, the number of total items and current item range or number of total pages and current page will be hidden.",
3012
3116
  "docsTags": [],
3013
3117
  "default": "false",
3014
3118
  "values": [
@@ -3016,57 +3120,75 @@
3016
3120
  "type": "boolean"
3017
3121
  }
3018
3122
  ],
3019
- "optional": false,
3123
+ "optional": true,
3020
3124
  "required": false
3021
3125
  },
3022
3126
  {
3023
- "name": "inputEl",
3024
- "type": "HTMLElement",
3127
+ "name": "itemLabel",
3128
+ "type": "string",
3025
3129
  "complexType": {
3026
- "original": "HTMLElement",
3027
- "resolved": "HTMLElement",
3028
- "references": {
3029
- "HTMLElement": {
3030
- "location": "global",
3031
- "id": "global::HTMLElement"
3032
- }
3130
+ "original": "string",
3131
+ "resolved": "string",
3132
+ "references": {}
3133
+ },
3134
+ "mutable": false,
3135
+ "attr": "item-label",
3136
+ "reflectToAttr": false,
3137
+ "docs": "The text which will be used in place of 'Item' on the pagination bar.",
3138
+ "docsTags": [],
3139
+ "default": "\"Item\"",
3140
+ "values": [
3141
+ {
3142
+ "type": "string"
3033
3143
  }
3144
+ ],
3145
+ "optional": true,
3146
+ "required": false
3147
+ },
3148
+ {
3149
+ "name": "itemsPerPageOptions",
3150
+ "type": "{ label: string; value: string; }[]",
3151
+ "complexType": {
3152
+ "original": "{\n label: string;\n value: string;\n }[]",
3153
+ "resolved": "{ label: string; value: string; }[]",
3154
+ "references": {}
3034
3155
  },
3035
3156
  "mutable": false,
3036
3157
  "reflectToAttr": false,
3037
- "docs": "The reference to the input element.",
3158
+ "docs": "The options which will be displayed for 'items per page' select input.",
3038
3159
  "docsTags": [],
3039
3160
  "values": [
3040
3161
  {
3041
- "type": "HTMLElement"
3162
+ "type": "{ label: string; value: string; }[]"
3042
3163
  }
3043
3164
  ],
3044
- "optional": false,
3045
- "required": true
3165
+ "optional": true,
3166
+ "required": false
3046
3167
  },
3047
3168
  {
3048
- "name": "inputLabel",
3049
- "type": "string",
3169
+ "name": "monochrome",
3170
+ "type": "boolean",
3050
3171
  "complexType": {
3051
- "original": "string",
3052
- "resolved": "string",
3172
+ "original": "boolean",
3173
+ "resolved": "boolean",
3053
3174
  "references": {}
3054
3175
  },
3055
3176
  "mutable": false,
3056
- "attr": "input-label",
3177
+ "attr": "monochrome",
3057
3178
  "reflectToAttr": false,
3058
- "docs": "The label for the input element.",
3179
+ "docs": "If `true`, the pagination bar will display as black in the light theme, and white in dark theme.",
3059
3180
  "docsTags": [],
3181
+ "default": "false",
3060
3182
  "values": [
3061
3183
  {
3062
- "type": "string"
3184
+ "type": "boolean"
3063
3185
  }
3064
3186
  ],
3065
- "optional": false,
3066
- "required": true
3187
+ "optional": true,
3188
+ "required": false
3067
3189
  },
3068
3190
  {
3069
- "name": "labelField",
3191
+ "name": "pageLabel",
3070
3192
  "type": "string",
3071
3193
  "complexType": {
3072
3194
  "original": "string",
@@ -3074,42 +3196,54 @@
3074
3196
  "references": {}
3075
3197
  },
3076
3198
  "mutable": false,
3077
- "attr": "label-field",
3199
+ "attr": "page-label",
3078
3200
  "reflectToAttr": false,
3079
- "docs": "The custom name for the label field for IcMenuOption.",
3201
+ "docs": "The text which will be used in place of 'Page' on the pagination bar.",
3080
3202
  "docsTags": [],
3081
- "default": "\"label\"",
3203
+ "default": "\"Page\"",
3082
3204
  "values": [
3083
3205
  {
3084
3206
  "type": "string"
3085
3207
  }
3086
3208
  ],
3087
- "optional": false,
3209
+ "optional": true,
3088
3210
  "required": false
3089
3211
  },
3090
3212
  {
3091
- "name": "menuId",
3092
- "type": "string",
3213
+ "name": "rangeLabelType",
3214
+ "type": "\"data\" | \"page\"",
3093
3215
  "complexType": {
3094
- "original": "string",
3095
- "resolved": "string",
3096
- "references": {}
3216
+ "original": "IcPaginationLabelTypes",
3217
+ "resolved": "\"data\" | \"page\"",
3218
+ "references": {
3219
+ "IcPaginationLabelTypes": {
3220
+ "location": "import",
3221
+ "path": "@ukic/web-components/dist/types/components/ic-pagination/ic-pagination.types",
3222
+ "id": "../web-components/dist/types/components/ic-pagination/ic-pagination.types.d.ts::IcPaginationLabelTypes"
3223
+ }
3224
+ }
3097
3225
  },
3098
3226
  "mutable": false,
3099
- "attr": "menu-id",
3227
+ "attr": "range-label-type",
3100
3228
  "reflectToAttr": false,
3101
- "docs": "The ID of the menu.",
3229
+ "docs": "Whether total number of items and current item range or total number of pages and current page is displayed.",
3102
3230
  "docsTags": [],
3231
+ "default": "\"page\"",
3103
3232
  "values": [
3104
3233
  {
3234
+ "value": "data",
3235
+ "type": "string"
3236
+ },
3237
+ {
3238
+ "value": "page",
3105
3239
  "type": "string"
3106
3240
  }
3107
3241
  ],
3108
- "optional": false,
3109
- "required": true
3242
+ "optional": true,
3243
+ "required": false
3110
3244
  },
3111
3245
  {
3112
- "name": "open",
3246
+ "name": "showGoToPageControl",
3113
3247
  "type": "boolean",
3114
3248
  "complexType": {
3115
3249
  "original": "boolean",
@@ -3117,319 +3251,68 @@
3117
3251
  "references": {}
3118
3252
  },
3119
3253
  "mutable": false,
3120
- "attr": "open",
3121
- "reflectToAttr": true,
3122
- "docs": "If `true`, the menu will be displayed open.",
3254
+ "attr": "show-go-to-page-control",
3255
+ "reflectToAttr": false,
3256
+ "docs": "If `true`, the 'go to page' control should be displayed.",
3123
3257
  "docsTags": [],
3258
+ "default": "false",
3124
3259
  "values": [
3125
3260
  {
3126
3261
  "type": "boolean"
3127
3262
  }
3128
3263
  ],
3129
- "optional": false,
3130
- "required": true
3264
+ "optional": true,
3265
+ "required": false
3131
3266
  },
3132
3267
  {
3133
- "name": "options",
3134
- "type": "IcMenuOption[]",
3268
+ "name": "showItemsPerPageControl",
3269
+ "type": "boolean",
3135
3270
  "complexType": {
3136
- "original": "IcMenuOption[]",
3137
- "resolved": "IcMenuOption[]",
3138
- "references": {
3139
- "IcMenuOption": {
3140
- "location": "import",
3141
- "path": "@ukic/web-components/dist/types/utils/types",
3142
- "id": "../web-components/dist/types/utils/types.d.ts::IcMenuOption"
3143
- }
3144
- }
3271
+ "original": "boolean",
3272
+ "resolved": "boolean",
3273
+ "references": {}
3145
3274
  },
3146
3275
  "mutable": false,
3276
+ "attr": "show-items-per-page-control",
3147
3277
  "reflectToAttr": false,
3148
- "docs": "The possible menu selection options.",
3278
+ "docs": "If `true`, the select input to control 'items per page' should be displayed.",
3149
3279
  "docsTags": [],
3280
+ "default": "false",
3150
3281
  "values": [
3151
3282
  {
3152
- "type": "IcMenuOption[]"
3283
+ "type": "boolean"
3153
3284
  }
3154
3285
  ],
3155
- "optional": false,
3156
- "required": true
3286
+ "optional": true,
3287
+ "required": false
3157
3288
  },
3158
3289
  {
3159
- "name": "searchMode",
3160
- "type": "\"navigation\" | \"query\"",
3290
+ "name": "theme",
3291
+ "type": "\"dark\" | \"inherit\" | \"light\"",
3161
3292
  "complexType": {
3162
- "original": "IcSearchBarSearchModes",
3163
- "resolved": "\"navigation\" | \"query\"",
3293
+ "original": "IcThemeMode",
3294
+ "resolved": "\"dark\" | \"inherit\" | \"light\"",
3164
3295
  "references": {
3165
- "IcSearchBarSearchModes": {
3296
+ "IcThemeMode": {
3166
3297
  "location": "import",
3167
- "path": "@ukic/web-components/dist/types/components",
3168
- "id": "../web-components/dist/types/components.d.ts::IcSearchBarSearchModes"
3298
+ "path": "@ukic/web-components/dist/types/interface",
3299
+ "id": "../web-components/dist/types/interface.d.ts::IcThemeMode"
3169
3300
  }
3170
3301
  }
3171
3302
  },
3172
3303
  "mutable": false,
3173
- "attr": "search-mode",
3304
+ "attr": "theme",
3174
3305
  "reflectToAttr": false,
3175
- "docs": "Specify the mode search bar uses to search. `navigation` allows for quick lookups of a set of values, `query` allows for more general searches.",
3306
+ "docs": "Sets the theme color to the dark or light theme color. \"inherit\" will set the color based on the system settings or ic-theme component.",
3176
3307
  "docsTags": [],
3177
- "default": "\"navigation\"",
3308
+ "default": "\"inherit\"",
3178
3309
  "values": [
3179
3310
  {
3180
- "value": "navigation",
3311
+ "value": "dark",
3181
3312
  "type": "string"
3182
3313
  },
3183
3314
  {
3184
- "value": "query",
3185
- "type": "string"
3186
- }
3187
- ],
3188
- "optional": true,
3189
- "required": false
3190
- },
3191
- {
3192
- "name": "size",
3193
- "type": "\"large\" | \"medium\" | \"small\"",
3194
- "complexType": {
3195
- "original": "IcSizes",
3196
- "resolved": "\"large\" | \"medium\" | \"small\"",
3197
- "references": {
3198
- "IcSizes": {
3199
- "location": "import",
3200
- "path": "../../utils/types",
3201
- "id": "src/utils/types.ts::IcSizes"
3202
- }
3203
- }
3204
- },
3205
- "mutable": false,
3206
- "attr": "size",
3207
- "reflectToAttr": false,
3208
- "docs": "The size of the menu.",
3209
- "docsTags": [],
3210
- "default": "\"medium\"",
3211
- "values": [
3212
- {
3213
- "value": "large",
3214
- "type": "string"
3215
- },
3216
- {
3217
- "value": "medium",
3218
- "type": "string"
3219
- },
3220
- {
3221
- "value": "small",
3222
- "type": "string"
3223
- }
3224
- ],
3225
- "optional": true,
3226
- "required": false
3227
- },
3228
- {
3229
- "name": "value",
3230
- "type": "string | string[]",
3231
- "complexType": {
3232
- "original": "string | string[]",
3233
- "resolved": "string | string[]",
3234
- "references": {}
3235
- },
3236
- "mutable": false,
3237
- "attr": "value",
3238
- "reflectToAttr": false,
3239
- "docs": "The value of the currently selected option - or array of values (if multiple options allowed).",
3240
- "docsTags": [],
3241
- "values": [
3242
- {
3243
- "type": "string"
3244
- },
3245
- {
3246
- "type": "string[]"
3247
- }
3248
- ],
3249
- "optional": false,
3250
- "required": true
3251
- },
3252
- {
3253
- "name": "valueField",
3254
- "type": "string",
3255
- "complexType": {
3256
- "original": "string",
3257
- "resolved": "string",
3258
- "references": {}
3259
- },
3260
- "mutable": false,
3261
- "attr": "value-field",
3262
- "reflectToAttr": false,
3263
- "docs": "The custom name for the value field for IcMenuOption.",
3264
- "docsTags": [],
3265
- "default": "\"value\"",
3266
- "values": [
3267
- {
3268
- "type": "string"
3269
- }
3270
- ],
3271
- "optional": false,
3272
- "required": false
3273
- }
3274
- ],
3275
- "methods": [
3276
- {
3277
- "name": "handleKeyboardOpen",
3278
- "returns": {
3279
- "type": "Promise<void>",
3280
- "docs": ""
3281
- },
3282
- "complexType": {
3283
- "signature": "(event: KeyboardEvent) => Promise<void>",
3284
- "parameters": [
3285
- {
3286
- "name": "event",
3287
- "type": "KeyboardEvent",
3288
- "docs": "- keyboard event"
3289
- }
3290
- ],
3291
- "references": {
3292
- "Promise": {
3293
- "location": "global",
3294
- "id": "global::Promise"
3295
- },
3296
- "KeyboardEvent": {
3297
- "location": "global",
3298
- "id": "global::KeyboardEvent"
3299
- }
3300
- },
3301
- "return": "Promise<void>"
3302
- },
3303
- "signature": "handleKeyboardOpen(event: KeyboardEvent) => Promise<void>",
3304
- "parameters": [
3305
- {
3306
- "name": "event",
3307
- "type": "KeyboardEvent",
3308
- "docs": "- keyboard event"
3309
- }
3310
- ],
3311
- "docs": "Used alongside activationType\nIf menu is opened via keyboard navigation (i.e. Enter, ArrowUp or ArrowDown), emit optionSelect custom event.",
3312
- "docsTags": [
3313
- {
3314
- "name": "param",
3315
- "text": "event - keyboard event"
3316
- }
3317
- ]
3318
- }
3319
- ],
3320
- "events": [],
3321
- "listeners": [],
3322
- "styles": [
3323
- {
3324
- "name": "--ic-z-index-menu",
3325
- "annotation": "prop",
3326
- "docs": "z-index of menu"
3327
- }
3328
- ],
3329
- "slots": [],
3330
- "parts": [],
3331
- "dependents": [
3332
- "ic-select-with-multi"
3333
- ],
3334
- "dependencies": [
3335
- "ic-loading-indicator",
3336
- "ic-typography",
3337
- "ic-button"
3338
- ],
3339
- "dependencyGraph": {
3340
- "ic-menu-with-multi": [
3341
- "ic-loading-indicator",
3342
- "ic-typography",
3343
- "ic-button"
3344
- ],
3345
- "ic-loading-indicator": [
3346
- "ic-typography"
3347
- ],
3348
- "ic-button": [
3349
- "ic-loading-indicator",
3350
- "ic-tooltip"
3351
- ],
3352
- "ic-tooltip": [
3353
- "ic-typography"
3354
- ],
3355
- "ic-select-with-multi": [
3356
- "ic-menu-with-multi"
3357
- ]
3358
- }
3359
- },
3360
- {
3361
- "filePath": "src/components/ic-pagination-bar/ic-pagination-bar.tsx",
3362
- "encapsulation": "shadow",
3363
- "tag": "ic-pagination-bar",
3364
- "readme": "# ic-pagination-bar\r\n\r\n\r\n\r",
3365
- "docs": "",
3366
- "docsTags": [],
3367
- "usage": {},
3368
- "props": [
3369
- {
3370
- "name": "alignment",
3371
- "type": "\"left\" | \"right\" | \"space-between\"",
3372
- "complexType": {
3373
- "original": "IcPaginationAlignmentOptions",
3374
- "resolved": "\"left\" | \"right\" | \"space-between\"",
3375
- "references": {
3376
- "IcPaginationAlignmentOptions": {
3377
- "location": "import",
3378
- "path": "@ukic/web-components/dist/types/components/ic-pagination/ic-pagination.types",
3379
- "id": "../web-components/dist/types/components/ic-pagination/ic-pagination.types.d.ts::IcPaginationAlignmentOptions"
3380
- }
3381
- }
3382
- },
3383
- "mutable": false,
3384
- "attr": "alignment",
3385
- "reflectToAttr": false,
3386
- "docs": "Sets the alignment of the items in the pagination bar.",
3387
- "docsTags": [],
3388
- "default": "\"right\"",
3389
- "values": [
3390
- {
3391
- "value": "left",
3392
- "type": "string"
3393
- },
3394
- {
3395
- "value": "right",
3396
- "type": "string"
3397
- },
3398
- {
3399
- "value": "space-between",
3400
- "type": "string"
3401
- }
3402
- ],
3403
- "optional": true,
3404
- "required": false
3405
- },
3406
- {
3407
- "name": "appearance",
3408
- "type": "\"dark\" | \"default\" | \"light\"",
3409
- "complexType": {
3410
- "original": "IcThemeForeground",
3411
- "resolved": "\"dark\" | \"default\" | \"light\"",
3412
- "references": {
3413
- "IcThemeForeground": {
3414
- "location": "import",
3415
- "path": "@ukic/web-components/dist/types/interface",
3416
- "id": "../web-components/dist/types/interface.d.ts::IcThemeForeground"
3417
- }
3418
- }
3419
- },
3420
- "mutable": false,
3421
- "attr": "appearance",
3422
- "reflectToAttr": false,
3423
- "docs": "Sets the styling for the items in the pagination bar.",
3424
- "docsTags": [],
3425
- "default": "\"default\"",
3426
- "values": [
3427
- {
3428
- "value": "dark",
3429
- "type": "string"
3430
- },
3431
- {
3432
- "value": "default",
3315
+ "value": "inherit",
3433
3316
  "type": "string"
3434
3317
  },
3435
3318
  {
@@ -3438,1266 +3321,137 @@
3438
3321
  }
3439
3322
  ],
3440
3323
  "optional": true,
3441
- "required": false
3442
- },
3443
- {
3444
- "name": "currentPage",
3445
- "type": "number",
3446
- "complexType": {
3447
- "original": "number",
3448
- "resolved": "number",
3449
- "references": {}
3450
- },
3451
- "mutable": false,
3452
- "attr": "current-page",
3453
- "reflectToAttr": false,
3454
- "docs": "The current page number to be displayed on the pagination bar.",
3455
- "docsTags": [],
3456
- "default": "1",
3457
- "values": [
3458
- {
3459
- "type": "number"
3460
- }
3461
- ],
3462
- "optional": true,
3463
- "required": false
3464
- },
3465
- {
3466
- "name": "hideRangeLabel",
3467
- "type": "boolean",
3468
- "complexType": {
3469
- "original": "boolean",
3470
- "resolved": "boolean",
3471
- "references": {}
3472
- },
3473
- "mutable": false,
3474
- "attr": "hide-range-label",
3475
- "reflectToAttr": false,
3476
- "docs": "If `true`, the number of total items and current item range or number of total pages and current page will be hidden.",
3477
- "docsTags": [],
3478
- "default": "false",
3479
- "values": [
3480
- {
3481
- "type": "boolean"
3482
- }
3483
- ],
3484
- "optional": true,
3485
- "required": false
3486
- },
3487
- {
3488
- "name": "itemLabel",
3489
- "type": "string",
3490
- "complexType": {
3491
- "original": "string",
3492
- "resolved": "string",
3493
- "references": {}
3494
- },
3495
- "mutable": false,
3496
- "attr": "item-label",
3497
- "reflectToAttr": false,
3498
- "docs": "The text which will be used in place of 'Item' on the pagination bar.",
3499
- "docsTags": [],
3500
- "default": "\"Item\"",
3501
- "values": [
3502
- {
3503
- "type": "string"
3504
- }
3505
- ],
3506
- "optional": true,
3507
- "required": false
3508
- },
3509
- {
3510
- "name": "itemsPerPageOptions",
3511
- "type": "{ label: string; value: string; }[]",
3512
- "complexType": {
3513
- "original": "{\n label: string;\n value: string;\n }[]",
3514
- "resolved": "{ label: string; value: string; }[]",
3515
- "references": {}
3516
- },
3517
- "mutable": false,
3518
- "reflectToAttr": false,
3519
- "docs": "The options which will be displayed for 'items per page' select input. Set a maximum of 4 options including a required 'All' option with value equal to total number of items.",
3520
- "docsTags": [],
3521
- "values": [
3522
- {
3523
- "type": "{ label: string; value: string; }[]"
3524
- }
3525
- ],
3526
- "optional": true,
3527
- "required": false
3528
- },
3529
- {
3530
- "name": "pageLabel",
3531
- "type": "string",
3532
- "complexType": {
3533
- "original": "string",
3534
- "resolved": "string",
3535
- "references": {}
3536
- },
3537
- "mutable": false,
3538
- "attr": "page-label",
3539
- "reflectToAttr": false,
3540
- "docs": "The text which will be used in place of 'Page' on the pagination bar.",
3541
- "docsTags": [],
3542
- "default": "\"Page\"",
3543
- "values": [
3544
- {
3545
- "type": "string"
3546
- }
3547
- ],
3548
- "optional": true,
3549
- "required": false
3550
- },
3551
- {
3552
- "name": "rangeLabelType",
3553
- "type": "\"data\" | \"page\"",
3554
- "complexType": {
3555
- "original": "IcPaginationLabelTypes",
3556
- "resolved": "\"data\" | \"page\"",
3557
- "references": {
3558
- "IcPaginationLabelTypes": {
3559
- "location": "import",
3560
- "path": "@ukic/web-components/dist/types/components/ic-pagination/ic-pagination.types",
3561
- "id": "../web-components/dist/types/components/ic-pagination/ic-pagination.types.d.ts::IcPaginationLabelTypes"
3562
- }
3563
- }
3564
- },
3565
- "mutable": false,
3566
- "attr": "range-label-type",
3567
- "reflectToAttr": false,
3568
- "docs": "Whether total number of items and current item range or total number of pages and current page is displayed.",
3569
- "docsTags": [],
3570
- "default": "\"page\"",
3571
- "values": [
3572
- {
3573
- "value": "data",
3574
- "type": "string"
3575
- },
3576
- {
3577
- "value": "page",
3578
- "type": "string"
3579
- }
3580
- ],
3581
- "optional": true,
3582
- "required": false
3583
- },
3584
- {
3585
- "name": "showGoToPageControl",
3586
- "type": "boolean",
3587
- "complexType": {
3588
- "original": "boolean",
3589
- "resolved": "boolean",
3590
- "references": {}
3591
- },
3592
- "mutable": false,
3593
- "attr": "show-go-to-page-control",
3594
- "reflectToAttr": false,
3595
- "docs": "If `true`, the 'go to page' control should be displayed.",
3596
- "docsTags": [],
3597
- "default": "false",
3598
- "values": [
3599
- {
3600
- "type": "boolean"
3601
- }
3602
- ],
3603
- "optional": true,
3604
- "required": false
3605
- },
3606
- {
3607
- "name": "showItemsPerPageControl",
3608
- "type": "boolean",
3609
- "complexType": {
3610
- "original": "boolean",
3611
- "resolved": "boolean",
3612
- "references": {}
3613
- },
3614
- "mutable": false,
3615
- "attr": "show-items-per-page-control",
3616
- "reflectToAttr": false,
3617
- "docs": "If `true`, the select input to control 'items per page' should be displayed.",
3618
- "docsTags": [],
3619
- "default": "false",
3620
- "values": [
3621
- {
3622
- "type": "boolean"
3623
- }
3624
- ],
3625
- "optional": true,
3626
- "required": false
3627
- },
3628
- {
3629
- "name": "totalItems",
3630
- "type": "number",
3631
- "complexType": {
3632
- "original": "number",
3633
- "resolved": "number",
3634
- "references": {}
3635
- },
3636
- "mutable": false,
3637
- "attr": "total-items",
3638
- "reflectToAttr": false,
3639
- "docs": "Total number of items to be displayed across all pages.",
3640
- "docsTags": [],
3641
- "values": [
3642
- {
3643
- "type": "number"
3644
- }
3645
- ],
3646
- "optional": false,
3647
- "required": true
3648
- },
3649
- {
3650
- "name": "type",
3651
- "type": "\"complex\" | \"simple\"",
3652
- "complexType": {
3653
- "original": "IcPaginationTypes",
3654
- "resolved": "\"complex\" | \"simple\"",
3655
- "references": {
3656
- "IcPaginationTypes": {
3657
- "location": "import",
3658
- "path": "@ukic/web-components/dist/types/components/ic-pagination/ic-pagination.types",
3659
- "id": "../web-components/dist/types/components/ic-pagination/ic-pagination.types.d.ts::IcPaginationTypes"
3660
- }
3661
- }
3662
- },
3663
- "mutable": false,
3664
- "attr": "type",
3665
- "reflectToAttr": false,
3666
- "docs": "Whether the displayed pagination is simple or complex.",
3667
- "docsTags": [],
3668
- "default": "\"simple\"",
3669
- "values": [
3670
- {
3671
- "value": "complex",
3672
- "type": "string"
3673
- },
3674
- {
3675
- "value": "simple",
3676
- "type": "string"
3677
- }
3678
- ],
3679
- "optional": true,
3680
- "required": false
3681
- }
3682
- ],
3683
- "methods": [],
3684
- "events": [
3685
- {
3686
- "event": "icItemsPerPageChange",
3687
- "detail": "{ value: number; }",
3688
- "bubbles": true,
3689
- "complexType": {
3690
- "original": "{ value: number }",
3691
- "resolved": "{ value: number; }",
3692
- "references": {}
3693
- },
3694
- "cancelable": true,
3695
- "composed": true,
3696
- "docs": "Emitted when the items per page option is changed.",
3697
- "docsTags": []
3698
- },
3699
- {
3700
- "event": "icPageChange",
3701
- "detail": "IcPageChangeEventDetail",
3702
- "bubbles": true,
3703
- "complexType": {
3704
- "original": "IcPageChangeEventDetail",
3705
- "resolved": "IcPageChangeEventDetail",
3706
- "references": {
3707
- "IcPageChangeEventDetail": {
3708
- "location": "import",
3709
- "path": "./ic-pagination-bar.types",
3710
- "id": "src/components/ic-pagination-bar/ic-pagination-bar.types.ts::IcPageChangeEventDetail"
3711
- }
3712
- }
3713
- },
3714
- "cancelable": true,
3715
- "composed": true,
3716
- "docs": "Emitted when a page is navigated to via the 'go to' input.\nThe `detail` property contains `value` (i.e. the page number) and a `fromItemsPerPage` flag to indicate if the event was triggered by the `icItemsPerPageChange` event also occurring.",
3717
- "docsTags": []
3718
- }
3719
- ],
3720
- "listeners": [
3721
- {
3722
- "event": "icPageChange",
3723
- "capture": false,
3724
- "passive": false
3725
- }
3726
- ],
3727
- "styles": [],
3728
- "slots": [],
3729
- "parts": [],
3730
- "dependents": [
3731
- "ic-data-table"
3732
- ],
3733
- "dependencies": [
3734
- "ic-typography",
3735
- "ic-select",
3736
- "ic-pagination",
3737
- "ic-tooltip",
3738
- "ic-text-field",
3739
- "ic-button"
3740
- ],
3741
- "dependencyGraph": {
3742
- "ic-pagination-bar": [
3743
- "ic-typography",
3744
- "ic-select",
3745
- "ic-pagination",
3746
- "ic-tooltip",
3747
- "ic-text-field",
3748
- "ic-button"
3749
- ],
3750
- "ic-select": [
3751
- "ic-input-container",
3752
- "ic-input-label",
3753
- "ic-input-component-container",
3754
- "ic-typography",
3755
- "ic-button",
3756
- "ic-menu",
3757
- "ic-input-validation"
3758
- ],
3759
- "ic-input-label": [
3760
- "ic-typography"
3761
- ],
3762
- "ic-button": [
3763
- "ic-loading-indicator",
3764
- "ic-tooltip"
3765
- ],
3766
- "ic-loading-indicator": [
3767
- "ic-typography"
3768
- ],
3769
- "ic-tooltip": [
3770
- "ic-typography"
3771
- ],
3772
- "ic-menu": [
3773
- "ic-loading-indicator",
3774
- "ic-typography",
3775
- "ic-button"
3776
- ],
3777
- "ic-input-validation": [
3778
- "ic-typography"
3779
- ],
3780
- "ic-pagination": [
3781
- "ic-button",
3782
- "ic-pagination-item"
3783
- ],
3784
- "ic-pagination-item": [
3785
- "ic-typography"
3786
- ],
3787
- "ic-text-field": [
3788
- "ic-input-container",
3789
- "ic-input-label",
3790
- "ic-input-component-container",
3791
- "ic-input-validation",
3792
- "ic-typography"
3793
- ],
3794
- "ic-data-table": [
3795
- "ic-pagination-bar"
3796
- ]
3797
- }
3798
- },
3799
- {
3800
- "filePath": "src/components/ic-select-with-multi/ic-select.tsx",
3801
- "encapsulation": "shadow",
3802
- "tag": "ic-select-with-multi",
3803
- "readme": "# ic-select\r\n\r\n\r\n\r",
3804
- "docs": "",
3805
- "docsTags": [],
3806
- "usage": {},
3807
- "props": [
3808
- {
3809
- "name": "debounce",
3810
- "type": "number",
3811
- "complexType": {
3812
- "original": "number",
3813
- "resolved": "number",
3814
- "references": {}
3815
- },
3816
- "mutable": false,
3817
- "attr": "debounce",
3818
- "reflectToAttr": false,
3819
- "docs": "The amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.",
3820
- "docsTags": [],
3821
- "default": "0",
3822
- "values": [
3823
- {
3824
- "type": "number"
3825
- }
3826
- ],
3827
- "optional": true,
3828
- "required": false
3829
- },
3830
- {
3831
- "name": "disableAutoFiltering",
3832
- "type": "boolean",
3833
- "complexType": {
3834
- "original": "boolean",
3835
- "resolved": "boolean",
3836
- "references": {}
3837
- },
3838
- "mutable": false,
3839
- "attr": "disable-auto-filtering",
3840
- "reflectToAttr": false,
3841
- "docs": "If `true`, the built in filtering will be disabled for a searchable variant. For example, if options will already be filtered from external source.",
3842
- "docsTags": [],
3843
- "default": "false",
3844
- "values": [
3845
- {
3846
- "type": "boolean"
3847
- }
3848
- ],
3849
- "optional": true,
3850
- "required": false
3851
- },
3852
- {
3853
- "name": "disabled",
3854
- "type": "boolean",
3855
- "complexType": {
3856
- "original": "boolean",
3857
- "resolved": "boolean",
3858
- "references": {}
3859
- },
3860
- "mutable": false,
3861
- "attr": "disabled",
3862
- "reflectToAttr": true,
3863
- "docs": "If `true`, the disabled state will be set.",
3864
- "docsTags": [],
3865
- "default": "false",
3866
- "values": [
3867
- {
3868
- "type": "boolean"
3869
- }
3870
- ],
3871
- "optional": true,
3872
- "required": false
3873
- },
3874
- {
3875
- "name": "emptyOptionListText",
3876
- "type": "string",
3877
- "complexType": {
3878
- "original": "string",
3879
- "resolved": "string",
3880
- "references": {}
3881
- },
3882
- "mutable": false,
3883
- "attr": "empty-option-list-text",
3884
- "reflectToAttr": false,
3885
- "docs": "The text displayed when there are no options in the option list.",
3886
- "docsTags": [],
3887
- "default": "\"No results found\"",
3888
- "values": [
3889
- {
3890
- "type": "string"
3891
- }
3892
- ],
3893
- "optional": false,
3894
- "required": false
3895
- },
3896
- {
3897
- "name": "form",
3898
- "type": "string",
3899
- "complexType": {
3900
- "original": "string",
3901
- "resolved": "string",
3902
- "references": {}
3903
- },
3904
- "mutable": false,
3905
- "attr": "form",
3906
- "reflectToAttr": false,
3907
- "docs": "The <form> element to associate the select with.",
3908
- "docsTags": [],
3909
- "values": [
3910
- {
3911
- "type": "string"
3912
- }
3913
- ],
3914
- "optional": true,
3915
- "required": false
3916
- },
3917
- {
3918
- "name": "fullWidth",
3919
- "type": "boolean",
3920
- "complexType": {
3921
- "original": "boolean",
3922
- "resolved": "boolean",
3923
- "references": {}
3924
- },
3925
- "mutable": false,
3926
- "attr": "full-width",
3927
- "reflectToAttr": false,
3928
- "docs": "If `true`, the select element will fill the width of the container. This prop should only be used with searchable select and will only be applied if searchable is true.",
3929
- "docsTags": [],
3930
- "default": "false",
3931
- "values": [
3932
- {
3933
- "type": "boolean"
3934
- }
3935
- ],
3936
- "optional": false,
3937
- "required": false
3938
- },
3939
- {
3940
- "name": "helperText",
3941
- "type": "string",
3942
- "complexType": {
3943
- "original": "string",
3944
- "resolved": "string",
3945
- "references": {}
3946
- },
3947
- "mutable": false,
3948
- "attr": "helper-text",
3949
- "reflectToAttr": false,
3950
- "docs": "The helper text that will be displayed for additional field guidance.",
3951
- "docsTags": [],
3952
- "default": "\"\"",
3953
- "values": [
3954
- {
3955
- "type": "string"
3956
- }
3957
- ],
3958
- "optional": true,
3959
- "required": false
3960
- },
3961
- {
3962
- "name": "hideLabel",
3963
- "type": "boolean",
3964
- "complexType": {
3965
- "original": "boolean",
3966
- "resolved": "boolean",
3967
- "references": {}
3968
- },
3969
- "mutable": false,
3970
- "attr": "hide-label",
3971
- "reflectToAttr": false,
3972
- "docs": "If `true`, the label will be hidden and the required label value will be applied as an aria-label.",
3973
- "docsTags": [],
3974
- "default": "false",
3975
- "values": [
3976
- {
3977
- "type": "boolean"
3978
- }
3979
- ],
3980
- "optional": true,
3981
- "required": false
3982
- },
3983
- {
3984
- "name": "includeDescriptionsInSearch",
3985
- "type": "boolean",
3986
- "complexType": {
3987
- "original": "boolean",
3988
- "resolved": "boolean",
3989
- "references": {}
3990
- },
3991
- "mutable": false,
3992
- "attr": "include-descriptions-in-search",
3993
- "reflectToAttr": false,
3994
- "docs": "If `true`, descriptions of options will be included when filtering options in a searchable select. Only applies to built in filtering.",
3995
- "docsTags": [],
3996
- "default": "false",
3997
- "values": [
3998
- {
3999
- "type": "boolean"
4000
- }
4001
- ],
4002
- "optional": true,
4003
- "required": false
4004
- },
4005
- {
4006
- "name": "includeGroupTitlesInSearch",
4007
- "type": "boolean",
4008
- "complexType": {
4009
- "original": "boolean",
4010
- "resolved": "boolean",
4011
- "references": {}
4012
- },
4013
- "mutable": false,
4014
- "attr": "include-group-titles-in-search",
4015
- "reflectToAttr": false,
4016
- "docs": "If `true`, group titles of grouped options will be included when filtering options in a searchable select. Only applies to built in filtering.",
4017
- "docsTags": [],
4018
- "default": "false",
4019
- "values": [
4020
- {
4021
- "type": "boolean"
4022
- }
4023
- ],
4024
- "optional": true,
4025
- "required": false
4026
- },
4027
- {
4028
- "name": "label",
4029
- "type": "string",
4030
- "complexType": {
4031
- "original": "string",
4032
- "resolved": "string",
4033
- "references": {}
4034
- },
4035
- "mutable": false,
4036
- "attr": "label",
4037
- "reflectToAttr": false,
4038
- "docs": "The label for the select.",
4039
- "docsTags": [],
4040
- "values": [
4041
- {
4042
- "type": "string"
4043
- }
4044
- ],
4045
- "optional": false,
4046
- "required": true
4047
- },
4048
- {
4049
- "name": "loading",
4050
- "type": "boolean",
4051
- "complexType": {
4052
- "original": "boolean",
4053
- "resolved": "boolean",
4054
- "references": {}
4055
- },
4056
- "mutable": true,
4057
- "attr": "loading",
4058
- "reflectToAttr": false,
4059
- "docs": "If `true`, the loading state will be triggered when fetching options asynchronously.",
4060
- "docsTags": [],
4061
- "default": "false",
4062
- "values": [
4063
- {
4064
- "type": "boolean"
4065
- }
4066
- ],
4067
- "optional": true,
4068
- "required": false
4069
- },
4070
- {
4071
- "name": "loadingErrorLabel",
4072
- "type": "string",
4073
- "complexType": {
4074
- "original": "string",
4075
- "resolved": "string",
4076
- "references": {}
4077
- },
4078
- "mutable": false,
4079
- "attr": "loading-error-label",
4080
- "reflectToAttr": false,
4081
- "docs": "The message displayed when external loading times out.",
4082
- "docsTags": [],
4083
- "default": "\"Loading Error\"",
4084
- "values": [
4085
- {
4086
- "type": "string"
4087
- }
4088
- ],
4089
- "optional": true,
4090
- "required": false
4091
- },
4092
- {
4093
- "name": "loadingLabel",
4094
- "type": "string",
4095
- "complexType": {
4096
- "original": "string",
4097
- "resolved": "string",
4098
- "references": {}
4099
- },
4100
- "mutable": false,
4101
- "attr": "loading-label",
4102
- "reflectToAttr": false,
4103
- "docs": "The message displayed whilst the options are being loaded externally.",
4104
- "docsTags": [],
4105
- "default": "\"Loading...\"",
4106
- "values": [
4107
- {
4108
- "type": "string"
4109
- }
4110
- ],
4111
- "optional": true,
4112
- "required": false
4113
- },
4114
- {
4115
- "name": "multiple",
4116
- "type": "boolean",
4117
- "complexType": {
4118
- "original": "boolean",
4119
- "resolved": "boolean",
4120
- "references": {}
4121
- },
4122
- "mutable": false,
4123
- "attr": "multiple",
4124
- "reflectToAttr": false,
4125
- "docs": "If `true`, multiple options can be selected.",
4126
- "docsTags": [],
4127
- "default": "false",
4128
- "values": [
4129
- {
4130
- "type": "boolean"
4131
- }
4132
- ],
4133
- "optional": true,
4134
- "required": false
4135
- },
4136
- {
4137
- "name": "name",
4138
- "type": "string",
4139
- "complexType": {
4140
- "original": "string",
4141
- "resolved": "string",
4142
- "references": {}
4143
- },
4144
- "mutable": false,
4145
- "attr": "name",
4146
- "reflectToAttr": false,
4147
- "docs": "The name of the control, which is submitted with the form data.",
4148
- "docsTags": [],
4149
- "default": "this.inputId",
4150
- "values": [
4151
- {
4152
- "type": "string"
4153
- }
4154
- ],
4155
- "optional": true,
4156
- "required": false
4157
- },
4158
- {
4159
- "name": "options",
4160
- "type": "IcMenuOption[]",
4161
- "complexType": {
4162
- "original": "IcMenuOption[]",
4163
- "resolved": "IcMenuOption[]",
4164
- "references": {
4165
- "IcMenuOption": {
4166
- "location": "import",
4167
- "path": "@ukic/web-components/dist/types/utils/types",
4168
- "id": "../web-components/dist/types/utils/types.d.ts::IcMenuOption"
4169
- }
4170
- }
4171
- },
4172
- "mutable": false,
4173
- "reflectToAttr": false,
4174
- "docs": "The possible selection options.",
4175
- "docsTags": [],
4176
- "default": "[]",
4177
- "values": [
4178
- {
4179
- "type": "IcMenuOption[]"
4180
- }
4181
- ],
4182
- "optional": true,
4183
- "required": false
4184
- },
4185
- {
4186
- "name": "placeholder",
4187
- "type": "string",
4188
- "complexType": {
4189
- "original": "string",
4190
- "resolved": "string",
4191
- "references": {}
4192
- },
4193
- "mutable": false,
4194
- "attr": "placeholder",
4195
- "reflectToAttr": false,
4196
- "docs": "The placeholder value to be displayed.",
4197
- "docsTags": [],
4198
- "default": "\"Select an option\"",
4199
- "values": [
4200
- {
4201
- "type": "string"
4202
- }
4203
- ],
4204
- "optional": true,
4205
- "required": false
4206
- },
4207
- {
4208
- "name": "readonly",
4209
- "type": "boolean",
4210
- "complexType": {
4211
- "original": "boolean",
4212
- "resolved": "boolean",
4213
- "references": {}
4214
- },
4215
- "mutable": false,
4216
- "attr": "readonly",
4217
- "reflectToAttr": false,
4218
- "docs": "If `true`, the readonly state will be set.",
4219
- "docsTags": [],
4220
- "default": "false",
4221
- "values": [
4222
- {
4223
- "type": "boolean"
4224
- }
4225
- ],
4226
- "optional": true,
4227
- "required": false
4228
- },
4229
- {
4230
- "name": "required",
4231
- "type": "boolean",
4232
- "complexType": {
4233
- "original": "boolean",
4234
- "resolved": "boolean",
4235
- "references": {}
4236
- },
4237
- "mutable": false,
4238
- "attr": "required",
4239
- "reflectToAttr": false,
4240
- "docs": "If `true`, the select will require a value.",
4241
- "docsTags": [],
4242
- "default": "false",
4243
- "values": [
4244
- {
4245
- "type": "boolean"
4246
- }
4247
- ],
4248
- "optional": true,
4249
- "required": false
4250
- },
4251
- {
4252
- "name": "searchMatchPosition",
4253
- "type": "\"anywhere\" | \"start\"",
4254
- "complexType": {
4255
- "original": "IcSearchMatchPositions",
4256
- "resolved": "\"anywhere\" | \"start\"",
4257
- "references": {
4258
- "IcSearchMatchPositions": {
4259
- "location": "import",
4260
- "path": "../../utils/types",
4261
- "id": "src/utils/types.ts::IcSearchMatchPositions"
4262
- }
4263
- }
4264
- },
4265
- "mutable": false,
4266
- "attr": "search-match-position",
4267
- "reflectToAttr": false,
4268
- "docs": "Whether the search string of the searchable select should match the start of or anywhere in the options. Only applies to built in filtering.",
4269
- "docsTags": [],
4270
- "default": "\"anywhere\"",
4271
- "values": [
4272
- {
4273
- "value": "anywhere",
4274
- "type": "string"
4275
- },
4276
- {
4277
- "value": "start",
4278
- "type": "string"
4279
- }
4280
- ],
4281
- "optional": true,
4282
- "required": false
4283
- },
4284
- {
4285
- "name": "searchable",
4286
- "type": "boolean",
4287
- "complexType": {
4288
- "original": "boolean",
4289
- "resolved": "boolean",
4290
- "references": {}
4291
- },
4292
- "mutable": false,
4293
- "attr": "searchable",
4294
- "reflectToAttr": false,
4295
- "docs": "If `true`, a searchable variant of the select will be displayed which can be typed in to filter options.",
4296
- "docsTags": [],
4297
- "default": "false",
4298
- "values": [
4299
- {
4300
- "type": "boolean"
4301
- }
4302
- ],
4303
- "optional": true,
4304
- "required": false
4305
- },
4306
- {
4307
- "name": "selectOnEnter",
4308
- "type": "boolean",
4309
- "complexType": {
4310
- "original": "boolean",
4311
- "resolved": "boolean",
4312
- "references": {}
4313
- },
4314
- "mutable": false,
4315
- "attr": "select-on-enter",
4316
- "reflectToAttr": false,
4317
- "docs": "If `true`, the icOptionSelect event will be fired on enter instead of ArrowUp and ArrowDown.",
4318
- "docsTags": [],
4319
- "default": "false",
4320
- "values": [
4321
- {
4322
- "type": "boolean"
4323
- }
4324
- ],
4325
- "optional": true,
4326
- "required": false
4327
- },
4328
- {
4329
- "name": "showClearButton",
4330
- "type": "boolean",
4331
- "complexType": {
4332
- "original": "boolean",
4333
- "resolved": "boolean",
4334
- "references": {}
4335
- },
4336
- "mutable": false,
4337
- "attr": "show-clear-button",
4338
- "reflectToAttr": false,
4339
- "docs": "If `true`, a button which clears the select input when clicked will be displayed. The button will always appear on the searchable select.",
4340
- "docsTags": [],
4341
- "default": "false",
4342
- "values": [
4343
- {
4344
- "type": "boolean"
4345
- }
4346
- ],
4347
- "optional": true,
4348
- "required": false
4349
- },
4350
- {
4351
- "name": "size",
4352
- "type": "\"large\" | \"medium\" | \"small\"",
4353
- "complexType": {
4354
- "original": "IcSizes",
4355
- "resolved": "\"large\" | \"medium\" | \"small\"",
4356
- "references": {
4357
- "IcSizes": {
4358
- "location": "import",
4359
- "path": "../../utils/types",
4360
- "id": "src/utils/types.ts::IcSizes"
4361
- }
4362
- }
4363
- },
4364
- "mutable": false,
4365
- "attr": "size",
4366
- "reflectToAttr": false,
4367
- "docs": "The size of the select.",
4368
- "docsTags": [],
4369
- "default": "\"medium\"",
4370
- "values": [
4371
- {
4372
- "value": "large",
4373
- "type": "string"
4374
- },
4375
- {
4376
- "value": "medium",
4377
- "type": "string"
4378
- },
4379
- {
4380
- "value": "small",
4381
- "type": "string"
4382
- }
4383
- ],
4384
- "optional": true,
4385
- "required": false
4386
- },
4387
- {
4388
- "name": "timeout",
4389
- "type": "number",
4390
- "complexType": {
4391
- "original": "number",
4392
- "resolved": "number",
4393
- "references": {}
4394
- },
4395
- "mutable": false,
4396
- "attr": "timeout",
4397
- "reflectToAttr": false,
4398
- "docs": "If using external filtering, set a timeout for when loading takes too long.",
4399
- "docsTags": [],
4400
- "values": [
4401
- {
4402
- "type": "number"
4403
- }
4404
- ],
4405
- "optional": true,
4406
- "required": false
4407
- },
4408
- {
4409
- "name": "validationStatus",
4410
- "type": "\"\" | \"error\" | \"success\" | \"warning\"",
4411
- "complexType": {
4412
- "original": "IcInformationStatusOrEmpty",
4413
- "resolved": "\"\" | \"error\" | \"success\" | \"warning\"",
4414
- "references": {
4415
- "IcInformationStatusOrEmpty": {
4416
- "location": "import",
4417
- "path": "../../utils/types",
4418
- "id": "src/utils/types.ts::IcInformationStatusOrEmpty"
4419
- }
4420
- }
4421
- },
4422
- "mutable": false,
4423
- "attr": "validation-status",
4424
- "reflectToAttr": false,
4425
- "docs": "The validation status - e.g. 'error' | 'warning' | 'success'.",
4426
- "docsTags": [],
4427
- "default": "\"\"",
4428
- "values": [
4429
- {
4430
- "type": "\"\""
4431
- },
4432
- {
4433
- "value": "error",
4434
- "type": "string"
4435
- },
4436
- {
4437
- "value": "success",
4438
- "type": "string"
4439
- },
4440
- {
4441
- "value": "warning",
4442
- "type": "string"
4443
- }
4444
- ],
4445
- "optional": true,
4446
- "required": false
4447
- },
4448
- {
4449
- "name": "validationText",
4450
- "type": "string",
4451
- "complexType": {
4452
- "original": "string",
4453
- "resolved": "string",
4454
- "references": {}
4455
- },
4456
- "mutable": false,
4457
- "attr": "validation-text",
4458
- "reflectToAttr": false,
4459
- "docs": "The text to display as the validation message.",
4460
- "docsTags": [],
4461
- "default": "\"\"",
4462
- "values": [
4463
- {
4464
- "type": "string"
4465
- }
4466
- ],
4467
- "optional": true,
4468
- "required": false
4469
- },
4470
- {
4471
- "name": "value",
4472
- "type": "string | string[]",
4473
- "complexType": {
4474
- "original": "string | string[]",
4475
- "resolved": "string | string[]",
4476
- "references": {}
4477
- },
4478
- "mutable": true,
4479
- "attr": "value",
4480
- "reflectToAttr": false,
4481
- "docs": "The value of the select, reflected by the value of the currently selected option.\nFor the searchable variant, the value is also reflected by the user input.\nFor the multi-select variant, the value must be an array of option values.",
4482
- "docsTags": [],
4483
- "values": [
4484
- {
4485
- "type": "string"
4486
- },
4487
- {
4488
- "type": "string[]"
4489
- }
4490
- ],
4491
- "optional": true,
4492
- "required": false
4493
- }
4494
- ],
4495
- "methods": [
4496
- {
4497
- "name": "setFocus",
4498
- "returns": {
4499
- "type": "Promise<void>",
4500
- "docs": ""
4501
- },
4502
- "complexType": {
4503
- "signature": "() => Promise<void>",
4504
- "parameters": [],
4505
- "references": {
4506
- "Promise": {
4507
- "location": "global",
4508
- "id": "global::Promise"
4509
- }
4510
- },
4511
- "return": "Promise<void>"
4512
- },
4513
- "signature": "setFocus() => Promise<void>",
4514
- "parameters": [],
4515
- "docs": "Sets focus on the input box.",
4516
- "docsTags": []
4517
- }
4518
- ],
4519
- "events": [
4520
- {
4521
- "event": "icBlur",
4522
- "detail": "void",
4523
- "bubbles": true,
4524
- "complexType": {
4525
- "original": "void",
4526
- "resolved": "void",
4527
- "references": {}
4528
- },
4529
- "cancelable": true,
4530
- "composed": true,
4531
- "docs": "Emitted when the select loses focus.",
4532
- "docsTags": []
4533
- },
4534
- {
4535
- "event": "icChange",
4536
- "detail": "IcValueEventDetail",
4537
- "bubbles": true,
4538
- "complexType": {
4539
- "original": "IcValueEventDetail",
4540
- "resolved": "IcValueEventDetail",
4541
- "references": {
4542
- "IcValueEventDetail": {
4543
- "location": "import",
4544
- "path": "../../utils/types",
4545
- "id": "src/utils/types.ts::IcValueEventDetail"
4546
- }
4547
- }
4548
- },
4549
- "cancelable": true,
4550
- "composed": true,
4551
- "docs": "Emitted when the value changes.",
4552
- "docsTags": []
4553
- },
4554
- {
4555
- "event": "icClear",
4556
- "detail": "void",
4557
- "bubbles": true,
4558
- "complexType": {
4559
- "original": "void",
4560
- "resolved": "void",
4561
- "references": {}
4562
- },
4563
- "cancelable": true,
4564
- "composed": true,
4565
- "docs": "Emitted when the clear button is clicked.",
4566
- "docsTags": []
4567
- },
4568
- {
4569
- "event": "icFocus",
4570
- "detail": "void",
4571
- "bubbles": true,
4572
- "complexType": {
4573
- "original": "void",
4574
- "resolved": "void",
4575
- "references": {}
4576
- },
4577
- "cancelable": true,
4578
- "composed": true,
4579
- "docs": "Emitted when the select gains focus.",
4580
- "docsTags": []
3324
+ "required": false
4581
3325
  },
4582
3326
  {
4583
- "event": "icInput",
4584
- "detail": "IcValueEventDetail",
4585
- "bubbles": true,
3327
+ "name": "totalItems",
3328
+ "type": "number",
4586
3329
  "complexType": {
4587
- "original": "IcValueEventDetail",
4588
- "resolved": "IcValueEventDetail",
4589
- "references": {
4590
- "IcValueEventDetail": {
4591
- "location": "import",
4592
- "path": "../../utils/types",
4593
- "id": "src/utils/types.ts::IcValueEventDetail"
4594
- }
4595
- }
3330
+ "original": "number",
3331
+ "resolved": "number",
3332
+ "references": {}
4596
3333
  },
4597
- "cancelable": true,
4598
- "composed": true,
4599
- "docs": "Emitted when a keyboard input occurred.",
4600
- "docsTags": []
3334
+ "mutable": false,
3335
+ "attr": "total-items",
3336
+ "reflectToAttr": false,
3337
+ "docs": "Total number of items to be displayed across all pages.",
3338
+ "docsTags": [],
3339
+ "values": [
3340
+ {
3341
+ "type": "number"
3342
+ }
3343
+ ],
3344
+ "optional": false,
3345
+ "required": true
4601
3346
  },
4602
3347
  {
4603
- "event": "icOptionDeselect",
4604
- "detail": "IcOptionSelectEventDetail",
4605
- "bubbles": true,
3348
+ "name": "type",
3349
+ "type": "\"complex\" | \"simple\"",
4606
3350
  "complexType": {
4607
- "original": "IcOptionSelectEventDetail",
4608
- "resolved": "IcOptionSelectEventDetail",
3351
+ "original": "IcPaginationTypes",
3352
+ "resolved": "\"complex\" | \"simple\"",
4609
3353
  "references": {
4610
- "IcOptionSelectEventDetail": {
3354
+ "IcPaginationTypes": {
4611
3355
  "location": "import",
4612
- "path": "@ukic/web-components/dist/types/components",
4613
- "id": "../web-components/dist/types/components.d.ts::IcOptionSelectEventDetail"
3356
+ "path": "@ukic/web-components/dist/types/components/ic-pagination/ic-pagination.types",
3357
+ "id": "../web-components/dist/types/components/ic-pagination/ic-pagination.types.d.ts::IcPaginationTypes"
4614
3358
  }
4615
3359
  }
4616
3360
  },
4617
- "cancelable": true,
4618
- "composed": true,
4619
- "docs": "Emitted when `multiple` is `true` and an option is deselected.",
4620
- "docsTags": []
4621
- },
3361
+ "mutable": false,
3362
+ "attr": "type",
3363
+ "reflectToAttr": false,
3364
+ "docs": "Whether the displayed pagination is simple or complex.",
3365
+ "docsTags": [],
3366
+ "default": "\"simple\"",
3367
+ "values": [
3368
+ {
3369
+ "value": "complex",
3370
+ "type": "string"
3371
+ },
3372
+ {
3373
+ "value": "simple",
3374
+ "type": "string"
3375
+ }
3376
+ ],
3377
+ "optional": true,
3378
+ "required": false
3379
+ }
3380
+ ],
3381
+ "methods": [],
3382
+ "events": [
4622
3383
  {
4623
- "event": "icOptionSelect",
4624
- "detail": "IcOptionSelectEventDetail",
3384
+ "event": "icItemsPerPageChange",
3385
+ "detail": "{ value: number; }",
4625
3386
  "bubbles": true,
4626
3387
  "complexType": {
4627
- "original": "IcOptionSelectEventDetail",
4628
- "resolved": "IcOptionSelectEventDetail",
4629
- "references": {
4630
- "IcOptionSelectEventDetail": {
4631
- "location": "import",
4632
- "path": "@ukic/web-components/dist/types/components",
4633
- "id": "../web-components/dist/types/components.d.ts::IcOptionSelectEventDetail"
4634
- }
4635
- }
3388
+ "original": "{ value: number }",
3389
+ "resolved": "{ value: number; }",
3390
+ "references": {}
4636
3391
  },
4637
3392
  "cancelable": true,
4638
3393
  "composed": true,
4639
- "docs": "Emitted when an option is selected.\nSelecting an option will also trigger an `icChange/onIcChange` due to the value being updated.",
3394
+ "docs": "Emitted when the items per page option is changed.",
4640
3395
  "docsTags": []
4641
3396
  },
4642
3397
  {
4643
- "event": "icRetryLoad",
4644
- "detail": "IcValueEventDetail",
3398
+ "event": "icPageChange",
3399
+ "detail": "IcPageChangeEventDetail",
4645
3400
  "bubbles": true,
4646
3401
  "complexType": {
4647
- "original": "IcValueEventDetail",
4648
- "resolved": "IcValueEventDetail",
3402
+ "original": "IcPageChangeEventDetail",
3403
+ "resolved": "IcPageChangeEventDetail",
4649
3404
  "references": {
4650
- "IcValueEventDetail": {
3405
+ "IcPageChangeEventDetail": {
4651
3406
  "location": "import",
4652
- "path": "../../utils/types",
4653
- "id": "src/utils/types.ts::IcValueEventDetail"
3407
+ "path": "./ic-pagination-bar.types",
3408
+ "id": "src/components/ic-pagination-bar/ic-pagination-bar.types.ts::IcPageChangeEventDetail"
4654
3409
  }
4655
3410
  }
4656
3411
  },
4657
3412
  "cancelable": true,
4658
3413
  "composed": true,
4659
- "docs": "Emitted when the 'retry loading' button is clicked for a searchable variant.",
3414
+ "docs": "Emitted when a page is navigated to via the 'go to' input.\nThe `detail` property contains `value` (i.e. the page number) and a `fromItemsPerPage` flag to indicate if the event was triggered by the `icItemsPerPageChange` event also occurring.",
4660
3415
  "docsTags": []
4661
3416
  }
4662
3417
  ],
4663
- "listeners": [],
4664
- "styles": [
4665
- {
4666
- "name": "--ic-z-index-menu",
4667
- "annotation": "prop",
4668
- "docs": "z-index of select menu"
4669
- },
4670
- {
4671
- "name": "--input-width",
4672
- "annotation": "prop",
4673
- "docs": "Width of the input field"
4674
- },
3418
+ "listeners": [
4675
3419
  {
4676
- "name": "--menu-width",
4677
- "annotation": "prop",
4678
- "docs": "Width of the dropdown menu"
3420
+ "event": "icPageChange",
3421
+ "capture": false,
3422
+ "passive": false
4679
3423
  }
4680
3424
  ],
3425
+ "styles": [],
4681
3426
  "slots": [],
4682
3427
  "parts": [],
4683
- "dependents": [],
3428
+ "dependents": [
3429
+ "ic-data-table"
3430
+ ],
4684
3431
  "dependencies": [
4685
- "ic-input-container",
4686
- "ic-input-label",
4687
- "ic-input-component-container",
4688
3432
  "ic-typography",
4689
- "ic-button",
4690
- "ic-menu-with-multi",
4691
- "ic-input-validation"
3433
+ "ic-select",
3434
+ "ic-pagination",
3435
+ "ic-tooltip",
3436
+ "ic-text-field",
3437
+ "ic-button"
4692
3438
  ],
4693
3439
  "dependencyGraph": {
4694
- "ic-select-with-multi": [
3440
+ "ic-pagination-bar": [
3441
+ "ic-typography",
3442
+ "ic-select",
3443
+ "ic-pagination",
3444
+ "ic-tooltip",
3445
+ "ic-text-field",
3446
+ "ic-button"
3447
+ ],
3448
+ "ic-select": [
4695
3449
  "ic-input-container",
4696
3450
  "ic-input-label",
4697
3451
  "ic-input-component-container",
4698
3452
  "ic-typography",
4699
3453
  "ic-button",
4700
- "ic-menu-with-multi",
3454
+ "ic-menu",
4701
3455
  "ic-input-validation"
4702
3456
  ],
4703
3457
  "ic-input-label": [
@@ -4713,13 +3467,30 @@
4713
3467
  "ic-tooltip": [
4714
3468
  "ic-typography"
4715
3469
  ],
4716
- "ic-menu-with-multi": [
3470
+ "ic-menu": [
4717
3471
  "ic-loading-indicator",
4718
3472
  "ic-typography",
4719
3473
  "ic-button"
4720
3474
  ],
4721
3475
  "ic-input-validation": [
4722
3476
  "ic-typography"
3477
+ ],
3478
+ "ic-pagination": [
3479
+ "ic-button",
3480
+ "ic-pagination-item"
3481
+ ],
3482
+ "ic-pagination-item": [
3483
+ "ic-typography"
3484
+ ],
3485
+ "ic-text-field": [
3486
+ "ic-input-container",
3487
+ "ic-input-label",
3488
+ "ic-input-component-container",
3489
+ "ic-input-validation",
3490
+ "ic-typography"
3491
+ ],
3492
+ "ic-data-table": [
3493
+ "ic-pagination-bar"
4723
3494
  ]
4724
3495
  }
4725
3496
  },
@@ -4767,6 +3538,28 @@
4767
3538
  "optional": true,
4768
3539
  "required": false
4769
3540
  },
3541
+ {
3542
+ "name": "expanded",
3543
+ "type": "boolean",
3544
+ "complexType": {
3545
+ "original": "boolean",
3546
+ "resolved": "boolean",
3547
+ "references": {}
3548
+ },
3549
+ "mutable": true,
3550
+ "attr": "expanded",
3551
+ "reflectToAttr": false,
3552
+ "docs": "If `true`, the tree item appears in the expanded state.",
3553
+ "docsTags": [],
3554
+ "default": "false",
3555
+ "values": [
3556
+ {
3557
+ "type": "boolean"
3558
+ }
3559
+ ],
3560
+ "optional": false,
3561
+ "required": false
3562
+ },
4770
3563
  {
4771
3564
  "name": "href",
4772
3565
  "type": "string",
@@ -4953,6 +3746,43 @@
4953
3746
  ],
4954
3747
  "optional": true,
4955
3748
  "required": false
3749
+ },
3750
+ {
3751
+ "name": "theme",
3752
+ "type": "\"dark\" | \"inherit\" | \"light\"",
3753
+ "complexType": {
3754
+ "original": "IcThemeMode",
3755
+ "resolved": "\"dark\" | \"inherit\" | \"light\"",
3756
+ "references": {
3757
+ "IcThemeMode": {
3758
+ "location": "import",
3759
+ "path": "@ukic/web-components",
3760
+ "id": "../web-components/dist/types/interface.d.ts::IcThemeMode"
3761
+ }
3762
+ }
3763
+ },
3764
+ "mutable": false,
3765
+ "attr": "theme",
3766
+ "reflectToAttr": false,
3767
+ "docs": "Sets the theme color to the dark or light theme color. \"inherit\" will set the color based on the system settings or ic-theme component.",
3768
+ "docsTags": [],
3769
+ "default": "\"inherit\"",
3770
+ "values": [
3771
+ {
3772
+ "value": "dark",
3773
+ "type": "string"
3774
+ },
3775
+ {
3776
+ "value": "inherit",
3777
+ "type": "string"
3778
+ },
3779
+ {
3780
+ "value": "light",
3781
+ "type": "string"
3782
+ }
3783
+ ],
3784
+ "optional": true,
3785
+ "required": false
4956
3786
  }
4957
3787
  ],
4958
3788
  "methods": [
@@ -5052,33 +3882,22 @@
5052
3882
  "usage": {},
5053
3883
  "props": [
5054
3884
  {
5055
- "name": "appearance",
5056
- "type": "\"dark\" | \"light\"",
3885
+ "name": "focusInset",
3886
+ "type": "boolean",
5057
3887
  "complexType": {
5058
- "original": "IcThemeForegroundNoDefault",
5059
- "resolved": "\"dark\" | \"light\"",
5060
- "references": {
5061
- "IcThemeForegroundNoDefault": {
5062
- "location": "import",
5063
- "path": "../../utils/types",
5064
- "id": "src/utils/types.ts::IcThemeForegroundNoDefault"
5065
- }
5066
- }
3888
+ "original": "boolean",
3889
+ "resolved": "boolean",
3890
+ "references": {}
5067
3891
  },
5068
3892
  "mutable": false,
5069
- "attr": "appearance",
3893
+ "attr": "focus-inset",
5070
3894
  "reflectToAttr": false,
5071
- "docs": "The appearance of the tree view, e.g. dark, or light.",
3895
+ "docs": "If `true`, tree items will have inset focus.",
5072
3896
  "docsTags": [],
5073
- "default": "\"dark\"",
3897
+ "default": "false",
5074
3898
  "values": [
5075
3899
  {
5076
- "value": "dark",
5077
- "type": "string"
5078
- },
5079
- {
5080
- "value": "light",
5081
- "type": "string"
3900
+ "type": "boolean"
5082
3901
  }
5083
3902
  ],
5084
3903
  "optional": true,
@@ -5142,6 +3961,43 @@
5142
3961
  ],
5143
3962
  "optional": true,
5144
3963
  "required": false
3964
+ },
3965
+ {
3966
+ "name": "theme",
3967
+ "type": "\"dark\" | \"inherit\" | \"light\"",
3968
+ "complexType": {
3969
+ "original": "IcThemeMode",
3970
+ "resolved": "\"dark\" | \"inherit\" | \"light\"",
3971
+ "references": {
3972
+ "IcThemeMode": {
3973
+ "location": "import",
3974
+ "path": "@ukic/web-components",
3975
+ "id": "../web-components/dist/types/interface.d.ts::IcThemeMode"
3976
+ }
3977
+ }
3978
+ },
3979
+ "mutable": false,
3980
+ "attr": "theme",
3981
+ "reflectToAttr": false,
3982
+ "docs": "Sets the theme color to the dark or light theme color. \"inherit\" will set the color based on the system settings or ic-theme component.",
3983
+ "docsTags": [],
3984
+ "default": "\"inherit\"",
3985
+ "values": [
3986
+ {
3987
+ "value": "dark",
3988
+ "type": "string"
3989
+ },
3990
+ {
3991
+ "value": "inherit",
3992
+ "type": "string"
3993
+ },
3994
+ {
3995
+ "value": "light",
3996
+ "type": "string"
3997
+ }
3998
+ ],
3999
+ "optional": true,
4000
+ "required": false
5145
4001
  }
5146
4002
  ],
5147
4003
  "methods": [],
@@ -5193,6 +4049,11 @@
5193
4049
  "docstring": "",
5194
4050
  "path": "src/components/ic-card-horizontal/ic-card-horizontal.types.ts"
5195
4051
  },
4052
+ "src/utils/types.ts::IcThemeMode": {
4053
+ "declaration": "export type IcThemeMode = \"dark\" | \"light\" | \"inherit\";",
4054
+ "docstring": "",
4055
+ "path": "src/utils/types.ts"
4056
+ },
5196
4057
  "src/components/ic-data-table/ic-data-table.types.tsx::IcDataTableColumnObject": {
5197
4058
  "declaration": "{\n key: string;\n title: string;\n dataType: IcDataTableColumnDataTypes;\n columnAlignment?: {\n horizontal?: string;\n vertical?: string;\n };\n rowOptions?: {\n textWrap: boolean;\n };\n columnWidth?: string | IcDataTableColumnWidthTypes;\n textWrap?: boolean;\n cellAlignment?: string;\n emphasis?: string;\n colspan?: number;\n icon?: {\n icon: string;\n onAllCells?: boolean;\n hideOnHeader?: boolean;\n };\n}",
5198
4059
  "docstring": "",
@@ -5219,7 +4080,7 @@
5219
4080
  "path": "../web-components/dist/types/utils/types.d.ts"
5220
4081
  },
5221
4082
  "src/utils/types.ts::IcPaginationBarOptions": {
5222
- "declaration": "export interface IcPaginationBarOptions {\n itemsPerPageOptions?: { label: string; value: string }[];\n rangeLabelType?: IcPaginationLabelTypes;\n type?: IcPaginationTypes;\n showItemsPerPageControl?: boolean;\n showGoToPageControl?: boolean;\n alignment?: IcPaginationAlignmentOptions;\n appearance?: IcThemeForeground;\n itemLabel?: string;\n pageLabel?: string;\n hideRangeLabel?: boolean;\n}",
4083
+ "declaration": "export interface IcPaginationBarOptions {\n itemsPerPageOptions?: { label: string; value: string }[];\n rangeLabelType?: IcPaginationLabelTypes;\n type?: IcPaginationTypes;\n showItemsPerPageControl?: boolean;\n showGoToPageControl?: boolean;\n alignment?: IcPaginationAlignmentOptions;\n itemLabel?: string;\n pageLabel?: string;\n hideRangeLabel?: boolean;\n hideAllFromItemsPerPage?: boolean;\n theme?: IcThemeMode;\n monochrome?: boolean;\n}",
5223
4084
  "docstring": "",
5224
4085
  "path": "src/utils/types.ts"
5225
4086
  },
@@ -5243,7 +4104,7 @@
5243
4104
  "docstring": "",
5244
4105
  "path": "../web-components/dist/types/components/ic-pagination/ic-pagination.types.d.ts"
5245
4106
  },
5246
- "../web-components/dist/types/interface.d.ts::IcThemeForeground": {
4107
+ "../web-components/dist/types/interface.d.ts::IcThemeMode": {
5247
4108
  "declaration": "any",
5248
4109
  "docstring": "",
5249
4110
  "path": "../web-components/dist/types/interface.d.ts"
@@ -5288,50 +4149,10 @@
5288
4149
  "docstring": "",
5289
4150
  "path": "src/utils/types.ts"
5290
4151
  },
5291
- "../web-components/dist/types/utils/types.d.ts::IcActivationTypes": {
5292
- "declaration": "export type IcActivationTypes = \"automatic\" | \"manual\";",
5293
- "docstring": "",
5294
- "path": "../web-components/dist/types/utils/types.d.ts"
5295
- },
5296
- "../web-components/dist/types/components.d.ts::IcSearchBarSearchModes": {
5297
- "declaration": "any",
5298
- "docstring": "",
5299
- "path": "../web-components/dist/types/components.d.ts"
5300
- },
5301
- "../web-components/dist/types/utils/types.d.ts::IcMenuOption": {
5302
- "declaration": "export interface IcMenuOption {\n description?: string;\n disabled?: boolean;\n recommended?: boolean;\n children?: IcMenuOption[];\n loading?: boolean;\n timedOut?: boolean;\n [key: string]: any;\n element?: {\n component: any;\n ariaLabel: string;\n };\n icon?: any;\n}",
5303
- "docstring": "",
5304
- "path": "../web-components/dist/types/utils/types.d.ts"
5305
- },
5306
- "../web-components/dist/types/components.d.ts::IcMenuOptionIdEventDetail": {
5307
- "declaration": "any",
5308
- "docstring": "",
5309
- "path": "../web-components/dist/types/components.d.ts"
5310
- },
5311
- "../web-components/dist/types/components.d.ts::IcOptionSelectEventDetail": {
5312
- "declaration": "any",
5313
- "docstring": "",
5314
- "path": "../web-components/dist/types/components.d.ts"
5315
- },
5316
- "../web-components/dist/types/components.d.ts::IcMenuChangeEventDetail": {
4152
+ "../web-components/dist/types/interface.d.ts::IcThemeMode": {
5317
4153
  "declaration": "any",
5318
4154
  "docstring": "",
5319
- "path": "../web-components/dist/types/components.d.ts"
5320
- },
5321
- "src/utils/types.ts::IcValueEventDetail": {
5322
- "declaration": "export interface IcValueEventDetail {\n value: string | string[];\n keyPressed?: string;\n}",
5323
- "docstring": "",
5324
- "path": "src/utils/types.ts"
5325
- },
5326
- "src/utils/types.ts::IcSearchMatchPositions": {
5327
- "declaration": "export type IcSearchMatchPositions = \"start\" | \"anywhere\";",
5328
- "docstring": "",
5329
- "path": "src/utils/types.ts"
5330
- },
5331
- "src/utils/types.ts::IcThemeForegroundNoDefault": {
5332
- "declaration": "export type IcThemeForegroundNoDefault = \"dark\" | \"light\";",
5333
- "docstring": "",
5334
- "path": "src/utils/types.ts"
4155
+ "path": "../web-components/dist/types/interface.d.ts"
5335
4156
  }
5336
4157
  }
5337
4158
  }