hys-ui 0.2.0 → 0.4.0

package/dist/types/composables/popupSurface.d.ts

@@ -0,0 +1,83 @@
+import type { CSSProperties, VNodeChild } from "vue";
+import type { HysPopupMotionProps } from "../motion/popup";
+import type { Placement } from "./useFloating";
+export type HysPopupPlacement = Placement;
+export type HysPopupTrigger = "hover" | "focus" | "click" | "contextmenu" | "manual";
+export interface HysPopupVirtualReference {
+    getBoundingClientRect: () => DOMRect;
+    contextElement?: HTMLElement;
+}
+export type HysPopupReference = HTMLElement | HysPopupVirtualReference;
+export interface HysPopupSurfaceProps extends HysPopupMotionProps {
+    open?: boolean;
+    modelValue?: boolean;
+    defaultOpen?: boolean;
+    disabled?: boolean;
+    trigger?: HysPopupTrigger | readonly HysPopupTrigger[];
+    triggerKeys?: readonly string[];
+    triggerTabindex?: number;
+    placement?: HysPopupPlacement;
+    offset?: number;
+    autoAdjustOverflow?: boolean;
+    showDelay?: number;
+    hideDelay?: number;
+    autoClose?: number;
+    enterable?: boolean;
+    closeOnEscape?: boolean;
+    closeOnOutside?: boolean;
+    destroyOnHide?: boolean;
+    forceRender?: boolean;
+    appendTo?: string | HTMLElement | false;
+    reference?: HysPopupReference | (() => HysPopupReference | undefined);
+    width?: string | number;
+    maxWidth?: string | number;
+    maxHeight?: string | number;
+    showArrow?: boolean;
+    arrowOffset?: number;
+    effect?: "light" | "dark";
+    color?: string;
+    textColor?: string;
+    overlayClass?: string;
+    overlayStyle?: CSSProperties;
+    contentClass?: string;
+    contentStyle?: CSSProperties;
+    zIndex?: number;
+    ariaLabel?: string;
+}
+export interface HysTooltipProps extends HysPopupSurfaceProps {
+    text?: string;
+}
+export interface HysPopoverProps extends HysPopupSurfaceProps {
+    title?: string;
+    content?: string;
+}
+export interface HysPopupSurfaceContext {
+    open: boolean;
+    show: () => Promise<boolean>;
+    close: () => Promise<boolean>;
+    toggle: () => Promise<boolean>;
+    updatePosition: () => void;
+}
+export interface HysTooltipSlots {
+    default?: (scope: HysPopupSurfaceContext) => VNodeChild;
+    content?: (scope: HysPopupSurfaceContext) => VNodeChild;
+}
+export interface HysPopoverSlots {
+    trigger?: (scope: HysPopupSurfaceContext) => VNodeChild;
+    default?: (scope: HysPopupSurfaceContext) => VNodeChild;
+    title?: (scope: HysPopupSurfaceContext) => VNodeChild;
+}
+export interface HysPopupSurfaceInstance {
+    readonly element: HTMLElement | undefined;
+    readonly referenceElement: HTMLElement | undefined;
+    readonly open: boolean;
+    readonly placement: HysPopupPlacement;
+    show: () => Promise<boolean>;
+    hide: () => Promise<boolean>;
+    close: () => Promise<boolean>;
+    toggle: () => Promise<boolean>;
+    updatePosition: () => void;
+    focus: () => void;
+}
+export type HysTooltipInstance = HysPopupSurfaceInstance;
+export type HysPopoverInstance = HysPopupSurfaceInstance;

package/dist/types/composables/progress.d.ts

@@ -0,0 +1,92 @@
+import type { VNodeChild } from "vue";
+export type HysProgressType = "line" | "circle" | "dashboard";
+export type HysProgressStatus = "normal" | "success" | "warning" | "error" | "active";
+export type HysProgressSize = "sm" | "md" | "lg";
+export type HysProgressLinecap = "round" | "butt" | "square";
+export type HysProgressGapPosition = "top" | "right" | "bottom" | "left";
+export type HysProgressGradientDirection = number | "to right" | "to left" | "to top" | "to bottom" | "to top right" | "to top left" | "to bottom right" | "to bottom left";
+export interface HysProgressGradientStop {
+    offset: number;
+    color: string;
+}
+export interface HysProgressGradient {
+    from: string;
+    to: string;
+    direction?: HysProgressGradientDirection;
+    stops?: readonly HysProgressGradientStop[];
+}
+export interface HysProgressColorStop {
+    value: number;
+    color: string;
+}
+export type HysProgressColor = string | ((value: number) => string) | readonly HysProgressColorStop[] | readonly string[] | HysProgressGradient;
+export interface HysProgressSuccess {
+    value: number;
+    color?: HysProgressColor;
+}
+export interface HysProgressLabelContext {
+    value: number;
+    successValue: number;
+    status: HysProgressStatus;
+    indeterminate: boolean;
+}
+export interface HysProgressProps {
+    value: number;
+    showLabel?: boolean;
+    color?: HysProgressColor;
+    status?: HysProgressStatus;
+    strokeWidth?: number;
+    type?: HysProgressType;
+    width?: number | string;
+    format?: (value: number, successValue: number) => VNodeChild;
+    indeterminate?: boolean;
+    size?: HysProgressSize;
+    textInside?: boolean;
+    textColor?: string;
+    precision?: number;
+    showStatusIcon?: boolean;
+    trailColor?: string;
+    strokeLinecap?: HysProgressLinecap;
+    success?: HysProgressSuccess;
+    steps?: number;
+    stepGap?: number;
+    gapDegree?: number;
+    gapPosition?: HysProgressGapPosition;
+    striped?: boolean;
+    stripedFlow?: boolean;
+    animated?: boolean;
+    duration?: number;
+    flowDuration?: number;
+    ariaLabel?: string;
+    ariaValueText?: string | ((context: HysProgressLabelContext) => string);
+}
+export interface HysProgressSlots {
+    default?: (context: HysProgressLabelContext) => VNodeChild;
+    icon?: (context: HysProgressLabelContext) => VNodeChild;
+}
+export interface HysProgressInstance {
+    readonly element: HTMLElement | undefined;
+    readonly value: number;
+    readonly successValue: number;
+    readonly status: HysProgressStatus;
+}
+export declare const progressPercent: (value: number | undefined) => number;
+export declare const progressNumber: (value: number | undefined, fallback: number, min: number, max: number) => number;
+export declare const progressStatusColor: (status: HysProgressStatus) => string;
+export type ProgressPaint = {
+    color: string;
+    gradient?: {
+        stops: HysProgressGradientStop[];
+        angle: number;
+    };
+};
+export declare function progressPaint(color: HysProgressColor | undefined, value: number, fallback: string): ProgressPaint;
+export declare function progressCssPaint(paint: ProgressPaint): string;
+export declare function progressGradientCoordinates(degrees: number): {
+    x1: number;
+    y1: number;
+    x2: number;
+    y2: number;
+};
+export declare function progressArc(radius: number, start: number, degrees: number): string;
+export declare const progressId: () => string;

package/dist/types/composables/selectOptions.d.ts

@@ -1,5 +1,10 @@
 export type HysSelectValue = string | number | boolean | Record<string, unknown>;
 export type HysSelectModelValue = HysSelectValue | HysSelectValue[] | null;
+export type HysSelectLabeledValue = {
+    value: HysSelectValue;
+    label: string;
+};
+export declare function isSelectLabeledValue(value: HysSelectValue): value is HysSelectLabeledValue;
 export interface HysSelectOption {
     label: string;
     value: HysSelectValue;
@@ -29,6 +34,8 @@ export interface HysSelectInstance {
     close: () => void;
     scrollTo: (value: HysSelectValue) => void;
     retry: () => void;
+    selectAll: () => number;
+    deselectAll: () => number;
     selected: HysSelectOption[];
     query: string;
     isOpen: boolean;

package/dist/types/composables/splitPaneSizes.d.ts

@@ -0,0 +1,11 @@
+import type { HysSplitPaneLength } from "../components/HysSplitPane/HysSplitPane.vue";
+export declare const paneEpsilon = 1e-7;
+export declare function paneRatio(value: HysSplitPaneLength | undefined, available: number): number | undefined;
+interface PanePreference {
+    min: number;
+    max: number;
+    preferred?: number;
+    relative?: boolean;
+}
+export declare function fitPaneSizes(panes: readonly PanePreference[]): number[];
+export {};

package/dist/types/composables/table.d.ts

@@ -1,4 +1,5 @@
-import type { CSSProperties, HTMLAttributes, VNodeChild } from "vue";
+import type { HysPopupTransition } from '../motion/popup';
+import type { Component, CSSProperties, HTMLAttributes, VNodeChild } from "vue";
 import type { Placement } from "./useFloating";
 export type HysTableKey = string | number;
 export type HysTableDirection = "asc" | "desc";
@@ -19,6 +20,22 @@ export interface HysTableSelectionColumn {
     fixed?: boolean | "left" | "right";
     align?: "left" | "center" | "right";
 }
+export interface HysTableRowSelectionOptions {
+    range?: boolean;
+    /** 只允许指定行绕过行级选择限制。 */
+    ignoreSelectable?: boolean;
+}
+export interface HysTableSelectionAction<T extends object = Record<string, unknown>> {
+    key: string;
+    label: string;
+    disabled?: boolean;
+    select: (context: {
+        rows: readonly T[];
+        keys: readonly HysTableKey[];
+        selectedKeys: readonly HysTableKey[];
+        setSelected: (keys: readonly HysTableKey[]) => Promise<boolean>;
+    }) => void | Promise<void>;
+}
 export interface HysTableFilterConfirmOptions {
     closeDropdown?: boolean;
 }
@@ -29,12 +46,26 @@ export interface HysTableScrollRowOptions {
     behavior?: ScrollBehavior;
     block?: "start" | "center" | "end" | "nearest";
 }
+export interface HysTableStickyOptions {
+    offsetHeader?: number;
+    offsetScroll?: number;
+    getContainer?: () => HTMLElement | Window | null | undefined;
+}
 export interface HysTableFilter {
     label: string;
     value: HysTableFilterValue;
     disabled?: boolean;
     children?: readonly HysTableFilter[];
 }
+export interface HysTableFilterDropdownContext<T extends object = Record<string, unknown>> {
+    column: HysTableColumn<T>;
+    open: boolean;
+    values: readonly HysTableFilterValue[];
+    setValues: (values: readonly HysTableFilterValue[]) => void;
+    confirm: (options?: HysTableFilterConfirmOptions) => void;
+    clear: (options?: HysTableFilterResetOptions) => void;
+    close: () => void;
+}
 export type HysTableElementAttrs = HTMLAttributes & Record<string, unknown>;
 export type HysTablePaginationPosition = "top-left" | "top-center" | "top-right" | "bottom-left" | "bottom-center" | "bottom-right";
 export interface HysTableCellContext<T extends object = Record<string, unknown>> {
@@ -44,6 +75,28 @@ export interface HysTableCellContext<T extends object = Record<string, unknown>>
     rowIndex: number;
     columnIndex: number;
 }
+export interface HysTableOverflowTooltipOptions {
+    placement?: Placement;
+    effect?: "light" | "dark";
+    maxWidth?: number | string;
+    offset?: number;
+    hideDelay?: number;
+    enterable?: boolean;
+}
+export interface HysTableComponents {
+    table?: Component;
+    header?: {
+        wrapper?: Component;
+        row?: Component;
+        cell?: Component;
+    };
+    body?: {
+        wrapper?: Component;
+        row?: Component;
+        cell?: Component;
+        rowHeaderCell?: Component;
+    };
+}
 export interface HysTableColumn<T extends object = any> {
     key: string;
     label: string;
@@ -56,11 +109,18 @@ export interface HysTableColumn<T extends object = any> {
     fixed?: boolean | "left" | "right";
     align?: "left" | "center" | "right";
     headerAlign?: "left" | "center" | "right";
+    /** 合并同一层、同一固定区域内相邻的叶列表头。0 隐藏标题。 */
+    headerColSpan?: number;
+    /** 表头插槽未提供内容时渲染列标题。 */
+    renderHeader?: (column: HysTableColumn<T>, sorts: readonly HysTableSort[]) => VNodeChild;
     sortable?: boolean | "custom";
     sorter?: (a: T, b: T) => number;
     sortBy?: string | ((row: T) => unknown) | readonly (string | ((row: T) => unknown))[];
     sortOrders?: readonly (HysTableDirection | null)[];
     defaultSortOrder?: HysTableDirection;
+    /** 受控排序方向，null 清除该列排序。表格级 sort 和 sorts 优先。 */
+    sortOrder?: HysTableDirection | null;
+    showSorterTooltip?: boolean | HysTableOverflowTooltipOptions;
     sortPriority?: number;
     filters?: readonly HysTableFilter[];
     filterable?: boolean;
@@ -68,11 +128,25 @@ export interface HysTableColumn<T extends object = any> {
     filterMode?: "menu" | "tree";
     filterSearch?: boolean | ((query: string, option: HysTableFilter) => boolean);
     defaultFilterValue?: readonly HysTableFilterValue[];
+    /** 受控筛选值，空数组清除该列筛选。表格级 filters 优先。 */
+    filteredValue?: readonly HysTableFilterValue[];
+    filtered?: boolean;
+    filterDropdownOpen?: boolean;
+    onFilterDropdownOpenChange?: (open: boolean) => void;
+    filterPlacement?: Placement;
+    renderFilterIcon?: (context: {
+        column: HysTableColumn<T>;
+        filtered: boolean;
+        open: boolean;
+    }) => VNodeChild;
+    renderFilterDropdown?: (context: HysTableFilterDropdownContext<T>) => VNodeChild;
     filterResetToDefault?: boolean;
     filterMethod?: (value: HysTableFilterValue, row: T, column: HysTableColumn<T>) => boolean;
     formatter?: (row: T, column: HysTableColumn<T>, value: unknown, index: number) => VNodeChild;
-    ellipsis?: boolean;
-    showOverflowTooltip?: boolean;
+    ellipsis?: boolean | {
+        showTitle?: boolean;
+    };
+    showOverflowTooltip?: boolean | HysTableOverflowTooltipOptions;
     tooltipFormatter?: (context: HysTableCellContext<T>) => VNodeChild;
     className?: string;
     headerClassName?: string;
@@ -90,12 +164,20 @@ export interface HysTablePagination {
     position?: readonly HysTablePaginationPosition[];
     page?: number;
     pageSize?: number;
+    defaultPage?: number;
+    defaultPageSize?: number;
     total?: number;
+    /** 服务端分页的总页数，可在总记录数未知时使用。 */
+    pageCount?: number;
     pageSizeOptions?: number[];
     showSizeChanger?: boolean;
     showQuickJumper?: boolean;
     showTotal?: boolean;
     compact?: boolean;
+    layout?: string;
+    size?: "sm" | "md" | "lg";
+    responsive?: boolean;
+    siblingCount?: number;
     hideOnSinglePage?: boolean;
 }
 export interface HysTableQuery<T extends object = Record<string, unknown>> {
@@ -130,6 +212,8 @@ export interface HysTableLocale {
     resizeColumn: string;
     sortAsc: string;
     sortDesc: string;
+    sortClear?: string;
+    stickyScrollLabel?: string;
     filterSearch?: string;
     noFilterMatch?: string;
     invertSelection?: string;
@@ -140,6 +224,9 @@ export interface HysTableLocale {
         perPage: string;
         jump: string;
         page: string;
+        pageItem: string;
+        navigation: string;
+        confirm: string;
         first: string;
         previous: string;
         next: string;
@@ -147,12 +234,18 @@ export interface HysTableLocale {
     }>;
 }
 export interface HysTableProps<T extends object> {
+    popupTransition?: HysPopupTransition;
+    popupTransitionDuration?: number;
     locale?: Partial<HysTableLocale>;
     columns: readonly HysTableColumn<T>[];
     rows: readonly T[];
+    /** 替换表格的结构组件。自定义组件需转发属性与默认插槽，并保留原生表格元素。 */
+    components?: HysTableComponents;
     rowKey?: string | ((row: T) => HysTableKey);
     emptyText?: string;
     loading?: boolean;
+    /** replace 用加载行替换数据，overlay 保留当前行并覆盖加载提示。 */
+    loadingMode?: "replace" | "overlay";
     disabled?: boolean;
     striped?: boolean;
     bordered?: boolean;
@@ -162,9 +255,15 @@ export interface HysTableProps<T extends object> {
     height?: number | string;
     maxHeight?: number | string;
     stickyHeader?: boolean;
+    /** 随页面或自定义容器滚动固定表头和水平滚动条。 */
+    sticky?: boolean | HysTableStickyOptions;
     showHeader?: boolean;
     fit?: boolean;
+    /** 表格横向最小宽度，用于控制滚动区域内的列布局。 */
+    scrollWidth?: number | string;
     scrollbarAlwaysOn?: boolean;
+    /** 使用浏览器默认的滚动条样式。 */
+    nativeScrollbar?: boolean;
     scrollbarTabindex?: number | string;
     headerRowClassName?: string | ((columns: readonly HysTableColumn<T>[], level: number) => string);
     headerRowStyle?: CSSProperties | ((columns: readonly HysTableColumn<T>[], level: number) => CSSProperties);
@@ -185,7 +284,7 @@ export interface HysTableProps<T extends object> {
     reserveSelection?: boolean;
     checkStrictly?: boolean;
     selectOnIndeterminate?: boolean;
-    selectionActions?: boolean;
+    selectionActions?: boolean | readonly HysTableSelectionAction<T>[];
     rangeSelection?: boolean;
     hideSelectAll?: boolean;
     selectionColumn?: HysTableSelectionColumn;
@@ -200,11 +299,15 @@ export interface HysTableProps<T extends object> {
     defaultSort?: HysTableSort | readonly HysTableSort[] | null;
     multiSort?: boolean;
     sortOrders?: readonly (HysTableDirection | null)[];
+    /** 悬停或聚焦列标题时提示下一次排序操作。 */
+    showSorterTooltip?: boolean | HysTableOverflowTooltipOptions;
     filters?: HysTableFilters;
     defaultFilters?: HysTableFilters;
     filterColumnKey?: string | null;
     filterPlacement?: Placement;
     appendFilterTo?: string | HTMLElement | false;
+    /** 根据触发元素指定排序、溢出与筛选浮层的挂载目标。 */
+    getPopupContainer?: (trigger: HTMLElement) => HTMLElement | string | false | undefined;
     pagination?: boolean | HysTablePagination;
     page?: number;
     pageSize?: number;
@@ -227,6 +330,10 @@ export interface HysTableProps<T extends object> {
     indent?: number;
     loadChildren?: (row: T, context: HysTableLoadContext) => readonly T[] | Promise<readonly T[]>;
     showSummary?: boolean;
+    /** 汇总全部筛选结果，或仅汇总当前页实际显示的行。 */
+    summaryScope?: "filtered" | "page";
+    /** 将汇总行固定在表格滚动区域底部。 */
+    stickySummary?: boolean;
     sumText?: string;
     summaryMethod?: (context: {
         columns: readonly HysTableColumn<T>[];
@@ -236,8 +343,13 @@ export interface HysTableProps<T extends object> {
         rowspan?: number;
         colspan?: number;
     } | readonly [number, number] | undefined;
-    showOverflowTooltip?: boolean;
+    /** 默认溢出提示，列可覆盖配置或设置 false 关闭。 */
+    showOverflowTooltip?: boolean | HysTableOverflowTooltipOptions;
     tooltipFormatter?: (context: HysTableCellContext<T>) => VNodeChild;
+    /** 在列格式化后统一处理默认单元格内容。 */
+    transformCellText?: (context: HysTableCellContext<T> & {
+        text: VNodeChild;
+    }) => VNodeChild;
     resizable?: boolean;
     columnWidths?: Readonly<Record<string, number>>;
     allowDragLastColumn?: boolean;
@@ -253,7 +365,7 @@ export interface HysTableInstance<T extends object = Record<string, unknown>> {
     clearSelection: () => Promise<boolean>;
     getSelectionRows: () => T[];
     getHalfSelectionRows: () => T[];
-    toggleRowSelection: (row: T | HysTableKey, selected?: boolean, range?: boolean) => Promise<boolean>;
+    toggleRowSelection: (row: T | HysTableKey, selected?: boolean, options?: boolean | HysTableRowSelectionOptions) => Promise<boolean>;
     toggleAllSelection: (selected?: boolean) => Promise<boolean>;
     invertSelection: () => Promise<boolean>;
     setCurrentRow: (row?: T | HysTableKey | null) => Promise<boolean>;
@@ -292,6 +404,7 @@ export interface TableHeader<T extends object> {
     leaves: HysTableColumn<T>[];
     colspan: number;
     rowspan: number;
+    blank?: boolean;
     fixed?: "left" | "right";
 }
 export declare const tableToken: (key: HysTableKey) => string;

package/dist/types/composables/tagInput.d.ts

@@ -0,0 +1,96 @@
+import type { Component, VNodeChild } from "vue";
+import type { HysPopupMotionProps } from "../motion/popup";
+export type HysTagInputReason = "keyboard" | "blur" | "separator" | "paste" | "api";
+export interface HysTagInputAddContext {
+    signal: AbortSignal;
+    values: readonly string[];
+    reason: HysTagInputReason;
+}
+export interface HysTagInputInvalid {
+    value: string;
+    reason: "duplicate" | "max" | "guard" | "error" | "maxlength" | "minlength";
+    error?: Error;
+}
+export interface HysTagInputProps extends HysPopupMotionProps {
+    modelValue?: readonly string[];
+    defaultValue?: readonly string[];
+    max?: number;
+    placeholder?: string;
+    disabled?: boolean;
+    readonly?: boolean;
+    size?: "sm" | "md" | "lg";
+    addOnBlur?: boolean;
+    separator?: string;
+    delimiters?: string | readonly string[] | RegExp;
+    trigger?: "Enter" | "Space" | "Tab" | readonly string[];
+    beforeAdd?: (value: string, context: HysTagInputAddContext) => boolean | void | Promise<boolean | void>;
+    allowDuplicates?: boolean;
+    caseSensitive?: boolean;
+    trim?: boolean;
+    clearable?: boolean;
+    clearIcon?: Component;
+    tagTone?: "primary" | "success" | "warning" | "danger" | "neutral";
+    tagEffect?: "light" | "dark" | "outline";
+    tagRound?: boolean;
+    draggable?: boolean;
+    collapseTags?: boolean;
+    maxCollapseTags?: number;
+    collapseTagsTooltip?: boolean;
+    overflowHeight?: number;
+    maxTagTextLength?: number;
+    maxlength?: number;
+    minlength?: number;
+    ariaLabel?: string;
+    label?: string;
+    name?: string;
+    form?: string;
+    autocomplete?: string;
+    autofocus?: boolean;
+    tabindex?: number;
+    status?: "error" | "warning" | "success";
+    error?: string;
+    validateEvent?: boolean;
+    inputProps?: Record<string, unknown>;
+}
+export interface HysTagInputSlotContext {
+    values: readonly string[];
+    draft: string;
+    disabled: boolean;
+    readonly: boolean;
+    pending: boolean;
+    add: (value?: string | string[]) => Promise<boolean>;
+    clear: () => Promise<boolean>;
+}
+export interface HysTagInputTagContext {
+    value: string;
+    index: number;
+    disabled: boolean;
+    readonly: boolean;
+    remove: () => Promise<boolean>;
+}
+export interface HysTagInputSlots {
+    tag?: (context: HysTagInputTagContext) => VNodeChild;
+    prefix?: (context: HysTagInputSlotContext) => VNodeChild;
+    suffix?: (context: HysTagInputSlotContext) => VNodeChild;
+    "clear-icon"?: (context: HysTagInputSlotContext) => VNodeChild;
+    "remove-icon"?: (context: HysTagInputTagContext) => VNodeChild;
+    "collapse-tag"?: (context: {
+        count: number;
+        values: readonly string[];
+    }) => VNodeChild;
+}
+export interface HysTagInputInstance {
+    readonly element: HTMLElement | undefined;
+    readonly input: HTMLInputElement | undefined;
+    readonly values: readonly string[];
+    readonly draft: string;
+    readonly pending: boolean;
+    focus: (options?: FocusOptions) => void;
+    blur: () => void;
+    add: (value?: string | string[]) => Promise<boolean>;
+    remove: (index: number) => Promise<boolean>;
+    clear: () => Promise<boolean>;
+    move: (from: number, to: number) => Promise<boolean>;
+    setDraft: (value: string) => void;
+}
+export declare function splitTags(value: string, separator?: string | readonly string[] | RegExp): string[];

package/dist/types/composables/timeline.d.ts

@@ -0,0 +1,82 @@
+import type { Component, VNodeChild } from "vue";
+export type HysTimelineKey = string | number;
+export type HysTimelineMode = "left" | "right" | "alternate" | "alternate-reverse";
+export type HysTimelinePosition = "left" | "right";
+export type HysTimelineSize = "sm" | "md" | "lg";
+export type HysTimelineTone = "primary" | "success" | "warning" | "danger" | "info" | "neutral";
+export interface HysTimelineItem {
+    id?: HysTimelineKey;
+    key?: HysTimelineKey;
+    title: string;
+    time?: string;
+    dateTime?: string;
+    description?: string;
+    status?: "done" | "current" | "pending";
+    color?: string;
+    label?: string;
+    position?: HysTimelinePosition;
+    tone?: HysTimelineTone;
+    size?: HysTimelineSize | number;
+    hollow?: boolean;
+    loading?: boolean;
+    icon?: Component;
+    hideTime?: boolean;
+    timePlacement?: "top" | "bottom";
+}
+export type HysTimelineFieldNames = Partial<Record<keyof HysTimelineItem, string>>;
+export interface HysTimelineProps<T extends object = HysTimelineItem> {
+    items: readonly T[];
+    reverse?: boolean;
+    pending?: string | boolean;
+    mode?: HysTimelineMode;
+    itemKey?: string | ((item: T, index: number) => HysTimelineKey);
+    fieldNames?: HysTimelineFieldNames;
+    size?: HysTimelineSize;
+    hollow?: boolean;
+    showTime?: boolean;
+    timePlacement?: "top" | "bottom";
+    responsive?: boolean;
+    lineStyle?: "solid" | "dashed" | "dotted";
+    lineColor?: string;
+    pendingPosition?: "start" | "end";
+    pendingLoading?: boolean;
+    pendingText?: string;
+    emptyText?: string;
+    ariaLabel?: string;
+}
+export interface HysTimelineItemContext<T extends object = HysTimelineItem> {
+    item: T;
+    index: number;
+    sourceIndex: number;
+    key: HysTimelineKey;
+    title: string;
+    time: string;
+    description: string;
+    label: string;
+    position: HysTimelinePosition;
+    status: HysTimelineItem["status"];
+    tone: HysTimelineTone;
+    loading: boolean;
+}
+export interface HysTimelinePendingContext {
+    pending: string | boolean | undefined;
+    loading: boolean;
+}
+export interface HysTimelineSlots<T extends object = HysTimelineItem> {
+    item?: (context: HysTimelineItemContext<T>) => VNodeChild;
+    title?: (context: HysTimelineItemContext<T>) => VNodeChild;
+    description?: (context: HysTimelineItemContext<T>) => VNodeChild;
+    time?: (context: HysTimelineItemContext<T>) => VNodeChild;
+    label?: (context: HysTimelineItemContext<T>) => VNodeChild;
+    dot?: (context: HysTimelineItemContext<T>) => VNodeChild;
+    pending?: (context: HysTimelinePendingContext) => VNodeChild;
+    "pending-dot"?: (context: HysTimelinePendingContext) => VNodeChild;
+    empty?: () => VNodeChild;
+}
+export interface HysTimelineInstance<T extends object = HysTimelineItem> {
+    readonly element: HTMLOListElement | undefined;
+    getItems: () => T[];
+}
+export declare function timelineRead(item: object, path: string): unknown;
+export declare const timelineText: (value: unknown) => string;
+export declare const timelineTone: (tone: HysTimelineTone) => string;