package.dist.index.d.ts Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of timer Show documentation
Core logic for the timer widget implemented as a state machine
The newest version!
import * as _zag_js_anatomy from '@zag-js/anatomy';
import { RequiredBy, PropTypes, CommonProperties, NormalizeProps } from '@zag-js/types';
import * as _zag_js_core from '@zag-js/core';
import { Machine, StateMachine } from '@zag-js/core';

declare const anatomy: _zag_js_anatomy.AnatomyInstance<"root" | "area" | "control" | "item" | "itemValue" | "itemLabel" | "actionTrigger" | "separator">;

interface Time {
    days: T;
    hours: T;
    minutes: T;
    seconds: T;
    milliseconds: T;
}
type TimePart = keyof Time;
type TimerAction = "start" | "pause" | "resume" | "reset";
type ElementIds = Partial<{
    root: string;
    area: string;
}>;
interface TickDetails {
    value: number;
    time: Time;
    formattedTime: Time;
}
interface PublicContext extends CommonProperties {
    /**
     * The ids of the timer parts
     */
    ids?: ElementIds;
    /**
     * Whether the timer should countdown, decrementing the timer on each tick.
     */
    countdown?: boolean;
    /**
     * The total duration of the timer in milliseconds.
     */
    startMs?: number;
    /**
     * The minimum count of the timer in milliseconds.
     */
    targetMs?: number;
    /**
     * Whether the timer should start automatically
     */
    autoStart?: boolean;
    /**
     * The interval in milliseconds to update the timer count.
     * @default 250
     */
    interval: number;
    /**
     * Function invoked when the timer ticks
     */
    onTick?: (details: TickDetails) => void;
    /**
     * Function invoked when the timer is completed
     */
    onComplete?: () => void;
}
interface PrivateContext {
}
type ComputedContext = Readonly<{
    /**
     * @computed
     * The time parts of the timer count.
     */
    time: Time;
    /**
     * @computed
     * The formatted time parts of the timer count.
     */
    formattedTime: Time;
    /**
     * @computed
     * The progress percentage of the timer.
     */
    progressPercent: number;
}>;
type UserDefinedContext = RequiredBy;
interface MachineContext extends PublicContext, PrivateContext, ComputedContext {
}
interface MachineState {
    value: "idle" | "running" | "paused";
}
type State = StateMachine.State;
type Send = StateMachine.Send;
type Service = Machine;
interface ItemProps {
    type: TimePart;
}
interface ActionTriggerProps {
    action: TimerAction;
}
interface MachineApi {
    /**
     * Whether the timer is running.
     */
    running: boolean;
    /**
     * Whether the timer is paused.
     */
    paused: boolean;
    /**
     * The formatted timer count value.
     */
    time: Time;
    /**
     * The formatted time parts of the timer count.
     */
    formattedTime: Time;
    /**
     * Function to start the timer.
     */
    start(): void;
    /**
     * Function to pause the timer.
     */
    pause(): void;
    /**
     * Function to resume the timer.
     */
    resume(): void;
    /**
     * Function to reset the timer.
     */
    reset(): void;
    /**
     * Function to restart the timer.
     */
    restart(): void;
    /**
     * The progress percentage of the timer.
     */
    progressPercent: number;
    getRootProps(): T["element"];
    getAreaProps(): T["element"];
    getControlProps(): T["element"];
    getItemProps(props: ItemProps): T["element"];
    getItemValueProps(props: ItemProps): T["element"];
    getItemLabelProps(props: ItemProps): T["element"];
    getSeparatorProps(): T["element"];
    getActionTriggerProps(props: ActionTriggerProps): T["button"];
}

declare function connect(state: State, send: Send, normalize: NormalizeProps): MachineApi;

declare function machine(userContext: UserDefinedContext): _zag_js_core.Machine;

declare function parse(date: string | Partial): number;

declare const props: ("id" | "ids" | "countdown" | "startMs" | "targetMs" | "autoStart" | "interval" | "onTick" | "onComplete" | "getRootNode")[];
declare const splitProps: >(props: Props) => [Partial, Omit];

export { type ActionTriggerProps, type MachineApi as Api, type UserDefinedContext as Context, type ElementIds, type ItemProps, type MachineState, type Service, type TickDetails, type Time, type TimePart, type TimerAction, anatomy, connect, machine, parse, props, splitProps };