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

package/dist/components/arcgis-table-list/customElement.d.ts

@@ -69,6 +69,16 @@ export abstract class ArcgisTableList extends LitElement {
    * prevent memory leaks.
    *
    * @default false
+   * @example
+   * 
+   * ```html
+   * <arcgis-table-list auto-destroy-disabled></arcgis-table-list>
+   * ```
+   *
+   * ```js
+   * tableListElement.autoDestroyDisabled = true;
+   * ```
+   * 
    */
   accessor autoDestroyDisabled: boolean;
   /**
@@ -76,6 +86,16 @@ export abstract class ArcgisTableList extends LitElement {
    *
    * @default false
    * @since 4.33
+   * @example
+   * 
+   * ```html
+   * <arcgis-table-list closed></arcgis-table-list>
+   * ```
+   *
+   * ```js
+   * tableListElement.closed = true;
+   * ```
+   * 
    */
   accessor closed: boolean;
   /**
@@ -143,10 +163,19 @@ export abstract class ArcgisTableList extends LitElement {
   accessor filterText: string;
   accessor headingLevel: HeadingLevel;
   /**
-   * Indicates whether the status indicators will be displayed.
+   * Indicates whether to hide status indicators in the component.
    *
    * @default false
-   * @since 5.0
+   * @example
+   * 
+   * ```html
+   * <arcgis-table-list hide-status-indicators></arcgis-table-list>
+   * ```
+   *
+   * ```js
+   * tableListElement.hideStatusIndicators = true;
+   * ```
+   * 
    */
   accessor hideStatusIndicators: boolean;
   /**
@@ -249,7 +278,11 @@ export abstract class ArcgisTableList extends LitElement {
    *
    * @default "none"
    * @since 4.29
-   * @see [selectedItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/#selectedItems)
+   * @see
+   * [selectedItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/#selectedItems)
+   *
+   * > [!WARNING]
+   * > 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/). We encourage using the [arcgis-table-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/) component and providing feedback.
    * @example
    * ```js
    * tableListElement.selectionMode = "multiple";
@@ -257,45 +290,99 @@ export abstract class ArcgisTableList extends LitElement {
    */
   accessor selectionMode: "none" | "single-persist" | "multiple" | "single";
   /**
-   * Indicates whether to display a close button in the header.
+   * This property provides the ability to show or hide the close button.
    *
    * @default false
-   * @since 5.0
+   * @example
+   * 
+   * ```html
+   * <arcgis-table-list show-close-button></arcgis-table-list>
+   * ```
+   *
+   * ```js
+   * tableListElement.showCloseButton = true;
+   * ```
+   * 
    */
   accessor showCloseButton: boolean;
   /**
-   * Indicates whether to display a collapse button in the header.
+   * This property provides the ability to show or hide the collapse button.
    *
    * @default false
-   * @since 5.0
+   * @example
+   * 
+   * ```html
+   * <arcgis-table-list show-collapse-button></arcgis-table-list>
+   * ```
+   *
+   * ```js
+   * tableListElement.showCollapseButton = true;
+   * ```
+   * 
    */
   accessor showCollapseButton: boolean;
   /**
-   * Indicates whether to display layers with load errors.
+   * This property provides the ability to show or hide layer error indicators.
    *
    * @default false
-   * @since 5.0
+   * @example
+   * 
+   * ```html
+   * <arcgis-table-list show-errors></arcgis-table-list>
+   * ```
+   *
+   * ```js
+   * tableListElement.showErrors = true;
+   * ```
+   * 
    */
   accessor showErrors: boolean;
   /**
-   * Indicates whether to display a filter input box when then number of list items is equal to or greater than the value set in [TableList#minFilterItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/#minFilterItems), allowing users to filter tables by their title.
+   * 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/#minFilterItems), allowing users to filter layers by their title.
    *
    * @default false
-   * @since 5.0
+   * @example
+   * 
+   * ```html
+   * <arcgis-table-list show-filter></arcgis-table-list>
+   * ```
+   *
+   * ```js
+   * tableListElement.showFilter = true;
+   * ```
+   * 
    */
   accessor showFilter: boolean;
   /**
-   * Indicates whether to display the table list heading. The heading text is "Table List". The heading level can be set with the [TableList#headingLevel](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/#headingLevel).
+   * This property provides the ability to show or hide the heading.
    *
    * @default false
-   * @since 5.0
+   * @example
+   * 
+   * ```html
+   * <arcgis-table-list show-heading></arcgis-table-list>
+   * ```
+   *
+   * ```js
+   * tableListElement.showHeading = true;
+   * ```
+   * 
    */
   accessor showHeading: boolean;
   /**
-   * Indicates whether temporary table indicators will be displayed 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.
+   * 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.
    *
    * @default false
-   * @since 5.0
+   * @example
+   * 
+   * ```html
+   * <arcgis-table-list show-temporary-table-indicators></arcgis-table-list>
+   * ```
+   *
+   * ```js
+   * tableListElement.showTemporaryTableIndicators = true;
+   * ```
+   * 
    */
   accessor showTemporaryTableIndicators: boolean;
   /**