@ukic/docs 2.1.0-beta.13 → 2.1.0-beta.15

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 +59 -14
  2. package/package.json +2 -2
package/docs.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "timestamp": "2023-05-16T15:37:47",
2
+ "timestamp": "2023-06-05T08:44:12",
3
3
  "compiler": {
4
4
  "name": "@stencil/core",
5
5
  "version": "2.20.0",
@@ -5673,6 +5673,23 @@
5673
5673
  "optional": false,
5674
5674
  "required": false
5675
5675
  },
5676
+ {
5677
+ "name": "currentPage",
5678
+ "type": "number",
5679
+ "mutable": true,
5680
+ "attr": "current-page",
5681
+ "reflectToAttr": false,
5682
+ "docs": "The current page displayed by the pagination.",
5683
+ "docsTags": [],
5684
+ "default": "this.defaultPage",
5685
+ "values": [
5686
+ {
5687
+ "type": "number"
5688
+ }
5689
+ ],
5690
+ "optional": false,
5691
+ "required": false
5692
+ },
5676
5693
  {
5677
5694
  "name": "defaultPage",
5678
5695
  "type": "number",
@@ -5797,7 +5814,19 @@
5797
5814
  "required": false
5798
5815
  }
5799
5816
  ],
5800
- "methods": [],
5817
+ "methods": [
5818
+ {
5819
+ "name": "setCurrentPage",
5820
+ "returns": {
5821
+ "type": "Promise<void>",
5822
+ "docs": ""
5823
+ },
5824
+ "signature": "setCurrentPage(page: number) => Promise<void>",
5825
+ "parameters": [],
5826
+ "docs": "Sets the currently displayed page.",
5827
+ "docsTags": []
5828
+ }
5829
+ ],
5801
5830
  "events": [
5802
5831
  {
5803
5832
  "event": "icPageChange",
@@ -7608,7 +7637,7 @@
7608
7637
  "mutable": false,
7609
7638
  "attr": "disable-filter",
7610
7639
  "reflectToAttr": false,
7611
- "docs": "Specify whether to disable the built in filtering for a searchable variant. For example, if options will already be filtered from external source.",
7640
+ "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.",
7612
7641
  "docsTags": [],
7613
7642
  "default": "false",
7614
7643
  "values": [
@@ -7760,7 +7789,7 @@
7760
7789
  "mutable": true,
7761
7790
  "attr": "loading",
7762
7791
  "reflectToAttr": false,
7763
- "docs": "Trigger loading state when fetching options asyncronously",
7792
+ "docs": "If `true`, the loading state will be triggered when fetching options asyncronously.",
7764
7793
  "docsTags": [],
7765
7794
  "default": "false",
7766
7795
  "values": [
@@ -7777,7 +7806,7 @@
7777
7806
  "mutable": false,
7778
7807
  "attr": "loading-error-label",
7779
7808
  "reflectToAttr": false,
7780
- "docs": "Change the message displayed when external loading times out.",
7809
+ "docs": "The message displayed when external loading times out.",
7781
7810
  "docsTags": [],
7782
7811
  "default": "\"Loading Error\"",
7783
7812
  "values": [
@@ -7794,7 +7823,7 @@
7794
7823
  "mutable": false,
7795
7824
  "attr": "loading-label",
7796
7825
  "reflectToAttr": false,
7797
- "docs": "Change the message displayed whilst the options are being loaded externally.",
7826
+ "docs": "The message displayed whilst the options are being loaded externally.",
7798
7827
  "docsTags": [],
7799
7828
  "default": "\"Loading...\"",
7800
7829
  "values": [
@@ -8030,7 +8059,7 @@
8030
8059
  "mutable": true,
8031
8060
  "attr": "value",
8032
8061
  "reflectToAttr": false,
8033
- "docs": "The value of the currently selected option.",
8062
+ "docs": "The value of the select, reflected by the value of the currently selected option. For the searchable variant, the value is also reflected by the user input.",
8034
8063
  "docsTags": [],
8035
8064
  "values": [
8036
8065
  {
@@ -8061,7 +8090,7 @@
8061
8090
  "bubbles": true,
8062
8091
  "cancelable": true,
8063
8092
  "composed": true,
8064
- "docs": "Emitted when select loses focus.",
8093
+ "docs": "Emitted when the select loses focus.",
8065
8094
  "docsTags": []
8066
8095
  },
8067
8096
  {
@@ -8079,7 +8108,7 @@
8079
8108
  "bubbles": true,
8080
8109
  "cancelable": true,
8081
8110
  "composed": true,
8082
- "docs": "Emitted when clear button clicked.",
8111
+ "docs": "Emitted when the clear button is clicked.",
8083
8112
  "docsTags": []
8084
8113
  },
8085
8114
  {
@@ -8088,7 +8117,7 @@
8088
8117
  "bubbles": true,
8089
8118
  "cancelable": true,
8090
8119
  "composed": true,
8091
- "docs": "Emitted when select gains focus.",
8120
+ "docs": "Emitted when the select gains focus.",
8092
8121
  "docsTags": []
8093
8122
  },
8094
8123
  {
@@ -8106,7 +8135,7 @@
8106
8135
  "bubbles": true,
8107
8136
  "cancelable": true,
8108
8137
  "composed": true,
8109
- "docs": "Emitted when option is highlighted within the menu.\nHighlighting a menu item will trigger an `icChange/onIcChange` due to the value being updated.",
8138
+ "docs": "Emitted when an option is highlighted within the menu.\nHighlighting a menu item will also trigger an `icChange/onIcChange` due to the value being updated.",
8110
8139
  "docsTags": []
8111
8140
  },
8112
8141
  {
@@ -8115,7 +8144,7 @@
8115
8144
  "bubbles": true,
8116
8145
  "cancelable": true,
8117
8146
  "composed": true,
8118
- "docs": "Emitted when the 'retry loading' button is clicked",
8147
+ "docs": "Emitted when the 'retry loading' button is clicked for a searchable variant.",
8119
8148
  "docsTags": []
8120
8149
  }
8121
8150
  ],
@@ -9190,7 +9219,7 @@
9190
9219
  {
9191
9220
  "event": "icTabSelect",
9192
9221
  "detail": "IcTabSelectEventDetail",
9193
- "bubbles": true,
9222
+ "bubbles": false,
9194
9223
  "cancelable": true,
9195
9224
  "composed": true,
9196
9225
  "docs": "Emitted when a user selects a tab.",
@@ -9199,7 +9228,7 @@
9199
9228
  {
9200
9229
  "event": "tabSelect",
9201
9230
  "detail": "IcTabSelectEventDetail",
9202
- "bubbles": true,
9231
+ "bubbles": false,
9203
9232
  "cancelable": true,
9204
9233
  "composed": true,
9205
9234
  "docs": "",
@@ -11029,6 +11058,22 @@
11029
11058
  "optional": true,
11030
11059
  "required": false
11031
11060
  },
11061
+ {
11062
+ "name": "maxLines",
11063
+ "type": "number",
11064
+ "mutable": false,
11065
+ "attr": "max-lines",
11066
+ "reflectToAttr": false,
11067
+ "docs": "The number of lines to display before truncating the text, only used for the 'body' variant.",
11068
+ "docsTags": [],
11069
+ "values": [
11070
+ {
11071
+ "type": "number"
11072
+ }
11073
+ ],
11074
+ "optional": true,
11075
+ "required": false
11076
+ },
11032
11077
  {
11033
11078
  "name": "variant",
11034
11079
  "type": "\"body\" | \"caption\" | \"caption-uppercase\" | \"code-extra-small\" | \"code-large\" | \"code-small\" | \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"label\" | \"label-uppercase\" | \"subtitle-large\" | \"subtitle-small\"",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ukic/docs",
3
- "version": "2.1.0-beta.13",
3
+ "version": "2.1.0-beta.15",
4
4
  "description": "API documentation for @ukic components",
5
5
  "main": "docs.json",
6
6
  "types": "docs.d.ts",
@@ -9,5 +9,5 @@
9
9
  "docs.d.ts"
10
10
  ],
11
11
  "license": "MIT",
12
- "gitHead": "7664d68763eab819ccf264f23a36a2390d45c22e"
12
+ "gitHead": "6d62b7b3236a74ffcc29cfdbf13cd792c649874a"
13
13
  }