hys-ui 0.3.0 → 0.5.0

package/dist/types/components/HysSplitPane/HysSplitPane.vue.d.ts

@@ -1,33 +1,144 @@
-type __VLS_Props = {
+export type HysSplitPaneSide = "first" | "second";
+export type HysSplitPaneLength = number | `${number}px` | `${number}%`;
+export interface HysSplitPanePanelOptions {
+    /** Panel minimum size. Numbers are pixels; strings accept px and %. */
+    min?: HysSplitPaneLength;
+    /** Panel maximum size. Numbers are pixels; strings accept px and %. */
+    max?: HysSplitPaneLength;
+    resizable?: boolean;
+    collapsible?: boolean;
+}
+export interface HysSplitPanePanel extends HysSplitPanePanelOptions {
+    id: string;
+    label?: string;
+    /** 初始尺寸。省略时自动分配剩余空间。 */
+    size?: HysSplitPaneLength;
+}
+export type HysSplitPaneSizes = Readonly<Record<string, HysSplitPaneLength | undefined>>;
+export interface HysSplitPanePanelResize {
+    separator: number;
+    before: string;
+    after: string;
+    /** 每个面板当前或预览的像素尺寸。 */
+    sizes: Record<string, number>;
+}
+export interface HysSplitPanePanelResizeEnd extends HysSplitPanePanelResize {
+    cancelled: boolean;
+}
+export interface HysSplitPaneHandleContext {
+    separator: number;
+    before: string;
+    after: string;
+    vertical: boolean;
+    disabled: boolean;
+    resizing: boolean;
+}
+export interface HysSplitPaneProps {
+    /** 第一块面板占可用空间的百分比，支持 v-model。 */
     modelValue?: number;
+    /** 非受控初始比例，数字为百分比。 */
+    defaultValue?: number;
+    /** 兼容比例下限，firstPanel.min 优先。 */
     min?: number;
+    /** 兼容比例上限，firstPanel.max 优先。 */
     max?: number;
     vertical?: boolean;
+    /** 布局方向，指定时优先于 vertical。 */
+    layout?: "horizontal" | "vertical";
     disabled?: boolean;
+    /** 键盘调整的百分比步长。 */
     step?: number;
+    /** 拖动时移动预览线，释放后才提交 v-model。 */
+    lazy?: boolean;
+    firstPanel?: HysSplitPanePanelOptions;
+    secondPanel?: HysSplitPanePanelOptions;
+    /** 按顺序渲染的面板配置，每项以唯一 id 标识。 */
+    panels?: readonly HysSplitPanePanel[];
+    /** 多面板受控尺寸，支持 v-model:sizes。 */
+    sizes?: HysSplitPaneSizes;
+    /** 以浏览器本地存储记住非受控布局。 */
+    storageKey?: string;
+    /** 分隔条实际占用的宽度或高度，单位为像素。 */
+    dividerSize?: number;
+    /** 双击分隔条时折叠相邻面板、重置尺寸或保持原状。 */
+    doubleClickAction?: "none" | "collapse" | "reset";
+    ariaLabel?: string;
+    firstLabel?: string;
+    secondLabel?: string;
+}
+export interface HysSplitPaneSlotContext {
+    collapsed: boolean;
+    toggle: () => Promise<boolean>;
+}
+export interface HysSplitPanePanelContext extends HysSplitPaneSlotContext {
+    panel: HysSplitPanePanel;
+    index: number;
+    size: number;
+}
+export interface HysSplitPaneResizeEnd {
+    cancelled: boolean;
+}
+export interface HysSplitPaneInstance {
+    togglePanel: (side: HysSplitPaneSide) => Promise<boolean>;
+    togglePane: (id: string, separator?: number) => Promise<boolean>;
+    resizePane: (id: string, value: HysSplitPaneLength, separator?: number) => Promise<boolean>;
+    getPanelSizes: () => Record<string, number>;
+    getPaneElement: (id: string) => HTMLElement | undefined;
+    resetSizes: () => Promise<boolean>;
+}
+type __VLS_Slots = {
+    first?: (context: HysSplitPaneSlotContext) => unknown;
+    second?: (context: HysSplitPaneSlotContext) => unknown;
+    "first-collapse"?: (context: HysSplitPaneSlotContext) => unknown;
+    "second-collapse"?: (context: HysSplitPaneSlotContext) => unknown;
+    panel?: (context: HysSplitPanePanelContext) => unknown;
+    "panel-collapse"?: (context: HysSplitPanePanelContext & {
+        side: "start" | "end";
+    }) => unknown;
+    /** 自定义抓手图标。分隔条保留键盘和指针行为。 */
+    handle?: (context: HysSplitPaneHandleContext) => unknown;
 };
-declare const __VLS_template: () => {
-    __VLS_Slots: {
-        first?: (props: {}) => any;
-    } & {
-        second?: (props: {}) => any;
+declare function togglePanel(side: HysSplitPaneSide): Promise<boolean>;
+declare function resetSizes(): Promise<boolean>;
+declare const __VLS_base: import("vue").DefineComponent<HysSplitPaneProps, {
+    togglePanel: typeof togglePanel;
+    togglePane: (id: string, separator?: number) => Promise<boolean>;
+    getPanelSizes: () => {
+        [k: string]: number;
     };
-};
-type __VLS_Slots = ReturnType<typeof __VLS_template>['__VLS_Slots'];
-declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    getPaneElement: (id: string) => HTMLElement | undefined;
+    resizePane: (id: string, value: HysSplitPaneLength, separator?: number) => Promise<boolean>;
+    resetSizes: typeof resetSizes;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (value: number) => any;
-    resizeEnd: (value: number) => any;
+    collapse: (side: HysSplitPaneSide, collapsed: boolean) => any;
+    resize: (value: number) => any;
+    resizeEnd: (value: number, details: HysSplitPaneResizeEnd) => any;
     resizeStart: () => any;
-}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    "update:sizes": (sizes: Readonly<Record<string, HysSplitPaneLength | undefined>>) => any;
+    panelResizeStart: (details: HysSplitPanePanelResize) => any;
+    panelResize: (details: HysSplitPanePanelResize) => any;
+    panelResizeEnd: (details: HysSplitPanePanelResizeEnd) => any;
+    panelCollapse: (id: string, collapsed: boolean) => any;
+}, string, import("vue").PublicProps, Readonly<HysSplitPaneProps> & Readonly<{
     "onUpdate:modelValue"?: ((value: number) => any) | undefined;
-    onResizeEnd?: ((value: number) => any) | undefined;
+    onCollapse?: ((side: HysSplitPaneSide, collapsed: boolean) => any) | undefined;
+    onResize?: ((value: number) => any) | undefined;
+    onResizeEnd?: ((value: number, details: HysSplitPaneResizeEnd) => any) | undefined;
     onResizeStart?: (() => any) | undefined;
+    "onUpdate:sizes"?: ((sizes: Readonly<Record<string, HysSplitPaneLength | undefined>>) => any) | undefined;
+    onPanelResizeStart?: ((details: HysSplitPanePanelResize) => any) | undefined;
+    onPanelResize?: ((details: HysSplitPanePanelResize) => any) | undefined;
+    onPanelResizeEnd?: ((details: HysSplitPanePanelResizeEnd) => any) | undefined;
+    onPanelCollapse?: ((id: string, collapsed: boolean) => any) | undefined;
 }>, {
-    modelValue: number;
     max: number;
     min: number;
-    vertical: boolean;
+    ariaLabel: string;
     step: number;
+    defaultValue: number;
+    firstLabel: string;
+    secondLabel: string;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
 declare const _default: typeof __VLS_export;

package/dist/types/components/HysSteps/HysSteps.vue.d.ts

@@ -63,8 +63,8 @@ declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {}, {}, {},
     size: "sm" | "md";
     status: HysStepStatus;
     current: number;
-    labelPlacement: "right" | "bottom";
     responsive: boolean;
+    labelPlacement: "right" | "bottom";
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
 declare const _default: typeof __VLS_export;