@ukic/canary-docs 2.0.0-canary.22 → 2.0.0-canary.23

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 +91 -3
  2. package/package.json +2 -2
package/docs.json CHANGED
@@ -752,7 +752,7 @@
752
752
  "reflectToAttr": false,
753
753
  "docs": "Sets the props for the built-in pagination bar. If the `pagination-bar` slot is used then this prop is ignored.",
754
754
  "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 }",
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 hideAllFromItemsPerPage: false,\n }",
756
756
  "values": [
757
757
  {
758
758
  "type": "IcPaginationBarOptions"
@@ -1679,6 +1679,28 @@
1679
1679
  "optional": false,
1680
1680
  "required": false
1681
1681
  },
1682
+ {
1683
+ "name": "hideLabel",
1684
+ "type": "boolean",
1685
+ "complexType": {
1686
+ "original": "boolean",
1687
+ "resolved": "boolean",
1688
+ "references": {}
1689
+ },
1690
+ "mutable": false,
1691
+ "attr": "hide-label",
1692
+ "reflectToAttr": false,
1693
+ "docs": "If `true`, the label will be visually hidden, but will still be read out by screen readers.",
1694
+ "docsTags": [],
1695
+ "default": "false",
1696
+ "values": [
1697
+ {
1698
+ "type": "boolean"
1699
+ }
1700
+ ],
1701
+ "optional": true,
1702
+ "required": false
1703
+ },
1682
1704
  {
1683
1705
  "name": "inputId",
1684
1706
  "type": "string",
@@ -2383,6 +2405,28 @@
2383
2405
  "optional": false,
2384
2406
  "required": false
2385
2407
  },
2408
+ {
2409
+ "name": "hideLabel",
2410
+ "type": "boolean",
2411
+ "complexType": {
2412
+ "original": "boolean",
2413
+ "resolved": "boolean",
2414
+ "references": {}
2415
+ },
2416
+ "mutable": false,
2417
+ "attr": "hide-label",
2418
+ "reflectToAttr": false,
2419
+ "docs": "If `true`, the label will be visually hidden, but the required label will still be read out by screen readers.",
2420
+ "docsTags": [],
2421
+ "default": "false",
2422
+ "values": [
2423
+ {
2424
+ "type": "boolean"
2425
+ }
2426
+ ],
2427
+ "optional": true,
2428
+ "required": false
2429
+ },
2386
2430
  {
2387
2431
  "name": "inputId",
2388
2432
  "type": "string",
@@ -3490,6 +3534,28 @@
3490
3534
  "optional": true,
3491
3535
  "required": false
3492
3536
  },
3537
+ {
3538
+ "name": "hideAllFromItemsPerPage",
3539
+ "type": "boolean",
3540
+ "complexType": {
3541
+ "original": "boolean",
3542
+ "resolved": "boolean",
3543
+ "references": {}
3544
+ },
3545
+ "mutable": false,
3546
+ "attr": "hide-all-from-items-per-page",
3547
+ "reflectToAttr": false,
3548
+ "docs": "If `true`, the 'All' option will be hidden from the 'items per page' select input.",
3549
+ "docsTags": [],
3550
+ "default": "false",
3551
+ "values": [
3552
+ {
3553
+ "type": "boolean"
3554
+ }
3555
+ ],
3556
+ "optional": true,
3557
+ "required": false
3558
+ },
3493
3559
  {
3494
3560
  "name": "hideRangeLabel",
3495
3561
  "type": "boolean",
@@ -3544,7 +3610,7 @@
3544
3610
  },
3545
3611
  "mutable": false,
3546
3612
  "reflectToAttr": false,
3547
- "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.",
3613
+ "docs": "The options which will be displayed for 'items per page' select input.",
3548
3614
  "docsTags": [],
3549
3615
  "values": [
3550
3616
  {
@@ -4944,6 +5010,28 @@
4944
5010
  "optional": true,
4945
5011
  "required": false
4946
5012
  },
5013
+ {
5014
+ "name": "expanded",
5015
+ "type": "boolean",
5016
+ "complexType": {
5017
+ "original": "boolean",
5018
+ "resolved": "boolean",
5019
+ "references": {}
5020
+ },
5021
+ "mutable": true,
5022
+ "attr": "expanded",
5023
+ "reflectToAttr": false,
5024
+ "docs": "If `true`, the tree item appears in the expanded state.",
5025
+ "docsTags": [],
5026
+ "default": "false",
5027
+ "values": [
5028
+ {
5029
+ "type": "boolean"
5030
+ }
5031
+ ],
5032
+ "optional": false,
5033
+ "required": false
5034
+ },
4947
5035
  {
4948
5036
  "name": "href",
4949
5037
  "type": "string",
@@ -5396,7 +5484,7 @@
5396
5484
  "path": "../web-components/dist/types/utils/types.d.ts"
5397
5485
  },
5398
5486
  "src/utils/types.ts::IcPaginationBarOptions": {
5399
- "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}",
5487
+ "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 hideAllFromItemsPerPage?: boolean;\n}",
5400
5488
  "docstring": "",
5401
5489
  "path": "src/utils/types.ts"
5402
5490
  },
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "author": "mi6",
3
3
  "name": "@ukic/canary-docs",
4
- "version": "2.0.0-canary.22",
4
+ "version": "2.0.0-canary.23",
5
5
  "description": "API documentation for @ukic canary 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": "3722eb9496a95846172a9a41c70055d75265cdd6"
21
+ "gitHead": "895517389cf1b33e002f4b72661792fd74ee4cbb"
22
22
  }