@arcgis/common-components 5.0.0-next.159 → 5.0.0-next.160

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

@@ -1,6 +1,7 @@
 /// <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
@@ -186,10 +187,4 @@ export abstract class ArcgisTicks extends LitElement {
   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/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;