@esri/calcite-components
Version:
Web Components for Esri's Calcite Design System.
78 lines (77 loc) • 3.3 kB
TypeScript
/// <reference path="../../index.d.ts" />
import type { PublicLitElement as LitElement } from "@arcgis/lumina";
import type { Scale } from "../interfaces.js";
import type { NumberingSystem } from "../../utils/locale.js";
import type { HourFormat } from "../../utils/time.js";
import type { useTime } from "../../controllers/useTime.js";
/**
* @cssproperty [--calcite-time-picker-background-color] - Specifies the component's background color.
* @cssproperty [--calcite-time-picker-border-color] - Specifies the component's border color.
* @cssproperty [--calcite-time-picker-corner-radius] - Specifies the component's border radius.
* @cssproperty [--calcite-time-picker-button-background-color-hover] - Specifies the button's background color when hovered or focused.
* @cssproperty [--calcite-time-picker-button-background-color-press] - Specifies the button's background color when active.
* @cssproperty [--calcite-time-picker-color] - Specifies the component's text color.
* @cssproperty [--calcite-time-picker-icon-color] - Specifies the component's icon color.
* @cssproperty [--calcite-time-picker-input-border-color-press] - Specifies the input's border color when active.
* @cssproperty [--calcite-time-picker-input-border-color-hover] - Specifies the input's border color when hovered.
*/
export abstract class TimePicker extends LitElement {
/**
* Specifies the component's hour format, where:
*
* `"user"` displays the user's locale format,
* `"12"` displays a 12-hour format, and
* `"24"` displays a 24-hour format.
*
* @default "user"
*/
accessor hourFormat: HourFormat;
/** Overrides individual strings used by the component. */
accessor messageOverrides: {
fractionalSecond?: string;
fractionalSecondDown?: string;
fractionalSecondUp?: string;
hour?: string;
hourDown?: string;
hourUp?: string;
meridiem?: string;
meridiemDown?: string;
meridiemUp?: string;
minute?: string;
minuteDown?: string;
minuteUp?: string;
second?: string;
secondDown?: string;
secondUp?: string;
};
/** Specifies the Unicode numeral system used by the component for localization. */
accessor numberingSystem: NumberingSystem;
/**
* Specifies the component's size.
*
* @default "m"
*/
accessor scale: Scale;
/**
* Specifies the granularity the `value` must adhere to (in seconds).
*
* @default 60
*/
accessor step: number;
/** @internal */
accessor time: ReturnType<typeof useTime>;
/** The component's value in UTC (always 24-hour format). */
accessor value: string;
/**
* Sets focus on the component's first focusable element.
*
* @param options - When specified an optional object customizes the component's focusing process. When `preventScroll` is `true`, scrolling will not occur on the component.
* @mdn [focus(options)](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus#options)
*/
setFocus(options?: FocusOptions): Promise<void>;
/** Fires when a user changes the component's time */
readonly calciteTimePickerChange: import("@arcgis/lumina").TargetedEvent<this, void>;
readonly "@eventTypes": {
calciteTimePickerChange: TimePicker["calciteTimePickerChange"]["detail"];
};
}