@arcgis/map-components 5.2.0-next.87 → 5.2.0-next.88

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 (131) hide show
  1. package/dist/cdn/{IOZ5U2X7.js → 2GQ6KVNI.js} +1 -1
  2. package/dist/cdn/3CFRD2EN.js +2 -0
  3. package/dist/cdn/{7IWMEBK6.js → 6BNYO33V.js} +1 -1
  4. package/dist/cdn/{3IY3D62Z.js → JXBEE5GW.js} +1 -1
  5. package/dist/cdn/JZC42PXS.js +2 -0
  6. package/dist/cdn/NB5DQKQY.js +2 -0
  7. package/dist/cdn/TRFWUKXA.js +2 -0
  8. package/dist/cdn/index.js +1 -1
  9. package/dist/components/arcgis-area-measurement-2d/customElement.d.ts +10 -0
  10. package/dist/components/arcgis-area-measurement-3d/customElement.d.ts +10 -0
  11. package/dist/components/arcgis-attachments/customElement.d.ts +10 -0
  12. package/dist/components/arcgis-basemap-gallery/customElement.d.ts +10 -0
  13. package/dist/components/arcgis-basemap-layer-list/customElement.d.ts +23 -0
  14. package/dist/components/arcgis-basemap-layer-list-next/customElement.d.ts +604 -51
  15. package/dist/components/arcgis-basemap-layer-list-next/customElement.js +2 -2
  16. package/dist/components/arcgis-basemap-layer-list-next/types.d.ts +39 -0
  17. package/dist/components/arcgis-basemap-toggle/customElement.d.ts +10 -0
  18. package/dist/components/arcgis-bookmarks/customElement.d.ts +20 -0
  19. package/dist/components/arcgis-building-explorer/customElement.d.ts +10 -0
  20. package/dist/components/arcgis-catalog-layer-list/customElement.d.ts +23 -0
  21. package/dist/components/arcgis-catalog-layer-list-next/customElement.d.ts +433 -59
  22. package/dist/components/arcgis-catalog-layer-list-next/customElement.js +2 -2
  23. package/dist/components/arcgis-catalog-layer-list-next/types.d.ts +41 -6
  24. package/dist/components/arcgis-compass/customElement.d.ts +10 -0
  25. package/dist/components/arcgis-coordinate-conversion/customElement.d.ts +10 -0
  26. package/dist/components/arcgis-coordinate-conversion-next/customElement.d.ts +10 -0
  27. package/dist/components/arcgis-daylight/customElement.d.ts +10 -0
  28. package/dist/components/arcgis-direct-line-measurement-3d/customElement.d.ts +10 -0
  29. package/dist/components/arcgis-directional-pad/customElement.d.ts +10 -0
  30. package/dist/components/arcgis-directions/customElement.d.ts +10 -0
  31. package/dist/components/arcgis-distance-measurement-2d/customElement.d.ts +10 -0
  32. package/dist/components/arcgis-editor/customElement.d.ts +10 -0
  33. package/dist/components/arcgis-elevation-profile/customElement.d.ts +10 -0
  34. package/dist/components/arcgis-expand/customElement.d.ts +10 -0
  35. package/dist/components/arcgis-feature/customElement.d.ts +10 -0
  36. package/dist/components/arcgis-feature-form/customElement.d.ts +10 -0
  37. package/dist/components/arcgis-feature-next/customElement.d.ts +32 -1
  38. package/dist/components/arcgis-feature-table/customElement.d.ts +10 -0
  39. package/dist/components/arcgis-feature-templates/customElement.d.ts +10 -0
  40. package/dist/components/arcgis-feature-templates-legacy/customElement.d.ts +10 -0
  41. package/dist/components/arcgis-features/customElement.d.ts +20 -0
  42. package/dist/components/arcgis-features-next/customElement.d.ts +32 -1
  43. package/dist/components/arcgis-features-next/customElement.js +1 -1
  44. package/dist/components/arcgis-floor-filter/customElement.d.ts +10 -0
  45. package/dist/components/arcgis-grid-controls/customElement.d.ts +10 -0
  46. package/dist/components/arcgis-histogram-range-slider/customElement.d.ts +10 -0
  47. package/dist/components/arcgis-home/customElement.d.ts +10 -0
  48. package/dist/components/arcgis-layer-list/customElement.d.ts +20 -0
  49. package/dist/components/arcgis-layer-list-next/customElement.d.ts +285 -123
  50. package/dist/components/arcgis-layer-list-next/customElement.js +2 -3
  51. package/dist/components/arcgis-layer-list-next/types.d.ts +44 -6
  52. package/dist/components/arcgis-legend/customElement.d.ts +10 -0
  53. package/dist/components/arcgis-line-of-sight/customElement.d.ts +10 -0
  54. package/dist/components/arcgis-link-chart/customElement.d.ts +10 -0
  55. package/dist/components/arcgis-link-chart-layout-switcher/customElement.d.ts +10 -0
  56. package/dist/components/arcgis-link-chart-nonspatial-visibility-toggle/customElement.d.ts +10 -0
  57. package/dist/components/arcgis-locate/customElement.d.ts +10 -0
  58. package/dist/components/arcgis-map/customElement.d.ts +10 -0
  59. package/dist/components/arcgis-measurement/customElement.d.ts +10 -0
  60. package/dist/components/arcgis-multi-feature-form/customElement.d.ts +25 -1
  61. package/dist/components/arcgis-navigation-toggle/customElement.d.ts +10 -0
  62. package/dist/components/arcgis-oriented-imagery-viewer/customElement.d.ts +10 -0
  63. package/dist/components/arcgis-oriented-imagery-viewer-panoramic-viewer-zoom/customElement.d.ts +10 -0
  64. package/dist/components/arcgis-paste/customElement.d.ts +10 -0
  65. package/dist/components/arcgis-popup/customElement.d.ts +20 -0
  66. package/dist/components/arcgis-popup/customElement.js +1 -1
  67. package/dist/components/arcgis-presentation/customElement.d.ts +10 -0
  68. package/dist/components/arcgis-presentation/customElement.js +70 -71
  69. package/dist/components/arcgis-print/customElement.d.ts +10 -0
  70. package/dist/components/arcgis-scale-bar/customElement.d.ts +10 -0
  71. package/dist/components/arcgis-scale-range-slider/customElement.d.ts +10 -0
  72. package/dist/components/arcgis-scene/customElement.d.ts +10 -0
  73. package/dist/components/arcgis-search/customElement.d.ts +10 -0
  74. package/dist/components/arcgis-search-result-renderer/customElement.d.ts +10 -0
  75. package/dist/components/arcgis-selection-toolbar/customElement.d.ts +10 -0
  76. package/dist/components/arcgis-shadow-cast/customElement.d.ts +10 -0
  77. package/dist/components/arcgis-sketch/customElement.d.ts +10 -0
  78. package/dist/components/arcgis-slice/customElement.d.ts +10 -0
  79. package/dist/components/arcgis-slider-binary-color-size-legacy/customElement.d.ts +10 -0
  80. package/dist/components/arcgis-slider-classed-color-legacy/customElement.d.ts +10 -0
  81. package/dist/components/arcgis-slider-classed-size-legacy/customElement.d.ts +10 -0
  82. package/dist/components/arcgis-slider-color-legacy/customElement.d.ts +10 -0
  83. package/dist/components/arcgis-slider-color-size-legacy/customElement.d.ts +10 -0
  84. package/dist/components/arcgis-slider-heatmap-legacy/customElement.d.ts +10 -0
  85. package/dist/components/arcgis-slider-opacity-legacy/customElement.d.ts +10 -0
  86. package/dist/components/arcgis-slider-scale-range/customElement.d.ts +10 -0
  87. package/dist/components/arcgis-slider-size-legacy/customElement.d.ts +10 -0
  88. package/dist/components/arcgis-snapping-controls/customElement.d.ts +10 -0
  89. package/dist/components/arcgis-swipe/customElement.d.ts +10 -0
  90. package/dist/components/arcgis-table-list/customElement.d.ts +102 -15
  91. package/dist/components/arcgis-table-list-next/customElement.d.ts +310 -44
  92. package/dist/components/arcgis-table-list-next/customElement.js +2 -3
  93. package/dist/components/arcgis-table-list-next/types.d.ts +37 -0
  94. package/dist/components/arcgis-time-bar/customElement.d.ts +10 -0
  95. package/dist/components/arcgis-time-bar-slider/customElement.d.ts +10 -0
  96. package/dist/components/arcgis-time-slider/customElement.d.ts +10 -0
  97. package/dist/components/arcgis-track/customElement.d.ts +10 -0
  98. package/dist/components/arcgis-utility-network-aggregated-geometry/customElement.d.ts +10 -0
  99. package/dist/components/arcgis-utility-network-aggregated-geometry-result-item/customElement.d.ts +10 -0
  100. package/dist/components/arcgis-utility-network-associations/customElement.d.ts +10 -0
  101. package/dist/components/arcgis-utility-network-trace/customElement.d.ts +10 -0
  102. package/dist/components/arcgis-utility-network-trace-analysis/customElement.d.ts +10 -0
  103. package/dist/components/arcgis-utility-network-trace-analysis-next/customElement.d.ts +10 -0
  104. package/dist/components/arcgis-utility-network-trace-inputs/customElement.d.ts +10 -0
  105. package/dist/components/arcgis-utility-network-trace-inputs-next/customElement.d.ts +10 -0
  106. package/dist/components/arcgis-utility-network-trace-location/customElement.d.ts +10 -0
  107. package/dist/components/arcgis-utility-network-trace-location-next/customElement.d.ts +10 -0
  108. package/dist/components/arcgis-utility-network-trace-results/customElement.d.ts +10 -0
  109. package/dist/components/arcgis-utility-network-trace-results-next/customElement.d.ts +10 -0
  110. package/dist/components/arcgis-utility-network-validate-topology/customElement.d.ts +10 -0
  111. package/dist/components/arcgis-value-picker-legacy/customElement.d.ts +10 -0
  112. package/dist/components/arcgis-version-management/customElement.d.ts +10 -0
  113. package/dist/components/arcgis-video/customElement.d.ts +10 -0
  114. package/dist/components/arcgis-video-player/customElement.d.ts +10 -0
  115. package/dist/components/arcgis-volume-measurement/customElement.d.ts +22 -1
  116. package/dist/components/arcgis-weather/customElement.d.ts +10 -0
  117. package/dist/components/arcgis-zoom/customElement.d.ts +10 -0
  118. package/dist/docs/api.json +1 -1
  119. package/dist/docs/docs.json +1 -1
  120. package/dist/docs/vscode.html-custom-data.json +1 -1
  121. package/dist/docs/web-types.json +1 -1
  122. package/dist/loader.js +1 -1
  123. package/dist/types/lumina.d.ts +1 -1
  124. package/dist/types/preact.d.ts +1 -1
  125. package/dist/types/react.d.ts +1 -1
  126. package/dist/types/stencil.d.ts +1 -1
  127. package/package.json +5 -5
  128. package/dist/cdn/3UUQJCZL.js +0 -2
  129. package/dist/cdn/FZHWZNBO.js +0 -2
  130. package/dist/cdn/TCMRGJTC.js +0 -2
  131. package/dist/cdn/TUTTPXC5.js +0 -2
@@ -1,6 +1,5 @@
1
1
  /// <reference path="../../index.d.ts" />
2
2
  import type Collection from "@arcgis/core/core/Collection.js";
3
- import type Layer from "@arcgis/core/layers/Layer.js";
4
3
  import type LinkChartView from "@arcgis/core/views/LinkChartView.js";
5
4
  import type MapView from "@arcgis/core/views/MapView.js";
6
5
  import type SceneView from "@arcgis/core/views/SceneView.js";
@@ -8,20 +7,22 @@ import type TableItemCollection from "@arcgis/core/layers/list/TableItemCollecti
8
7
  import type TableItem from "@arcgis/core/layers/list/TableItem.js";
9
8
  import type WebMap from "@arcgis/core/WebMap.js";
10
9
  import type WebScene from "@arcgis/core/WebScene.js";
10
+ import type Layer from "@arcgis/core/layers/Layer.js";
11
11
  import type Sublayer from "@arcgis/core/layers/support/Sublayer.js";
12
12
  import type { TableItemCollectionEvents, TableItemModifier } from "@arcgis/core/layers/list/TableItemCollection.js";
13
13
  import type { PublicLitElement as LitElement } from "@arcgis/lumina";
14
14
  import type { ArcgisReferenceElement, HeadingLevel, IconName } from "../types.js";
15
+ import type { CanSortFunction, FilterPredicate } from "./types.js";
15
16
  import type { T9nMeta } from "@arcgis/lumina/controllers";
16
17
  import type { List as List } from "@esri/calcite-components/components/calcite-list";
17
18
  import type { ReadonlyCollection } from "@arcgis/core/core/Collection.js";
18
19
 
19
- export type TableListOptions = Partial<Pick<ArcgisTableListNext, "collapsed" | "dragEnabled" | "filterPlaceholder" | "filterText" | "headingLevel" | "hideStatusIndicators" | "icon" | "label" | "minFilterItems" | "selectionMode" | "showErrors" | "showFilter" | "showTemporaryTableIndicators">>
20
- & {
21
- listItemCreatedFunction?: TableItemCollection["listItemCreatedFunction"];
22
- };
23
-
24
20
  /**
21
+ * > [!WARNING]
22
+ * > The Table List (next) component is the successor to the Table List component, provided to you early for testing and feedback.
23
+ * In version 6.0, the implementation of [arcgis-table-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/) will be updated under the hood to that of [arcgis-table-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/),
24
+ * and this component will be removed. To update at version 6.0, simply remove `-next` from the component name.
25
+ *
25
26
  * The Table List (next) component provides a way to display a list of tables associated with a map or table collection.
26
27
  * It is the direct component migration of the TableList widget and is provided early for testing and feedback.
27
28
  *
@@ -37,64 +38,175 @@ export abstract class ArcgisTableListNext extends LitElement {
37
38
  * prevent memory leaks.
38
39
  *
39
40
  * @default false
41
+ * @example
42
+ *
43
+ * ```html
44
+ * <arcgis-table-list-next auto-destroy-disabled></arcgis-table-list-next>
45
+ * ```
46
+ *
47
+ * ```js
48
+ * tableListNextElement.autoDestroyDisabled = true;
49
+ * ```
50
+ *
40
51
  */
41
52
  accessor autoDestroyDisabled: boolean;
42
53
  /**
43
54
  * Indicates whether a component is closed. When `true`, the component will be hidden.
44
55
  *
45
56
  * @default false
57
+ * @example
58
+ *
59
+ * ```html
60
+ * <arcgis-table-list-next closed></arcgis-table-list-next>
61
+ * ```
62
+ *
63
+ * ```js
64
+ * tableListNextElement.closed = true;
65
+ * ```
66
+ *
46
67
  */
47
68
  accessor closed: boolean;
48
69
  /**
49
- * Indicates whether the component is collapsed.
70
+ * Indicates whether the component is collapsed. When collapsed, only the collapse button and heading are displayed.
50
71
  *
51
72
  * @default false
73
+ * @example
74
+ *
75
+ * ```html
76
+ * <arcgis-table-list-next collapsed></arcgis-table-list-next>
77
+ * ```
78
+ *
79
+ * ```js
80
+ * tableListNextElement.collapsed = true;
81
+ * ```
82
+ *
52
83
  */
53
84
  accessor collapsed: boolean;
54
85
  /**
55
- * Indicates whether list items may be reordered by dragging and dropping.
86
+ * Indicates whether [items](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/) may be reordered within the list by dragging and dropping. MapImageLayer [MapImageLayer#sublayers](https://developers.arcgis.com/javascript/latest/references/core/layers/MapImageLayer/#sublayers) can be reordered only within their parent MapImageLayer and can not be dragged out as a separate layer. Drag and drop won't be enabled until the number of list items is equal to or greater than than the value set set in [minDragEnabledItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/#minDragEnabledItems).
56
87
  *
57
88
  * @default false
89
+ * @example
90
+ *
91
+ * ```html
92
+ * <arcgis-table-list-next drag-enabled></arcgis-table-list-next>
93
+ * ```
94
+ *
95
+ * ```js
96
+ * tableListNextElement.dragEnabled = true;
97
+ * ```
98
+ *
58
99
  */
59
100
  accessor dragEnabled: boolean;
60
101
  /**
61
- * Placeholder text used in the filter input if showFilter is true.
102
+ * Placeholder text used in the filter input when filtering is enabled.
62
103
  *
63
104
  * @default ""
105
+ * @example
106
+ *
107
+ * ```html
108
+ * <arcgis-table-list-next filter-placeholder="Search..."></arcgis-table-list-next>
109
+ * ```
110
+ *
111
+ * ```js
112
+ * tableListNextElement.filterPlaceholder = "Search...";
113
+ * ```
114
+ *
64
115
  */
65
116
  accessor filterPlaceholder: string;
66
- /** Specifies a function to handle filtering list items. */
117
+ /**
118
+ * Specifies a function to determine whether a list item should be included in filter results.
119
+ *
120
+ * @example
121
+ *
122
+ *
123
+ * ```js
124
+ * tableListNextElement.filterPredicate = (item) => item.title.toLowerCase().includes("streets");
125
+ * ```
126
+ *
127
+ */
67
128
  accessor filterPredicate: FilterPredicate | undefined;
68
129
  /**
69
- * The value of the filter input text string if showFilter is true.
130
+ * The value of the filter input text string when filtering is enabled.
70
131
  *
71
132
  * @default ""
133
+ * @example
134
+ *
135
+ *
136
+ * ```js
137
+ * tableListNextElement.filterText =
138
+ * reactiveUtils.watch(
139
+ * () => tableListNext.filterText,
140
+ * (filterText) => console.log(filterText)
141
+ * );
142
+ * ;
143
+ * ```
144
+ *
72
145
  */
73
146
  accessor filterText: string;
74
147
  /**
75
- * Indicates the heading level to use for the heading of the component.
148
+ * Indicates the heading level to use for the heading of the component. By default, the heading is rendered as a `<h2>`. Depending on the component's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.
76
149
  *
77
150
  * @default 2
151
+ * @see [HTML heading elements](https://developer.mozilla.org/docs/Web/HTML/Element/Heading_Elements)
152
+ * @example
153
+ *
154
+ * ```html
155
+ * <arcgis-table-list-next heading-level="2"></arcgis-table-list-next>
156
+ * ```
157
+ *
158
+ * ```js
159
+ * tableListNextElement.headingLevel = 2;
160
+ * ```
161
+ *
78
162
  */
79
163
  accessor headingLevel: HeadingLevel;
80
164
  /**
81
- * This property provides the ability to show or hide the no items to display notice when there are no filter results.
165
+ * Indicates whether to hide the notice that appears when no results are found after filtering.
82
166
  *
83
167
  * @default false
84
- * @since 5.2
168
+ * @example
169
+ *
170
+ * ```html
171
+ * <arcgis-table-list-next hide-no-filter-results-notice></arcgis-table-list-next>
172
+ * ```
173
+ *
174
+ * ```js
175
+ * tableListNextElement.hideNoFilterResultsNotice = true;
176
+ * ```
177
+ *
85
178
  */
86
179
  accessor hideNoFilterResultsNotice: boolean;
87
180
  /**
88
- * This property provides the ability to show or hide the no items to display notice.
181
+ * Indicates whether to hide the notice that appears when there are no items to display.
89
182
  *
90
183
  * @default false
91
- * @since 5.2
184
+ * @example
185
+ *
186
+ * ```html
187
+ * <arcgis-table-list-next hide-no-items-notice></arcgis-table-list-next>
188
+ * ```
189
+ *
190
+ * ```js
191
+ * tableListNextElement.hideNoItemsNotice = true;
192
+ * ```
193
+ *
92
194
  */
93
195
  accessor hideNoItemsNotice: boolean;
94
196
  /**
95
- * Indicates whether the status indicators will be hidden.
197
+ * Indicates whether to hide status indicators in the component.
96
198
  *
97
199
  * @default false
200
+ * @example
201
+ *
202
+ * ```html
203
+ * <arcgis-table-list-next hide-status-indicators></arcgis-table-list-next>
204
+ * ```
205
+ *
206
+ * ```js
207
+ * tableListNextElement.hideStatusIndicators = true;
208
+ * ```
209
+ *
98
210
  */
99
211
  accessor hideStatusIndicators: boolean;
100
212
  /**
@@ -111,7 +223,37 @@ export abstract class ArcgisTableListNext extends LitElement {
111
223
  accessor listItemCanGiveFunction: CanSortFunction | undefined;
112
224
  /** @internal */
113
225
  accessor listItemCanReceiveFunction: CanSortFunction | undefined;
114
- /** Specifies a function that accesses each list item as it is created. */
226
+ /**
227
+ * A function that executes each time a list item is created. Use this function to configure the list item, including its title, actions, and panels.
228
+ *
229
+ * @example
230
+ *
231
+ *
232
+ * ```js
233
+ * tableListNextElement.listItemCreatedFunction = async (event) => {
234
+ * // Destructure the item from the event object
235
+ * const {item} = event;
236
+ *
237
+ * // Wait for the layer to load and the item title to become available
238
+ * await item.layer.when();
239
+ *
240
+ * // If the item's title matches "US Demographics", customize the list item
241
+ * if (item.title === "US Demographics") {
242
+ * // open the list item in the LayerList component
243
+ * item.open = true;
244
+ * // change the title to something more descriptive
245
+ * item.title = "Population by county";
246
+ * // set an action for zooming to the full extent of the layer
247
+ * item.actionsSections = [[{
248
+ * title: "Go to full extent",
249
+ * icon: "zoom-out-fixed",
250
+ * id: "full-extent"
251
+ * }]];
252
+ * }
253
+ * };;
254
+ * ```
255
+ *
256
+ */
115
257
  accessor listItemCreatedFunction: TableItemModifier | null | undefined;
116
258
  /**
117
259
  * Specifies whether to ignore the [listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) property to display all layers. A common use case for `listModeDisabled` is when you want to use the component to manage and configure a layer's `listMode` value.
@@ -119,11 +261,25 @@ export abstract class ArcgisTableListNext extends LitElement {
119
261
  * @default false
120
262
  * @see [listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode)
121
263
  * @since 5.2
264
+ * @example
265
+ *
266
+ * ```html
267
+ * <arcgis-table-list-next list-mode-disabled></arcgis-table-list-next>
268
+ * ```
269
+ *
270
+ * ```js
271
+ * tableListNextElement.listModeDisabled = true;
272
+ * ```
273
+ *
122
274
  */
123
275
  accessor listModeDisabled: boolean;
124
276
  /** A reference to a map containing the tables. */
125
277
  accessor map: WebMap | WebScene | null | undefined;
126
- /** Overwrite localized strings for this component. */
278
+ /**
279
+ * Replace localized message strings with your own strings.
280
+ *
281
+ * _**Note**: Individual message keys may change between releases._
282
+ */
127
283
  accessor messageOverrides: {
128
284
  componentLabel?: string | undefined;
129
285
  back?: string | undefined;
@@ -161,12 +317,32 @@ export abstract class ArcgisTableListNext extends LitElement {
161
317
  * The minimum number of list items required to enable drag and drop reordering.
162
318
  *
163
319
  * @default 2
320
+ * @example
321
+ *
322
+ * ```html
323
+ * <arcgis-table-list-next min-drag-enabled-items="5"></arcgis-table-list-next>
324
+ * ```
325
+ *
326
+ * ```js
327
+ * tableListNextElement.minDragEnabledItems = 5;
328
+ * ```
329
+ *
164
330
  */
165
331
  accessor minDragEnabledItems: number;
166
332
  /**
167
333
  * The minimum number of list items required to display the filter input box.
168
334
  *
169
335
  * @default 10
336
+ * @example
337
+ *
338
+ * ```html
339
+ * <arcgis-table-list-next min-filter-items="3"></arcgis-table-list-next>
340
+ * ```
341
+ *
342
+ * ```js
343
+ * tableListNextElement.minFilterItems = 3;
344
+ * ```
345
+ *
170
346
  */
171
347
  accessor minFilterItems: number;
172
348
  /**
@@ -175,55 +351,157 @@ export abstract class ArcgisTableListNext extends LitElement {
175
351
  * @see [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
176
352
  */
177
353
  accessor referenceElement: ArcgisReferenceElement | string | undefined;
178
- /** A collection of selected table list items. */
354
+ /**
355
+ * A collection of selected [items](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/) in the list. This collection is updated when the user changes selection and is only populated when [selectionMode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/#selectionMode) is not set to `"none"`.
356
+ *
357
+ * @see [selectionMode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/#selectionMode)
358
+ * @example
359
+ * ```js
360
+ * reactiveUtils.watch(
361
+ * () => tableListNext.selectedItems?.at(0)?.layer,
362
+ * (layer) => {
363
+ * layer && handleLayerSelection(layer);
364
+ * },
365
+ * );
366
+ * ```
367
+ */
179
368
  accessor selectedItems: Collection<TableItem>;
180
369
  /**
181
- * Specifies the selection mode.
370
+ * Specifies the selection mode. Selected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/#selectedItems) property.
371
+ *
372
+ * | Value | Description |
373
+ * | ----- | ----------- |
374
+ * | multiple | Allows any number of items to be selected at once. This is useful when you want to apply an operation to multiple items at the same time. |
375
+ * | none | Disables selection. Use this when you want to prevent selecting items. |
376
+ * | single | Allows only one item to be selected at a time. If another item is selected, the previous selection is cleared. This is useful when you want to ensure that a maximum of one item is selected at a time. |
377
+ * | single-persist | Allows only one item to be selected at a time and prevents de-selection. Once an item is selected, it remains selected until another item is selected. This is useful when you want to ensure that there is always exactly one selected item. |
182
378
  *
183
379
  * @default "none"
380
+ * @see [selectedItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/#selectedItems)
381
+ * @example
382
+ *
383
+ * ```html
384
+ * <arcgis-table-list-next selection-mode="multiple"></arcgis-table-list-next>
385
+ * ```
386
+ *
387
+ * ```js
388
+ * tableListNextElement.selectionMode = "multiple";
389
+ * ```
390
+ *
184
391
  */
185
392
  accessor selectionMode: List["selectionMode"];
186
393
  /**
187
- * Indicates whether to display a close button in the header.
394
+ * This property provides the ability to show or hide the close button.
188
395
  *
189
396
  * @default false
397
+ * @example
398
+ *
399
+ * ```html
400
+ * <arcgis-table-list-next show-close-button></arcgis-table-list-next>
401
+ * ```
402
+ *
403
+ * ```js
404
+ * tableListNextElement.showCloseButton = true;
405
+ * ```
406
+ *
190
407
  */
191
408
  accessor showCloseButton: boolean;
192
409
  /**
193
- * Indicates whether to display a collapse button in the header.
410
+ * This property provides the ability to show or hide the collapse button.
194
411
  *
195
412
  * @default false
413
+ * @example
414
+ *
415
+ * ```html
416
+ * <arcgis-table-list-next show-collapse-button></arcgis-table-list-next>
417
+ * ```
418
+ *
419
+ * ```js
420
+ * tableListNextElement.showCollapseButton = true;
421
+ * ```
422
+ *
196
423
  */
197
424
  accessor showCollapseButton: boolean;
198
425
  /**
199
- * Indicates whether to display tables with load errors.
426
+ * This property provides the ability to show or hide layer error indicators.
200
427
  *
201
428
  * @default false
429
+ * @example
430
+ *
431
+ * ```html
432
+ * <arcgis-table-list-next show-errors></arcgis-table-list-next>
433
+ * ```
434
+ *
435
+ * ```js
436
+ * tableListNextElement.showErrors = true;
437
+ * ```
438
+ *
202
439
  */
203
440
  accessor showErrors: boolean;
204
441
  /**
205
- * Indicates whether to display a filter input box.
442
+ * This property provides the ability to show or hide the filter input box when then number of list items is equal to or greater than the value set in [minFilterItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/#minFilterItems), allowing users to filter layers by their title.
206
443
  *
207
444
  * @default false
445
+ * @example
446
+ *
447
+ * ```html
448
+ * <arcgis-table-list-next show-filter></arcgis-table-list-next>
449
+ * ```
450
+ *
451
+ * ```js
452
+ * tableListNextElement.showFilter = true;
453
+ * ```
454
+ *
208
455
  */
209
456
  accessor showFilter: boolean;
210
457
  /**
211
- * Indicates whether to display the table list heading.
458
+ * This property provides the ability to show or hide the heading.
212
459
  *
213
460
  * @default false
461
+ * @example
462
+ *
463
+ * ```html
464
+ * <arcgis-table-list-next show-heading></arcgis-table-list-next>
465
+ * ```
466
+ *
467
+ * ```js
468
+ * tableListNextElement.showHeading = true;
469
+ * ```
470
+ *
214
471
  */
215
472
  accessor showHeading: boolean;
216
473
  /**
217
- * Indicates whether temporary table indicators will be displayed.
474
+ * This property provides the ability to show or hide the temporary table indicators for tables with [Layer#persistenceEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#persistenceEnabled) set to `false`. A [temporary icon](https://developers.arcgis.com/calcite-design-system/icons/?icon=temporary&library=Calcite%20UI&query=temporary) will be displayed on the near side of the table title.
218
475
  *
219
476
  * @default false
477
+ * @example
478
+ *
479
+ * ```html
480
+ * <arcgis-table-list-next show-temporary-table-indicators></arcgis-table-list-next>
481
+ * ```
482
+ *
483
+ * ```js
484
+ * tableListNextElement.showTemporaryTableIndicators = true;
485
+ * ```
486
+ *
220
487
  */
221
488
  accessor showTemporaryTableIndicators: boolean;
222
489
  /** The current state of the component. */
223
490
  get state(): TableItemCollection["state"];
224
- /** The collection of table ListItems displayed within the component. */
491
+ /**
492
+ * The collection of table [items](https://developers.arcgis.com/javascript/latest/references/core/layers/list/Item/) displayed within the component.
493
+ *
494
+ * @example
495
+ * ```js
496
+ * tableListElement.tableItems.forEach(item => console.log(item.title));
497
+ * ```
498
+ */
225
499
  get tableItems(): Collection<TableItem>;
226
- /** A collection of tables to display in the component. */
500
+ /**
501
+ * A collection of tables to display in the component.
502
+ *
503
+ * @internal
504
+ */
227
505
  accessor tables: ReadonlyCollection<Layer | Sublayer> | null | undefined;
228
506
  /**
229
507
  * The view associated with the component.
@@ -234,15 +512,15 @@ export abstract class ArcgisTableListNext extends LitElement {
234
512
  destroy(): Promise<void>;
235
513
  /** Emitted when the component's close button is clicked. */
236
514
  readonly arcgisClose: import("@arcgis/lumina").TargetedEvent<this, void>;
237
- /** Emits when the list filter input value changes. */
515
+ /** Emitted when the value of the [filterText](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/#filterText) input changes. */
238
516
  readonly arcgisFilterChange: import("@arcgis/lumina").TargetedEvent<this, void>;
239
517
  /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
240
518
  readonly arcgisPropertyChange: import("@arcgis/lumina").TargetedEvent<this, { name: "state"; }>;
241
519
  /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
242
520
  readonly arcgisReady: import("@arcgis/lumina").TargetedEvent<this, void>;
243
- /** Emits when selected items state changes. */
521
+ /** Emitted when the collection of [selectedItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/#selectedItems) changes. */
244
522
  readonly arcgisSelectedItemsChange: import("@arcgis/lumina").TargetedEvent<this, void>;
245
- /** Emits when table items state changes. */
523
+ /** Emitted when the collection of [tableItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/#tableItems) changes. */
246
524
  readonly arcgisTableItemsChanged: import("@arcgis/lumina").TargetedEvent<this, void>;
247
525
  /** Emitted when an action is triggered on the component. */
248
526
  readonly arcgisTriggerAction: import("@arcgis/lumina").TargetedEvent<this, TableItemCollectionEvents["trigger-action"]>;
@@ -255,16 +533,4 @@ export abstract class ArcgisTableListNext extends LitElement {
255
533
  arcgisTableItemsChanged: ArcgisTableListNext["arcgisTableItemsChanged"]["detail"];
256
534
  arcgisTriggerAction: ArcgisTableListNext["arcgisTriggerAction"]["detail"];
257
535
  };
258
- }
259
-
260
- /** @param event */
261
- export type CanSortFunction = (event: CanSortEvent) => boolean;
262
-
263
- /** @param item */
264
- export type FilterPredicate = (item: TableItem) => boolean;
265
-
266
- export interface CanSortEvent {
267
- selected: null | undefined | TableItem;
268
- from: null | undefined | TableItem;
269
- to: null | undefined | TableItem;
270
536
  }
@@ -9,7 +9,6 @@ import { LitElement as E, createEvent as c, safeClassMap as b, nothing as F } fr
9
9
  import { usePropertyChange as T } from "@arcgis/lumina/controllers";
10
10
  import { reEmitEvent as D } from "@arcgis/lumina/controllers/accessor";
11
11
  import { classes as P } from "@arcgis/toolkit/dom";
12
- import "@arcgis/toolkit/function";
13
12
  import { generateGuid as N } from "@arcgis/toolkit/string";
14
13
  import { createRef as U, ref as A } from "lit/directives/ref.js";
15
14
  import { html as o } from "lit";
@@ -35,10 +34,10 @@ class z extends E {
35
34
  this._selectedDragItemLayerUid = e;
36
35
  }, this._onTriggerAction = (e, t) => {
37
36
  this.triggerAction(e, t);
38
- }, this.autoDestroyDisabled = !1, this.closed = !1, this.collapsed = !1, this.dragEnabled = !1, this.filterPlaceholder = "", this.filterText = "", this.headingLevel = 2, this.icon = "table", this.listItemCreatedFunction = this.viewModel.listItemCreatedFunction, this.listModeDisabled = this.viewModel.listModeDisabled, this.map = this.viewModel.map, this.minDragEnabledItems = B, this.minFilterItems = R, this.selectedItems = new M(), this.selectionMode = "none", this.tables = this.viewModel.tables, this.showCloseButton = !1, this.showCollapseButton = !1, this.showErrors = !1, this.hideNoFilterResultsNotice = !1, this.hideNoItemsNotice = !1, this.showFilter = !1, this.showHeading = !1, this.hideStatusIndicators = !1, this.showTemporaryTableIndicators = !1, this.arcgisClose = c(), this.arcgisPropertyChange = T()("state"), this.arcgisReady = c(), this.arcgisFilterChange = c(), this.arcgisSelectedItemsChange = c(), this.arcgisTableItemsChanged = c(), this.arcgisTriggerAction = D(() => this.viewModel, "trigger-action");
37
+ }, this.autoDestroyDisabled = !1, this.closed = !1, this.collapsed = !1, this.dragEnabled = !1, this.filterPlaceholder = "", this.filterText = "", this.headingLevel = 2, this.hideNoFilterResultsNotice = !1, this.hideNoItemsNotice = !1, this.hideStatusIndicators = !1, this.icon = "table", this.listItemCreatedFunction = this.viewModel.listItemCreatedFunction, this.listModeDisabled = this.viewModel.listModeDisabled, this.map = this.viewModel.map, this.minDragEnabledItems = B, this.minFilterItems = R, this.selectedItems = new M(), this.selectionMode = "none", this.showCloseButton = !1, this.showCollapseButton = !1, this.showErrors = !1, this.showFilter = !1, this.showHeading = !1, this.showTemporaryTableIndicators = !1, this.tables = this.viewModel.tables, this.arcgisClose = c(), this.arcgisFilterChange = c(), this.arcgisPropertyChange = T()("state"), this.arcgisReady = c(), this.arcgisSelectedItemsChange = c(), this.arcgisTableItemsChanged = c(), this.arcgisTriggerAction = D(() => this.viewModel, "trigger-action");
39
38
  }
40
39
  static {
41
- this.properties = { _visibleItems: 16, _openedPanelItems: 16, _dragEnabled: 16, _filterEnabled: 16, view: 0, autoDestroyDisabled: 5, closed: 5, referenceElement: 1, collapsed: 7, dragEnabled: 5, filterPlaceholder: 1, filterPredicate: 0, filterText: 1, headingLevel: 9, icon: 1, label: 1, listItemCanGiveFunction: 0, listItemCanReceiveFunction: 0, listItemCreatedFunction: 0, listModeDisabled: 5, map: 0, minDragEnabledItems: 9, minFilterItems: 9, selectedItems: 0, selectionMode: 1, state: 32, tableItems: 32, tables: 0, showCloseButton: 5, showCollapseButton: 5, showErrors: 5, hideNoFilterResultsNotice: 5, hideNoItemsNotice: 5, showFilter: 5, showHeading: 5, hideStatusIndicators: 5, showTemporaryTableIndicators: 5, messageOverrides: 0 };
40
+ this.properties = { _visibleItems: 16, _openedPanelItems: 16, _dragEnabled: 16, _filterEnabled: 16, autoDestroyDisabled: 5, closed: 5, collapsed: 7, dragEnabled: 5, filterPlaceholder: 1, filterPredicate: 0, filterText: 1, headingLevel: 9, hideNoFilterResultsNotice: 5, hideNoItemsNotice: 5, hideStatusIndicators: 5, icon: 1, label: 1, listItemCanGiveFunction: 0, listItemCanReceiveFunction: 0, listItemCreatedFunction: 0, listModeDisabled: 5, map: 0, messageOverrides: 0, minDragEnabledItems: 9, minFilterItems: 9, referenceElement: 1, selectedItems: 0, selectionMode: 1, showCloseButton: 5, showCollapseButton: 5, showErrors: 5, showFilter: 5, showHeading: 5, showTemporaryTableIndicators: 5, state: 32, tableItems: 32, tables: 0, view: 0 };
42
41
  }
43
42
  static {
44
43
  this.styles = [O, q];
@@ -0,0 +1,37 @@
1
+ import type Collection from "@arcgis/core/core/Collection.js";
2
+ import type TableItemCollection from "@arcgis/core/layers/list/TableItemCollection.js";
3
+ import type TableItem from "@arcgis/core/layers/list/TableItem.js";
4
+ import type { ArcgisTableListNext } from "./customElement.js";
5
+ import type { SortableList as SortableList } from "@esri/calcite-components/components/calcite-sortable-list";
6
+
7
+ /** @internal */
8
+ export type CanSortEvent = {
9
+ selected: null | undefined | TableItem;
10
+ from: null | undefined | TableItem;
11
+ to: null | undefined | TableItem;
12
+ };
13
+
14
+ /**
15
+ * @param event
16
+ * @internal
17
+ */
18
+ export type CanSortFunction = (event: CanSortEvent) => boolean;
19
+
20
+ /** @internal */
21
+ export type DragDetail = Parameters<NonNullable<SortableList["canPull"]>>[0];
22
+
23
+ /**
24
+ * A function that determines whether a table item matches a filter.
25
+ *
26
+ * @param item
27
+ */
28
+ export type FilterPredicate = (item: TableItem) => boolean;
29
+
30
+ /** @internal */
31
+ export type SortableTables = Collection<{ uid?: string | null; }> | null | undefined;
32
+
33
+ /** The properties used to configure the Table List (next). */
34
+ export type TableListOptions = Partial<Pick<ArcgisTableListNext, "collapsed" | "dragEnabled" | "filterPlaceholder" | "filterText" | "headingLevel" | "hideStatusIndicators" | "icon" | "label" | "minFilterItems" | "selectionMode" | "showErrors" | "showFilter" | "showTemporaryTableIndicators">>
35
+ & {
36
+ listItemCreatedFunction?: TableItemCollection["listItemCreatedFunction"];
37
+ };
@@ -104,6 +104,16 @@ export abstract class ArcgisTimeBar extends LitElement {
104
104
  * prevent memory leaks.
105
105
  *
106
106
  * @default false
107
+ * @example
108
+ *
109
+ * ```html
110
+ * <arcgis-time-bar auto-destroy-disabled></arcgis-time-bar>
111
+ * ```
112
+ *
113
+ * ```js
114
+ * timeBarElement.autoDestroyDisabled = true;
115
+ * ```
116
+ *
107
117
  */
108
118
  accessor autoDestroyDisabled: boolean;
109
119
  /**
@@ -132,6 +132,16 @@ export abstract class ArcgisTimeBarSlider extends LitElement {
132
132
  * prevent memory leaks.
133
133
  *
134
134
  * @default false
135
+ * @example
136
+ *
137
+ * ```html
138
+ * <arcgis-time-bar-slider auto-destroy-disabled></arcgis-time-bar-slider>
139
+ * ```
140
+ *
141
+ * ```js
142
+ * timeBarSliderElement.autoDestroyDisabled = true;
143
+ * ```
144
+ *
135
145
  */
136
146
  accessor autoDestroyDisabled: boolean;
137
147
  /**
@@ -86,6 +86,16 @@ export abstract class ArcgisTimeSlider extends LitElement {
86
86
  * prevent memory leaks.
87
87
  *
88
88
  * @default false
89
+ * @example
90
+ *
91
+ * ```html
92
+ * <arcgis-time-slider auto-destroy-disabled></arcgis-time-slider>
93
+ * ```
94
+ *
95
+ * ```js
96
+ * timeSliderElement.autoDestroyDisabled = true;
97
+ * ```
98
+ *
89
99
  */
90
100
  accessor autoDestroyDisabled: boolean;
91
101
  /**
@@ -42,6 +42,16 @@ export abstract class ArcgisTrack extends LitElement {
42
42
  * prevent memory leaks.
43
43
  *
44
44
  * @default false
45
+ * @example
46
+ *
47
+ * ```html
48
+ * <arcgis-track auto-destroy-disabled></arcgis-track>
49
+ * ```
50
+ *
51
+ * ```js
52
+ * trackElement.autoDestroyDisabled = true;
53
+ * ```
54
+ *
45
55
  */
46
56
  accessor autoDestroyDisabled: boolean;
47
57
  /**
@@ -41,6 +41,16 @@ export abstract class ArcgisUtilityNetworkAggregatedGeometry extends LitElement
41
41
  * prevent memory leaks.
42
42
  *
43
43
  * @default false
44
+ * @example
45
+ *
46
+ * ```html
47
+ * <arcgis-utility-network-aggregated-geometry auto-destroy-disabled></arcgis-utility-network-aggregated-geometry>
48
+ * ```
49
+ *
50
+ * ```js
51
+ * utilityNetworkAggregatedGeometryElement.autoDestroyDisabled = true;
52
+ * ```
53
+ *
44
54
  */
45
55
  accessor autoDestroyDisabled: boolean;
46
56
  /** @required */