@ukic/docs 2.11.1 → 2.12.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/docs.json +74 -6
  2. package/package.json +2 -2
package/docs.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "timestamp": "2024-05-29T14:10:07",
2
+ "timestamp": "2024-06-24T09:26:04",
3
3
  "compiler": {
4
4
  "name": "@stencil/core",
5
5
  "version": "4.10.0",
@@ -2146,10 +2146,10 @@
2146
2146
  },
2147
2147
  {
2148
2148
  "name": "variant",
2149
- "type": "\"destructive\" | \"icon\" | \"primary\" | \"secondary\" | \"tertiary\"",
2149
+ "type": "\"destructive\" | \"icon\" | \"icon-destructive\" | \"icon-primary\" | \"icon-secondary\" | \"icon-tertiary\" | \"primary\" | \"secondary\" | \"tertiary\"",
2150
2150
  "complexType": {
2151
2151
  "original": "IcButtonVariants",
2152
- "resolved": "\"destructive\" | \"icon\" | \"primary\" | \"secondary\" | \"tertiary\"",
2152
+ "resolved": "\"destructive\" | \"icon\" | \"icon-destructive\" | \"icon-primary\" | \"icon-secondary\" | \"icon-tertiary\" | \"primary\" | \"secondary\" | \"tertiary\"",
2153
2153
  "references": {
2154
2154
  "IcButtonVariants": {
2155
2155
  "location": "import",
@@ -2173,6 +2173,22 @@
2173
2173
  "value": "icon",
2174
2174
  "type": "string"
2175
2175
  },
2176
+ {
2177
+ "value": "icon-destructive",
2178
+ "type": "string"
2179
+ },
2180
+ {
2181
+ "value": "icon-primary",
2182
+ "type": "string"
2183
+ },
2184
+ {
2185
+ "value": "icon-secondary",
2186
+ "type": "string"
2187
+ },
2188
+ {
2189
+ "value": "icon-tertiary",
2190
+ "type": "string"
2191
+ },
2176
2192
  {
2177
2193
  "value": "primary",
2178
2194
  "type": "string"
@@ -3092,7 +3108,7 @@
3092
3108
  "resolved": "string",
3093
3109
  "references": {}
3094
3110
  },
3095
- "mutable": false,
3111
+ "mutable": true,
3096
3112
  "attr": "group-label",
3097
3113
  "reflectToAttr": false,
3098
3114
  "docs": "The group label for the checkbox.",
@@ -3105,6 +3121,28 @@
3105
3121
  "optional": false,
3106
3122
  "required": false
3107
3123
  },
3124
+ {
3125
+ "name": "hideLabel",
3126
+ "type": "boolean",
3127
+ "complexType": {
3128
+ "original": "boolean",
3129
+ "resolved": "boolean",
3130
+ "references": {}
3131
+ },
3132
+ "mutable": false,
3133
+ "attr": "hide-label",
3134
+ "reflectToAttr": false,
3135
+ "docs": "If `true`, the label will be hidden and the required label value will be applied as an aria-label.",
3136
+ "docsTags": [],
3137
+ "default": "false",
3138
+ "values": [
3139
+ {
3140
+ "type": "boolean"
3141
+ }
3142
+ ],
3143
+ "optional": false,
3144
+ "required": false
3145
+ },
3108
3146
  {
3109
3147
  "name": "indeterminate",
3110
3148
  "type": "boolean",
@@ -3156,7 +3194,7 @@
3156
3194
  "resolved": "string",
3157
3195
  "references": {}
3158
3196
  },
3159
- "mutable": false,
3197
+ "mutable": true,
3160
3198
  "attr": "name",
3161
3199
  "reflectToAttr": false,
3162
3200
  "docs": "The name for the checkbox. If not set when used in a checkbox group, the name will be based on the group name.",
@@ -3169,6 +3207,28 @@
3169
3207
  "optional": false,
3170
3208
  "required": false
3171
3209
  },
3210
+ {
3211
+ "name": "nativeIndeterminateBehaviour",
3212
+ "type": "boolean",
3213
+ "complexType": {
3214
+ "original": "boolean",
3215
+ "resolved": "boolean",
3216
+ "references": {}
3217
+ },
3218
+ "mutable": false,
3219
+ "attr": "native-indeterminate-behaviour",
3220
+ "reflectToAttr": false,
3221
+ "docs": "If `true`, the checkbox will behave like a native checkbox where the `indeterminate` prop sets the indeterminate visual styling, independent of the `checked` state.",
3222
+ "docsTags": [],
3223
+ "default": "false",
3224
+ "values": [
3225
+ {
3226
+ "type": "boolean"
3227
+ }
3228
+ ],
3229
+ "optional": false,
3230
+ "required": false
3231
+ },
3172
3232
  {
3173
3233
  "name": "size",
3174
3234
  "type": "\"default\" | \"large\" | \"small\"",
@@ -8945,6 +9005,10 @@
8945
9005
  {
8946
9006
  "name": "slot",
8947
9007
  "text": "badge - Badge component overlaying the top right of the icon."
9008
+ },
9009
+ {
9010
+ "name": "slot",
9011
+ "text": "icon - Content will be displayed to the left of the label for expanded navigation items, and in replacement of the label for collapsed navigation items."
8948
9012
  }
8949
9013
  ],
8950
9014
  "usage": {},
@@ -9205,6 +9269,10 @@
9205
9269
  {
9206
9270
  "name": "badge",
9207
9271
  "docs": "Badge component overlaying the top right of the icon."
9272
+ },
9273
+ {
9274
+ "name": "icon",
9275
+ "docs": "Content will be displayed to the left of the label for expanded navigation items, and in replacement of the label for collapsed navigation items."
9208
9276
  }
9209
9277
  ],
9210
9278
  "parts": [
@@ -18814,7 +18882,7 @@
18814
18882
  "path": "src/components/ic-button/ic-button.types.ts"
18815
18883
  },
18816
18884
  "src/components/ic-button/ic-button.types.ts::IcButtonVariants": {
18817
- "declaration": "export type IcButtonVariants =\n | \"primary\"\n | \"secondary\"\n | \"tertiary\"\n | \"icon\"\n | \"destructive\";",
18885
+ "declaration": "export type IcButtonVariants =\n | \"primary\"\n | \"secondary\"\n | \"tertiary\"\n | \"destructive\"\n | \"icon\"\n | \"icon-primary\"\n | \"icon-secondary\"\n | \"icon-tertiary\"\n | \"icon-destructive\";",
18818
18886
  "docstring": "",
18819
18887
  "path": "src/components/ic-button/ic-button.types.ts"
18820
18888
  },
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "author": "mi6",
3
3
  "name": "@ukic/docs",
4
- "version": "2.11.1",
4
+ "version": "2.12.1",
5
5
  "description": "API documentation for @ukic components",
6
6
  "main": "docs.json",
7
7
  "types": "docs.d.ts",
@@ -18,5 +18,5 @@
18
18
  "email": "icds@gchq.gov.uk"
19
19
  },
20
20
  "license": "MIT",
21
- "gitHead": "5dd43dde5edbcd9f62e6fa706e762fd95ff19935"
21
+ "gitHead": "fc202d5fde5e93c4e744747d115d83d09901cf79"
22
22
  }