@arcgis/common-components 5.1.0-next.2 → 5.1.0-next.21

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

@@ -1,6 +1,7 @@
 /// <reference path="../../index.d.ts" />
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 
+/** @internal */
 export abstract class ArcgisSliderInput extends LitElement {
   /**
    * If true, prevents interaction with the component.

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

@@ -1,17 +1,44 @@
 /// <reference path="../../index.d.ts" />
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
+import type { Layout, TickMode, TickValues } from "./types.js";
 
 /**
+ * The ticks component displays visual markers along a line to indicate scale, intervals, or specific values. It is often used in conjunction with the
+ * [Slider component](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-slider/). Ticks help users understand the
+ * slider’s range and make more precise selections.
+ *
+ * Tick placement is controlled by the [mode](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/#mode), which defines how the [values](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/#values) are parsed and translated into positions along the
+ * line. Tick positions are derived from the component’s [min](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/#min) and [max](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/#max) range, with optional none-linear scaling via
+ * [interpolationExponent](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/#interpolationExponent). Ticks can be displayed in vertical or horizontal [layout](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/#layout), with optional [showLabels](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/#showLabels) and a [showBaseline](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/#showBaseline).
+ * The component can also be made [interactive](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/#interactive) to respond to user clicks on individual ticks. The [labelFormatter](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/#labelFormatter) property allows customization of tick label formatting.
+ *
  * @cssproperty [--arcgis-ticks-tick-length] - Specifies the length of the ticks.
  * @cssproperty [--arcgis-ticks-tick-color] - Specifies the color of the ticks.
  * @cssproperty [--arcgis-ticks-gap] - Specifies the gap between the ticks and labels.
+ * @since 5.0
+ * @example
+ * The following example creates a vertical slider with vertical ticks displayed at every 10 units from 0 to 100.
+ * The ticks are labeled and positioned on the end side of the slider.
+ * ```html
+ * <arcgis-slider id="sliderComponent" min="0" max="100" show-range-labels values="50" layout="vertical">
+ *    <arcgis-ticks slot="content-end" style="flex:1;"
+ *      min="0" max="100"
+ *      mode="value"
+ *      show-labels
+ *      label-placement="end"
+ *      values="0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100"
+ *      layout="vertical">
+ *    </arcgis-ticks>
+ * </arcgis-slider>
+ * ```
  */
 export abstract class ArcgisTicks extends LitElement {
   /**
-   * When `true`, the component will allow clicking on ticks.
+   * When `true`, ticks are clickable and the component emits  [@arcgisTickClick](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/#event-arcgisTickClick) when the user selects a tick.
    *
    * @default false
+   * @see [@arcgisTickClick](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/#event-arcgisTickClick)
    */
   accessor interactive: boolean;
   /**
@@ -27,16 +54,28 @@ export abstract class ArcgisTicks extends LitElement {
    * @default 0
    */
   accessor interpolationExponent: number;
-  /** A function used to format each tick's label. */
+  /**
+   * Allows customizing how tick labels are formatted based on their numeric value.
+   *
+   * @example
+   * The following example formats tick labels as percentages.
+   * ```js
+   * const ticks = document.querySelector("arcgis-ticks");
+   * ticks.labelFormatter = (value, defaultFormatter) => {
+   *   return value + "%";
+   * };
+   * ```
+   */
   accessor labelFormatter: ((value: number, defaultFormatter: (value: number) => string) => nullish | string) | undefined;
   /**
    * Determines whether the labels are placed before or after the ticks.
    *
-   * @default "trailing"
+   * @default "end"
    */
-  accessor labelPlacement: "leading" | "trailing";
+  accessor labelPlacement: "end" | "start";
   /**
-   * Determines the layout/orientation of the component.
+   * Determines the layout/orientation of the ticks component. By default, the ticks will render horizontally.
+   * When set to `vertical`, the ticks will render vertically.
    *
    * @default "horizontal"
    */
@@ -66,6 +105,49 @@ export abstract class ArcgisTicks extends LitElement {
    * - `value`: Indicates that ticks will only be placed at the values specified in the property.
    *
    * @default "count"
+   * @example
+   * ```html
+   * <!-- Place ticks at each value listed in `values` -->
+   * <arcgis-slider min="0" max="100" show-range-labels values="20, 50">
+   *   <arcgis-ticks
+   *     slot="content-end" style="flex:1;"
+   *     min="0" max="100"
+   *     show-labels label-placement="end"
+   *     mode="value"
+   *     values="0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100">
+   *   </arcgis-ticks>
+   * </arcgis-slider>
+   * ```
+   * @example
+   * In count mode, values is the number of ticks to render (not a list of tick values).
+   * For example, use `11` ticks to show 0–100 in steps of 10 (0, 10, 20, ..., 100).
+   * ```html
+   * <!-- 11 ticks from 0 to 100 -->
+   * <arcgis-slider min="0" max="100" show-range-labels values="20, 50">
+   *   <arcgis-ticks
+   *     slot="content-end" style="flex:1;"
+   *     min="0" max="100"
+   *     show-labels label-placement="end"
+   *     mode="count"
+   *     values="11">
+   *   </arcgis-ticks>
+   * </arcgis-slider>
+   * ```
+   * @example
+   * In percent mode, values are percentages along the track.
+   * Use an array to place ticks at specific percentages, or a single number as a repeating interval.
+   * ```html
+   * <!-- Ticks at 0%, 25%, 50%, 75%, and 100% -->
+   * <arcgis-slider min="0" max="200" show-range-labels values="50, 150">
+   *   <arcgis-ticks
+   *     slot="content-end" style="flex:1;"
+   *     min="0" max="200"
+   *     show-labels label-placement="end"
+   *     mode="percent"
+   *     values="0, 25, 50, 75, 100">
+   *   </arcgis-ticks>
+   * </arcgis-slider>
+   * ```
    * @see [values](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/#values)
    */
   accessor mode: TickMode;
@@ -88,15 +170,21 @@ export abstract class ArcgisTicks extends LitElement {
    * @see [mode](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/#mode)
    */
   accessor values: TickValues;
-  /** Fires when the user clicks on one of the ticks. */
+  /**
+   * Fires when the user clicks on one of the ticks. This event is only emitted when the [interactive](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/#interactive) property is set to `true`.
+   *
+   * @see [interactive](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/#interactive)
+   * @example
+   * The following example listens for the `arcgisTickClick` event and logs the clicked tick's value.
+   * ```js
+   * const ticks = document.querySelector("arcgis-ticks");
+   * ticks.addEventListener("arcgisTickClick", (event) => {
+   *   console.log("Clicked tick value:", event.detail.value);
+   * });
+   * ```
+   */
   readonly arcgisTickClick: import("@arcgis/lumina").TargetedEvent<this, { value: number; }>;
   readonly "@eventTypes": {
     arcgisTickClick: ArcgisTicks["arcgisTickClick"]["detail"];
   };
-}
-
-export type Layout = "horizontal" | "vertical";
-
-export type TickMode = "count" | "percent" | "value";
-
-export type TickValues = number[] | number;
+}

package/dist/components/arcgis-ticks/customElement.js

@@ -3,7 +3,7 @@ import { c as $ } from "../../chunks/runtime.js";
 import { css as M, html as c } from "lit";
 import { LitElement as _, createEvent as C, safeClassMap as h, safeStyleMap as u, nothing as v } from "@arcgis/lumina";
 import { formatNumber as z } from "@arcgis/core/intl.js";
-const s = {
+const n = {
   container: "container",
   ticksContainer: "ticks-container",
   labelsContainer: "labels-container",
@@ -12,7 +12,7 @@ const s = {
   tickMax: "tick--max",
   tickLabel: "tick-label",
   baseline: "baseline"
-}, A = M`:host{display:flex;--arcgis-ticks-tick-length: .5rem;--arcgis-ticks-tick-color: var(--calcite-color-border-input);--arcgis-ticks-gap: 1em;--arcgis-ticks-font-size: var(--calcite-font-size--2)}.container{align-items:stretch;display:flex;color:var(--calcite-color-text-2);flex:1;font-weight:var(--calcite-font-weight-medium);font-size:var(--arcgis-ticks-font-size);line-height:1em;position:relative;user-select:none;word-wrap:normal;word-break:normal}.baseline{background-color:var(--arcgis-ticks-tick-color, var(--calcite-color-border-input))}.tick{position:absolute;background-color:var(--arcgis-ticks-tick-color, var(--calcite-color-border-input))}.tick-label{position:absolute;text-align:var(--arcgis-ticks-label-text-align, center);width:var(--arcgis-ticks-label-width, var(--labels-container-width, "auto"))}:host([layout="horizontal"]){.ticks-container{height:var(--arcgis-ticks-tick-length)}.labels-container{height:var(--labels-container-height, "auto")}.tick{width:.125rem;height:var(--arcgis-ticks-tick-length);transform:translate(-50%)}.tick-label{transform:translate(-50%)}.tick--min{transform:unset}.tick--max{transform:translate(-100%)}}:host([layout="vertical"]){.ticks-container{width:var(--arcgis-ticks-tick-length)}.labels-container{width:var(--labels-container-width)}.tick{width:var(--arcgis-ticks-tick-length);height:.125rem;transform:translateY(50%)}.tick-label{text-align:right;transform:translateY(50%)}.tick--min{transform:unset}.tick--max{transform:translateY(100%)}}:host([layout="horizontal"][mirrored]){.tick,.tick-label{transform:translate(50%)}.tick--min{transform:unset}.tick--max{transform:translate(100%)}}:host([layout="vertical"][mirrored]){.tick,.tick-label{transform:translateY(-50%)}.tick--min{transform:unset}.tick--max{transform:translateY(-100%)}}:host([layout="horizontal"][label-placement="leading"]){.container{flex-direction:column;justify-content:flex-end}.labels-container{margin-bottom:var(--arcgis-ticks-gap)}}:host([layout="horizontal"][label-placement="trailing"]){.container{flex-direction:column-reverse;justify-content:flex-end}.labels-container{margin-top:var(--arcgis-ticks-gap)}}:host([layout="vertical"][label-placement="leading"]){.container{flex-direction:row;justify-content:flex-end}:dir(ltr){.labels-container{margin-right:var(--arcgis-ticks-gap)}.tick-label{text-align:right}}:dir(rtl){.labels-container{margin-left:var(--arcgis-ticks-gap)}.tick-label{text-align:left;unicode-bidi:plaintext}}}:host([layout="vertical"][label-placement="trailing"]){.container{flex-direction:row-reverse;justify-content:flex-end}:dir(ltr){.labels-container{margin-left:var(--arcgis-ticks-gap)}.tick-label{text-align:left}}:dir(rtl){.labels-container{margin-right:var(--arcgis-ticks-gap)}.tick-label{text-align:right;unicode-bidi:plaintext}}}:host([interactive]){pointer-events:none;.tick,.tick-label{pointer-events:auto;cursor:pointer}.tick-label:hover{text-decoration:underline}}`;
+}, A = M`:host{display:flex;--arcgis-ticks-tick-length: .5rem;--arcgis-ticks-tick-color: var(--calcite-color-border-input);--arcgis-ticks-gap: 1em;--arcgis-ticks-font-size: var(--calcite-font-size--2)}.container{align-items:stretch;display:flex;color:var(--calcite-color-text-2);flex:1;font-weight:var(--calcite-font-weight-medium);font-size:var(--arcgis-ticks-font-size);line-height:1em;position:relative;user-select:none;word-wrap:normal;word-break:normal}.baseline{background-color:var(--arcgis-ticks-tick-color, var(--calcite-color-border-input))}.tick{position:absolute;background-color:var(--arcgis-ticks-tick-color, var(--calcite-color-border-input))}.tick-label{position:absolute;text-align:var(--arcgis-ticks-label-text-align, center);width:var(--arcgis-ticks-label-width, var(--labels-container-width, "auto"))}:host([layout="horizontal"]){.ticks-container{height:var(--arcgis-ticks-tick-length)}.labels-container{height:var(--labels-container-height, "auto")}.tick{width:.125rem;height:var(--arcgis-ticks-tick-length);transform:translate(-50%)}.tick-label{transform:translate(-50%)}.tick--min{transform:unset}.tick--max{transform:translate(-100%)}}:host([layout="vertical"]){.ticks-container{width:var(--arcgis-ticks-tick-length)}.labels-container{width:var(--labels-container-width)}.tick{width:var(--arcgis-ticks-tick-length);height:.125rem;transform:translateY(50%)}.tick-label{text-align:right;transform:translateY(50%)}.tick--min{transform:unset}.tick--max{transform:translateY(100%)}}:host([layout="horizontal"][mirrored]){.tick,.tick-label{transform:translate(50%)}.tick--min{transform:unset}.tick--max{transform:translate(100%)}}:host([layout="vertical"][mirrored]){.tick,.tick-label{transform:translateY(-50%)}.tick--min{transform:unset}.tick--max{transform:translateY(-100%)}}:host([layout="horizontal"][label-placement="start"]){.container{flex-direction:column;justify-content:flex-end}.labels-container{margin-bottom:var(--arcgis-ticks-gap)}}:host([layout="horizontal"][label-placement="end"]){.container{flex-direction:column-reverse;justify-content:flex-end}.labels-container{margin-top:var(--arcgis-ticks-gap)}}:host([layout="vertical"][label-placement="start"]){.container{flex-direction:row;justify-content:flex-end}:dir(ltr){.labels-container{margin-right:var(--arcgis-ticks-gap)}.tick-label{text-align:right}}:dir(rtl){.labels-container{margin-left:var(--arcgis-ticks-gap)}.tick-label{text-align:left;unicode-bidi:plaintext}}}:host([layout="vertical"][label-placement="end"]){.container{flex-direction:row-reverse;justify-content:flex-end}:dir(ltr){.labels-container{margin-left:var(--arcgis-ticks-gap)}.tick-label{text-align:left}}:dir(rtl){.labels-container{margin-right:var(--arcgis-ticks-gap)}.tick-label{text-align:right;unicode-bidi:plaintext}}}:host([interactive]){pointer-events:none;.tick,.tick-label{pointer-events:auto;cursor:pointer}.tick-label:hover{text-decoration:underline}}`;
 class F extends _ {
   constructor() {
     super(...arguments), this._formatValue = (e) => z(e, this._formatOptions), this._formatOptions = {
@@ -20,7 +20,7 @@ class F extends _ {
       useGrouping: !0,
       minimumFractionDigits: 0,
       maximumFractionDigits: 2
-    }, this.interactive = !1, this.interpolationExponent = 0, this.labelPlacement = "trailing", this.layout = "horizontal", this.max = 100, this.min = 0, this.mirrored = !1, this.mode = "count", this.showLabels = !1, this.showBaseline = !1, this.values = [], this.arcgisTickClick = C({ cancelable: !1 });
+    }, this.interactive = !1, this.interpolationExponent = 0, this.labelPlacement = "end", this.layout = "horizontal", this.max = 100, this.min = 0, this.mirrored = !1, this.mode = "count", this.showLabels = !1, this.showBaseline = !1, this.values = [], this.arcgisTickClick = C({ cancelable: !1 });
   }
   static {
     this.properties = { _formatOptions: 16, interactive: 7, interpolationExponent: 9, labelFormatter: 0, labelPlacement: 3, layout: 3, max: 9, min: 9, mirrored: 7, mode: 1, showLabels: 5, showBaseline: 5, values: [9, { converter: {
@@ -38,10 +38,10 @@ class F extends _ {
     this.styles = A;
   }
   updated() {
-    const e = this.renderRoot.querySelector(`.${s.labelsContainer}`);
+    const e = this.renderRoot.querySelector(`.${n.labelsContainer}`);
     if (e) {
       let t = 0, i = 0;
-      for (const r of this.renderRoot.querySelectorAll(`.${s.tickLabel}`)) {
+      for (const r of this.renderRoot.querySelectorAll(`.${n.tickLabel}`)) {
         const a = r.getBoundingClientRect();
         t = Math.max(t, a.width), i = Math.max(i, a.height);
       }
@@ -62,30 +62,30 @@ class F extends _ {
     return i ?? this._formatValue(e);
   }
   render() {
-    return c`<div class=${h(s.container)} touch-action=none @click=${this._handleClick}>${this._renderContent()}${this._renderBaseline()}</div>`;
+    return c`<div class=${h(n.container)} touch-action=none @click=${this._handleClick}>${this._renderContent()}${this._renderBaseline()}</div>`;
   }
   _renderContent() {
-    const { interpolationExponent: e, max: t, min: i, mode: r, values: a, layout: o, mirrored: l, showLabels: x } = this, k = [], b = [];
+    const { interpolationExponent: e, max: t, min: i, mode: r, values: a, layout: o, mirrored: l, showLabels: x } = this, g = [], b = [];
     for (const [f, d] of L(r, i, t, e, a)) {
       const p = { [o === "horizontal" ? l ? "right" : "left" : l ? "top" : "bottom"]: `${f}%` }, w = {
-        [s.tick]: !0,
-        [s.tickMin]: f === 0,
-        [s.tickMax]: f === 100
+        [n.tick]: !0,
+        [n.tickMin]: f === 0,
+        [n.tickMax]: f === 100
       };
-      k.push(c`<div class=${h(w)} style=${u(p)} data-value=${d ?? v}></div>`), x && b.push(c`<div class=${h(s.tickLabel)} style=${u(p)} data-value=${d ?? v}>${this._internalLabelFormatter(d)}</div>`);
+      g.push(c`<div class=${h(w)} style=${u(p)} data-value=${d ?? v}></div>`), x && b.push(c`<div class=${h(n.tickLabel)} style=${u(p)} data-value=${d ?? v}>${this._internalLabelFormatter(d)}</div>`);
     }
-    return [c`<div class=${h(s.labelsContainer)}>${b}</div>`, c`<div class=${h(s.ticksContainer)}>${k}</div>`];
+    return [c`<div class=${h(n.labelsContainer)}>${b}</div>`, c`<div class=${h(n.ticksContainer)}>${g}</div>`];
   }
   _renderBaseline() {
     const { showBaseline: e, layout: t } = this;
-    return e && c`<div class=${h(s.baseline)} style=${u({
+    return e && c`<div class=${h(n.baseline)} style=${u({
       [t === "horizontal" ? "width" : "height"]: "100%",
       [t === "horizontal" ? "height" : "width"]: "0.125rem"
     })}></div>` || "";
   }
 }
-function* L(n, e, t, i, r) {
-  switch (n) {
+function* L(s, e, t, i, r) {
+  switch (s) {
     case "value": {
       const a = Array.isArray(r) ? r : [r];
       for (const o of a) {
@@ -116,24 +116,24 @@ function* L(n, e, t, i, r) {
     }
   }
 }
-function g(n, e, t) {
-  return t < n ? n : t > e ? e : t;
+function k(s, e, t) {
+  return t < s ? s : t > e ? e : t;
 }
-function y(n, e, t) {
-  return n + (e - n) * t;
+function y(s, e, t) {
+  return s + (e - s) * t;
 }
-function P(n, e, t, i = 0) {
-  let r = (t - n) / (e - n);
-  if (r = g(0, 1, r), Math.abs(i) < 1e-9)
+function P(s, e, t, i = 0) {
+  let r = (t - s) / (e - s);
+  if (r = k(0, 1, r), Math.abs(i) < 1e-9)
     return r;
   const a = 1 + Math.expm1(i) * r;
-  return r = Math.log(a) / i, g(0, 1, r);
+  return r = Math.log(a) / i, k(0, 1, r);
 }
-function m(n, e, t, i = 0) {
-  if (t = g(0, 1, t), Math.abs(i) < 1e-9)
-    return y(n, e, t);
+function m(s, e, t, i = 0) {
+  if (t = k(0, 1, t), Math.abs(i) < 1e-9)
+    return y(s, e, t);
   const r = Math.expm1(i * t) / Math.expm1(i);
-  return y(n, e, r);
+  return y(s, e, r);
 }
 $("arcgis-ticks", F);
 export {

package/dist/components/arcgis-ticks/types.d.ts

@@ -0,0 +1,23 @@
+/**
+ * The layout of the [arcgis-ticks](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/) component, which determines the orientation of the ticks.
+ *
+ * @since 5.0
+ */
+export type Layout = "horizontal" | "vertical";
+
+/**
+ * The mode of positioning ticks along the [arcgis-ticks](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/) component. It drives how [arcgis-ticks.values](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/#values) is interpreted.
+ * - `count`: Places a fixed number of ticks (provided in the [arcgis-ticks.values](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/#values) property) at equal distances from each other.
+ * - `percent`: [arcgis-ticks.values](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/#values) is interpreted as percentage. If [arcgis-ticks.values](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/#values) is a number, it indicates the interval between ticks. If it is an array, it indicates the percentage values at which to place the ticks.
+ * - `value`: Indicates that ticks will only be placed at the values specified in the property.
+ *
+ * @since 5.0
+ */
+export type TickMode = "count" | "percent" | "value";
+
+/**
+ * Indicates where ticks will be rendered along the [arcgis-ticks](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-ticks/) component.
+ *
+ * @since 5.0
+ */
+export type TickValues = number[] | number;

package/dist/components/arcgis-unique-values-list/customElement.d.ts

@@ -2,9 +2,14 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { SupportedLayer } from "./utils/basic.js";
+import type { FieldSource } from "../../utils/types.js";
 import type { T9nMeta } from "@arcgis/lumina/controllers";
 
-/** Displays a list of unique values taking into account field type formatting and field domains. */
+/**
+ * Displays a list of unique values taking into account field type formatting and field domains.
+ *
+ * @internal
+ */
 export abstract class ArcgisUniqueValuesList extends LitElement {
   /** @internal */
   protected _messages: {
@@ -28,6 +33,8 @@ export abstract class ArcgisUniqueValuesList extends LitElement {
   }>;
   /** Field name, required if uniqueValues is not provided, if component needs to format values, or needs to check for field domains. */
   accessor fieldName: string | undefined;
+  /** Optional, specify field source other than the layer's fields. */
+  accessor fieldSource: FieldSource | undefined;
   /** Layer instance, required if uniqueValues is not provided, if component needs to format values, or needs to check for field domains. */
   accessor layer: SupportedLayer | undefined;
   /** Optional, max height of list in pixel. */