@arcgis/common-components 5.1.0-next.6 → 5.1.0-next.60

package/dist/components/arcgis-ramp-color-break/customElement.d.ts

@@ -3,6 +3,7 @@ import type Color from "@arcgis/core/Color.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { ArcgisRampColor } from "../arcgis-ramp-color/customElement.js";
 
+/** @internal */
 export abstract class ArcgisRampColorBreak extends LitElement {
   /** @default "horizontal" */
   accessor layout: ArcgisRampColor["layout"];
@@ -13,6 +14,7 @@ export abstract class ArcgisRampColorBreak extends LitElement {
   accessor stops: ColorBreak[];
 }
 
+/** @internal */
 export interface ColorBreak {
   color: Color | string;
   max: number;

package/dist/components/arcgis-ramp-opacity/customElement.d.ts

@@ -3,6 +3,7 @@ import type Color from "@arcgis/core/Color.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { ArcgisRampColor } from "../arcgis-ramp-color/customElement.js";
 
+/** @internal */
 export abstract class ArcgisRampOpacity extends LitElement {
   accessor fillColor: Color | string;
   /** @default "horizontal" */

package/dist/components/arcgis-slider/customElement.d.ts

@@ -1,13 +1,12 @@
 /// <reference path="../../index.d.ts" />
-/// <reference types="@arcgis/core/interfaces.d.ts" />
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { T9nMeta } from "@arcgis/lumina/controllers";
 import type { Popover as Popover } from "@esri/calcite-components/components/calcite-popover";
 
 /**
  * The Slider component is used to filter data or collect numeric input from users. It supports single or multiple thumbs, configured via the
- * [values](#values) property. The Slider can be displayed in horizontal or vertical [layouts](#layout), supports snapping to defined [steps](#steps),
- * configurable value [precision](#precision), and custom [label formatting](#labelFormatter). It also includes keyboard interaction,
+ * [values](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#values) property. The Slider can be displayed in horizontal or vertical [layout](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#layout), supports snapping to defined [steps](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#steps),
+ * configurable value [precision](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#precision), and custom [labelFormatter](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#labelFormatter). It also includes keyboard interaction,
  * optional editable labels, and customizable popover content.
  *
  * The slider component can be set up with the [arcgis-ticks](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/) component. See the example below:
@@ -18,17 +17,19 @@ import type { Popover as Popover } from "@esri/calcite-components/components/cal
  * </arcgis-slider>
  * ```
  *
- * ### Which slider should you use: arcgis-slider or calcite-slider?
+ * > ### Which slider should you use: `arcgis-slider` or `calcite-slider`?
  * >
- * > In general, use [calcite-slider](https://developers.arcgis.com/calcite-design-system/components/slider/) over `arcgis-slider`.
- * > It covers common slider use cases and works well in most scenarios.
+ * > It is recommended to use [`calcite-slider`](https://developers.arcgis.com/calcite-design-system/components/slider/) for most use cases, as the component
+ * > offers a consistent UI/UX and accommodates the majority of implementations.
  * >
- * > Use `arcgis-slider` only when you need functionality that `calcite-slider` does not provide, such as:
- * > * [Vertical layout](#layout): `arcgis-slider` supports `layout="vertical"`.
- * > * Custom range display: `arcgis-slider` supports [fullRangeMin](#fullRangeMin) and [fullRangeMax](#fullRangeMax) for displaying a wider
- * > range than the interactive range.
- * > * More than two values: `arcgis-slider` supports an arbitrary number of slider values, beyond single-value or range (two-value) sliders.
- * > * Slot support: Use the `content-start`, `content-end`, and `popover` slots to render custom content before the track, after the track, or inside the popover.
+ * > Use `arcgis-slider` for advanced use cases, where solutions seek the following:
+ * >
+ * > * [layout](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#layout): configurations, where `arcgis-slider` offers a `layout` of `"vertical"`.
+ * > * Display more than two values in the component.
+ * > * A custom range display, where `arcgis-slider` supports [fullRangeMin](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#fullRangeMin) and
+ * >   [fullRangeMax](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#fullRangeMax) for displaying a wider range than the interactive range.
+ * > * Additional slot configurations for adding elements within or over the component, where `arcgis-slider` can slot
+ * >   content using the `content-start`, `content-end`, and `popover` slots.
  *
  * @slot [content-start] - A slot for elements before the track.
  * @slot [content-end] - A slot for elements after the track.
@@ -46,9 +47,9 @@ export abstract class ArcgisSlider extends LitElement {
    * - a `number` when a single value is active
    * - `"all"` when the range (segment) is active
    *
-   * Listen to [arcgisActiveValueChange](#arcgisActiveValueChange) to be notified when a value becomes active or inactive.
+   * Listen to [@arcgisActiveValueChange](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#event-arcgisActiveValueChange) to be notified when a value becomes active or inactive.
    *
-   * @see [arcgisActiveValueChange](#arcgisActiveValueChange)
+   * @see [@arcgisActiveValueChange](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#event-arcgisActiveValueChange)
    */
   get activeValue(): number | "all" | undefined;
   /**
@@ -83,12 +84,12 @@ export abstract class ArcgisSlider extends LitElement {
   accessor fillPlacement: "end" | "none" | "start";
   /**
    * Sets the maximum value of the slider display full range.
-   * When specified, the slider track is scaled from [fullRangeMin](#fullRangeMin) to `fullRangeMax`, while
-   * the thumbs remain constrained to the interactive range defined by [min](#min) and [max](#max).
+   * When specified, the slider track is scaled from [fullRangeMin](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#fullRangeMin) to `fullRangeMax`, while
+   * the thumbs remain constrained to the interactive range defined by [min](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#min) and [max](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#max).
    *
-   * The `fullRangeMax` must be greater than or equal to [max](#max) property of the slider.
+   * The `fullRangeMax` must be greater than or equal to [max](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#max) property of the slider.
    *
-   * @see [fullRangeMin](#fullRangeMin)
+   * @see [fullRangeMin](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#fullRangeMin)
    * @example
    * ```html
    * <!-- Slider with a full range from 0 to 100, while only allowing thumb values between 25 and 75. -->
@@ -98,12 +99,12 @@ export abstract class ArcgisSlider extends LitElement {
   accessor fullRangeMax: number | undefined;
   /**
    * Sets the minimum value of the slider display full range.
-   * When specified, the slider track is scaled from `fullRangeMin` to [fullRangeMax](#fullRangeMax), while
-   * the thumbs remain constrained to the range defined by [min](#min) and [max](#max).
+   * When specified, the slider track is scaled from `fullRangeMin` to [fullRangeMax](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#fullRangeMax), while
+   * the thumbs remain constrained to the range defined by [min](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#min) and [max](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#max).
    *
-   * The `fullRangeMin` must be less than or equal to [min](#min) property of the slider.
+   * The `fullRangeMin` must be less than or equal to [min](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#min) property of the slider.
    *
-   * @see [fullRangeMax](#fullRangeMax)
+   * @see [fullRangeMax](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#fullRangeMax)
    * @example
    * ```html
    * <!-- Slider with a full range from 0 to 100, while only allowing thumb values between 25 and 75. -->
@@ -123,7 +124,7 @@ export abstract class ArcgisSlider extends LitElement {
    */
   accessor keyboardLargeStep: number;
   /**
-   * Allows customizing how slider labels are formatted for [min](#min), [max](#max), and thumb values.
+   * Allows customizing how slider labels are formatted for [min](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#min), [max](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#max), and thumb values.
    * The formatted value is used for the visible labels and for the thumb’s accessible value text via `aria-valuetext`.
    * Return `null` or `undefined` to use the default formatting.
    *
@@ -150,24 +151,24 @@ export abstract class ArcgisSlider extends LitElement {
    * };
    * ```
    */
-  accessor labelFormatter: ((value: number, type: "max" | "min" | "value", defaultFormatter: (value: number) => string) => nullish | string) | undefined;
+  accessor labelFormatter: (value: number, type: "max" | "min" | "value", defaultFormatter: (value: number) => string) => string | null | undefined;
   /**
    * Determines the layout/orientation of the Slider component. By default, the slider will render horizontally with the min value on the left side
    * of the track.
    *
    * @default "horizontal"
-   * @see [mirrored](#mirrored)
+   * @see [mirrored](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#mirrored)
    */
   accessor layout: "horizontal" | "vertical";
   /**
    * The maximum value for the slider thumbs. Thumbs will not move past this value.
    *
-   * To display the `max` label on the slider, set [showRangeLabels](#showRangeLabels) to `true`.
-   * To allow the end user to modify the `max` value, set [rangeLabelsEditingEnabled](#rangeLabelsEditingEnabled) to `true`.
+   * To display the `max` label on the slider, set [showRangeLabels](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#showRangeLabels) to `true`.
+   * To allow the end user to modify the `max` value, set [rangeLabelsEditingEnabled](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#rangeLabelsEditingEnabled) to `true`.
    *
-   * @see [rangeLabelsEditingEnabled](#rangeLabelsEditingEnabled)
-   * @see [showRangeLabels](#showRangeLabels)
-   * @see [fullRangeMax](#fullRangeMax)
+   * @see [rangeLabelsEditingEnabled](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#rangeLabelsEditingEnabled)
+   * @see [showRangeLabels](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#showRangeLabels)
+   * @see [fullRangeMax](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#fullRangeMax)
    */
   accessor max: number;
   /**
@@ -201,18 +202,18 @@ export abstract class ArcgisSlider extends LitElement {
   }>;
   /**
    * The minimum value for the slider thumbs. Thumbs will not move past this value.
-   * To display the `min` label on the slider, set [showRangeLabels](#showRangeLabels) to `true`.
-   * To allow the end user to modify the `min` value, set [rangeLabelsEditingEnabled](#rangeLabelsEditingEnabled) to `true`.
+   * To display the `min` label on the slider, set [showRangeLabels](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#showRangeLabels) to `true`.
+   * To allow the end user to modify the `min` value, set [rangeLabelsEditingEnabled](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#rangeLabelsEditingEnabled) to `true`.
    *
-   * @see [rangeLabelsEditingEnabled](#rangeLabelsEditingEnabled)
-   * @see [showRangeLabels](#showRangeLabels)
+   * @see [rangeLabelsEditingEnabled](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#rangeLabelsEditingEnabled)
+   * @see [showRangeLabels](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#showRangeLabels)
    */
   accessor min: number;
   /**
    * When `true`, the slider will display values from high to low. This inverts the direction of the slider.
    *
    * @default false
-   * @see [layout](#layout)
+   * @see [layout](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#layout)
    */
   accessor mirrored: boolean;
   /**
@@ -268,8 +269,8 @@ export abstract class ArcgisSlider extends LitElement {
    * The labels of the thumbs will display two decimal places, but the precision of the actual
    * thumb values will not be lost even when the user slides or moves the thumb.
    *
-   * Keep in mind this property rounds thumb [values](#values) and shouldn't be used exclusively
-   * for formatting purposes. To format thumb `labels`, use the [labelFormatter](#labelFormatter)
+   * Keep in mind this property rounds thumb [values](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#values) and shouldn't be used exclusively
+   * for formatting purposes. To format thumb `labels`, use the [labelFormatter](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#labelFormatter)
    * property.
    *
    * @default 4
@@ -282,17 +283,17 @@ export abstract class ArcgisSlider extends LitElement {
    */
   accessor precision: number;
   /**
-   * When `true`, users can edit the [min](#min) and [max](#max) range labels via keyboard input.
+   * When `true`, users can edit the [min](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#min) and [max](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#max) range labels via keyboard input.
    * Editing these labels updates the slider’s interactive range.
    *
    * @default false
    */
   accessor rangeLabelsEditingEnabled: boolean;
   /**
-   * Controls where the [min](#min) and [max](#max) range labels are positioned relative to the track.
-   * This property only affects the slider when [layout](#layout) is `"horizontal"`.
+   * Controls where the [min](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#min) and [max](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#max) range labels are positioned relative to the track.
+   * This property only affects the slider when [layout](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#layout) is `"horizontal"`.
    *
-   * - `"center"` (default): Places the [min](#min) and [max](#max) labels aligned with the track.
+   * - `"center"` (default): Places the [min](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#min) and [max](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#max) labels aligned with the track.
    * - `"end"`: Places the range labels below the the track.
    *
    * @default "center"
@@ -305,7 +306,7 @@ export abstract class ArcgisSlider extends LitElement {
    */
   accessor segmentsDraggingDisabled: boolean;
   /**
-   * Indicates whether to [min](#min) and [max](#max) range labels are visible on the slider.
+   * Indicates whether to [min](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#min) and [max](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#max) range labels are visible on the slider.
    *
    * @default false
    */
@@ -320,7 +321,7 @@ export abstract class ArcgisSlider extends LitElement {
    * slider range at an interval of the provided value. In this scenario,
    * the user may only slide the thumbs to values at the provided interval.
    * For example, if a value of `0.5` is set here, and the slider
-   * [min](#min) is `0` and the slider [max](#max) is `10`, then the user will
+   * [min](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#min) is `0` and the slider [max](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#max) is `10`, then the user will
    * only be able to update the thumbs to values of 0, 0.5, 1.0, 1.5, 2.0, etc.
    *
    * @example
@@ -352,7 +353,7 @@ export abstract class ArcgisSlider extends LitElement {
    * when the user clicks a thumb value label. This allows the user to move the slider
    * thumb to precise values without sliding the thumbs.
    *
-   * ![Slider with editable labels](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/slider-edit-label.png)
+   * ![Slider with editable labels](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-edit-label.png)
    *
    * @default false
    */
@@ -368,9 +369,9 @@ export abstract class ArcgisSlider extends LitElement {
   /** Permanently destroys the component. */
   destroy(): Promise<void>;
   /**
-   * Fires when the [activeValue](#activeValue) changes as a thumb or the range gains or loses focus.
-   * This event does not fire when [values](#values) change. Use [arcgisInput](#arcgisInput) for continuous updates or
-   * [arcgisChange](#arcgisChange) when the interaction is committed.
+   * Fires when the [activeValue](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#activeValue) changes as a thumb or the range gains or loses focus.
+   * This event does not fire when [values](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#values) change. Use [@arcgisInput](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#event-arcgisInput) for continuous updates or
+   * [@arcgisChange](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#event-arcgisChange) when the interaction is committed.
    *
    * @example
    * ```js
@@ -396,13 +397,13 @@ export abstract class ArcgisSlider extends LitElement {
    *
    * renderActive();
    * ```
-   * @see [activeValue](#activeValue)
+   * @see [activeValue](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#activeValue)
    */
   readonly arcgisActiveValueChange: import("@arcgis/lumina").TargetedEvent<this, void>;
   /**
    * Fires when the thumb or range is released on the component.
    *
-   * Use [arcgisInput](#arcgisInput) for continuous updates during a drag.
+   * Use [@arcgisInput](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#event-arcgisInput) for continuous updates during a drag.
    *
    * @example
    * ```js
@@ -450,8 +451,8 @@ export abstract class ArcgisSlider extends LitElement {
    */
   readonly arcgisInput: import("@arcgis/lumina").TargetedEvent<this, void>;
   /**
-   * Fires when the slider's [min](#min) and [max](#max) range changes.
-   * This occurs when the user edits the [min](#min) or [max](#max) range labels (when enabled).
+   * Fires when the slider's [min](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#min) and [max](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#max) range changes.
+   * This occurs when the user edits the [min](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#min) or [max](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/#max) range labels (when enabled).
    *
    * @example
    * ```js