@hoci/core 0.2.1

package/dist/index.d.cts

@@ -0,0 +1,592 @@
+import * as _hoci_shared from '@hoci/shared';
+import { ElementLike, ActivateEvent } from '@hoci/shared';
+export * from '@hoci/shared';
+import * as vue from 'vue';
+import { PropType, InjectionKey, MaybeRefOrGetter, Ref, CSSProperties as CSSProperties$1 } from 'vue';
+import { CSSProperties } from 'tslx';
+
+declare const affixProps: {
+    fixedClass: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * @zh 距离窗口顶部达到指定偏移量后触发
+     * @en Triggered when the specified offset is reached from the top of the window
+     */
+    offset: {
+        type: NumberConstructor;
+        default: number;
+    };
+    offsetType: {
+        type: PropType<"top" | "bottom">;
+        default: string;
+    };
+    /**
+     * @zh 滚动容器，默认是 `window`
+     * @en Scroll container, default is `window`
+     */
+    target: {
+        type: PropType<string | Window | HTMLElement>;
+    };
+    /**
+   * @zh z-index 值
+   * @en Z index value
+   */
+    zIndex: {
+        type: NumberConstructor;
+        default: number;
+    };
+};
+type AffixProps = typeof affixProps;
+declare const affixEmits: ("scroll" | "change")[];
+declare const AFFIX_TARGET_KEY: InjectionKey<MaybeRefOrGetter<HTMLElement | Window | Element | null | undefined>>;
+declare const useAffix: _hoci_shared.HookComponent<{
+    classNames: vue.ComputedRef<string>;
+    wrapperRef: Ref<HTMLElement | null>;
+    isFixed: Ref<boolean>;
+    placeholderStyle: Ref<CSSProperties>;
+    fixedStyle: Ref<CSSProperties>;
+    updatePosition: _hoci_shared.ThrottledCancelableFn<[]>;
+}, vue.EmitsOptions, {
+    fixedClass: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * @zh 距离窗口顶部达到指定偏移量后触发
+     * @en Triggered when the specified offset is reached from the top of the window
+     */
+    offset: {
+        type: NumberConstructor;
+        default: number;
+    };
+    offsetType: {
+        type: PropType<"top" | "bottom">;
+        default: string;
+    };
+    /**
+     * @zh 滚动容器，默认是 `window`
+     * @en Scroll container, default is `window`
+     */
+    target: {
+        type: PropType<string | Window | HTMLElement>;
+    };
+    /**
+   * @zh z-index 值
+   * @en Z index value
+   */
+    zIndex: {
+        type: NumberConstructor;
+        default: number;
+    };
+}, vue.ExtractPropTypes<{
+    fixedClass: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * @zh 距离窗口顶部达到指定偏移量后触发
+     * @en Triggered when the specified offset is reached from the top of the window
+     */
+    offset: {
+        type: NumberConstructor;
+        default: number;
+    };
+    offsetType: {
+        type: PropType<"top" | "bottom">;
+        default: string;
+    };
+    /**
+     * @zh 滚动容器，默认是 `window`
+     * @en Scroll container, default is `window`
+     */
+    target: {
+        type: PropType<string | Window | HTMLElement>;
+    };
+    /**
+   * @zh z-index 值
+   * @en Z index value
+   */
+    zIndex: {
+        type: NumberConstructor;
+        default: number;
+    };
+}>, {
+    fixedClass: string;
+    offset: number;
+    offsetType: "top" | "bottom";
+    zIndex: number;
+}>;
+declare function provideAffixTarget(target: MaybeRefOrGetter<HTMLElement | Element | null | undefined>): void;
+
+type InitFunction = (option: Option) => () => void;
+interface Option {
+    id?: string;
+    label?: string;
+    value: any | null;
+    render(): ElementLike;
+}
+interface HiSelectionContext {
+    changeActive: (_: any) => void;
+    isActive: (_: any) => boolean;
+    init?: InitFunction;
+    activateEvent: ActivateEvent;
+    activeClass: string;
+    itemClass: string;
+    unactiveClass: string;
+    disabledClass: string;
+    label: string | ((_: any) => ElementLike | null | undefined) | null | undefined;
+    multiple: boolean | number;
+}
+declare const selectionProps: {
+    modelValue: {
+        type: PropType<any>;
+        default: () => null;
+    };
+    /**
+     * 选中时的 class
+     */
+    activeClass: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        default: string;
+    };
+    /**
+     *  每个选项的 class
+     */
+    itemClass: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        default: string;
+    };
+    disabledClass: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        default: string;
+    };
+    unactiveClass: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        default: string;
+    };
+    label: {
+        type: PropType<string | ((val?: any) => string) | null>;
+    };
+    /**
+     *  多选模式
+     */
+    multiple: {
+        type: (NumberConstructor | BooleanConstructor)[];
+        default: () => false;
+    };
+    /**
+     * 可清除
+     */
+    clearable: {
+        type: BooleanConstructor;
+    };
+    defaultValue: {
+        type: PropType<any>;
+        default: () => null;
+    };
+    activateEvent: {
+        type: PropType<ActivateEvent>;
+        default: () => "click";
+    };
+};
+type SelectionProps = typeof selectionProps;
+declare const selectionEmits: ("change" | "load" | "unload" | "update:modelValue")[];
+declare function useSelectionContext(): HiSelectionContext;
+declare const useSelectionList: _hoci_shared.HookComponent<{
+    options: {
+        id?: string | undefined;
+        label?: string | undefined;
+        value: any | null;
+        render: () => ElementLike;
+    }[];
+    actives: any[];
+    isActive: (value: any) => boolean;
+    changeActive: (value: any) => void;
+    renderItem: () => ElementLike;
+}, ("change" | "load" | "unload" | "update:modelValue")[], {
+    modelValue: {
+        type: PropType<any>;
+        default: () => null;
+    };
+    /**
+     * 选中时的 class
+     */
+    activeClass: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        default: string;
+    };
+    /**
+     *  每个选项的 class
+     */
+    itemClass: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        default: string;
+    };
+    disabledClass: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        default: string;
+    };
+    unactiveClass: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        default: string;
+    };
+    label: {
+        type: PropType<string | ((val?: any) => string) | null>;
+    };
+    /**
+     *  多选模式
+     */
+    multiple: {
+        type: (NumberConstructor | BooleanConstructor)[];
+        default: () => false;
+    };
+    /**
+     * 可清除
+     */
+    clearable: {
+        type: BooleanConstructor;
+    };
+    defaultValue: {
+        type: PropType<any>;
+        default: () => null;
+    };
+    activateEvent: {
+        type: PropType<ActivateEvent>;
+        default: () => "click";
+    };
+}, vue.ExtractPropTypes<{
+    modelValue: {
+        type: PropType<any>;
+        default: () => null;
+    };
+    /**
+     * 选中时的 class
+     */
+    activeClass: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        default: string;
+    };
+    /**
+     *  每个选项的 class
+     */
+    itemClass: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        default: string;
+    };
+    disabledClass: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        default: string;
+    };
+    unactiveClass: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        default: string;
+    };
+    label: {
+        type: PropType<string | ((val?: any) => string) | null>;
+    };
+    /**
+     *  多选模式
+     */
+    multiple: {
+        type: (NumberConstructor | BooleanConstructor)[];
+        default: () => false;
+    };
+    /**
+     * 可清除
+     */
+    clearable: {
+        type: BooleanConstructor;
+    };
+    defaultValue: {
+        type: PropType<any>;
+        default: () => null;
+    };
+    activateEvent: {
+        type: PropType<ActivateEvent>;
+        default: () => "click";
+    };
+}>, {
+    multiple: number | boolean;
+    modelValue: any;
+    activeClass: string | string[] | Record<string, boolean>;
+    itemClass: string | string[] | Record<string, boolean>;
+    disabledClass: string | string[] | Record<string, boolean>;
+    unactiveClass: string | string[] | Record<string, boolean>;
+    clearable: boolean;
+    defaultValue: any;
+    activateEvent: ActivateEvent;
+}>;
+interface HiSelectionSlotData extends Record<string, unknown> {
+    isActive: (value: any) => boolean;
+    changeActive: (value: any) => void;
+    renderItem: () => ElementLike;
+}
+
+declare const itemProps: {
+    value: {
+        type: PropType<any>;
+        default(): string;
+    };
+    label: {
+        type: PropType<ElementLike | ((val: any) => string) | null>;
+    };
+    keepAlive: {
+        type: BooleanConstructor;
+        default: () => true;
+    };
+    key: {
+        type: PropType<string | number | symbol>;
+    };
+    activateEvent: {
+        type: PropType<ActivateEvent>;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+};
+declare const useSelectionItem: _hoci_shared.HookComponent<{
+    activate: () => void;
+    render: () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+        [key: string]: any;
+    }>;
+    isActive: vue.ComputedRef<boolean>;
+    isDisabled: vue.ComputedRef<boolean>;
+    className: vue.ComputedRef<string>;
+    activateEvent: vue.ComputedRef<ActivateEvent>;
+}, vue.EmitsOptions, {
+    value: {
+        type: PropType<any>;
+        default(): string;
+    };
+    label: {
+        type: PropType<ElementLike | ((val: any) => string) | null>;
+    };
+    keepAlive: {
+        type: BooleanConstructor;
+        default: () => true;
+    };
+    key: {
+        type: PropType<string | number | symbol>;
+    };
+    activateEvent: {
+        type: PropType<ActivateEvent>;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, vue.ExtractPropTypes<{
+    value: {
+        type: PropType<any>;
+        default(): string;
+    };
+    label: {
+        type: PropType<ElementLike | ((val: any) => string) | null>;
+    };
+    keepAlive: {
+        type: BooleanConstructor;
+        default: () => true;
+    };
+    key: {
+        type: PropType<string | number | symbol>;
+    };
+    activateEvent: {
+        type: PropType<ActivateEvent>;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, {
+    value: any;
+    disabled: boolean;
+    keepAlive: boolean;
+}>;
+interface HiItemSlotsData {
+    active: boolean;
+    activate(): void;
+}
+
+declare const switchProps: {
+    modelValue: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    class: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        required: true;
+    };
+    activeClass: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        default: string;
+    };
+    unactiveClass: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        default: string;
+    };
+    activateEvent: {
+        type: PropType<ActivateEvent>;
+        default: string;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    disabledClass: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        default: string;
+    };
+};
+type HiSwitchProps = typeof switchProps;
+declare const switchEmits: ("change" | "update:modelValue")[];
+declare const useSwitch: _hoci_shared.HookComponent<{
+    toggle: (value?: any) => void;
+    modelValue: vue.Ref<boolean>;
+    className: vue.ComputedRef<string>;
+    isDisabled: vue.ComputedRef<boolean>;
+}, ("change" | "update:modelValue")[], {
+    modelValue: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    class: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        required: true;
+    };
+    activeClass: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        default: string;
+    };
+    unactiveClass: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        default: string;
+    };
+    activateEvent: {
+        type: PropType<ActivateEvent>;
+        default: string;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    disabledClass: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        default: string;
+    };
+}, vue.ExtractPropTypes<{
+    modelValue: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    class: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        required: true;
+    };
+    activeClass: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        default: string;
+    };
+    unactiveClass: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        default: string;
+    };
+    activateEvent: {
+        type: PropType<ActivateEvent>;
+        default: string;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    disabledClass: {
+        type: PropType<string | string[] | Record<string, boolean>>;
+        default: string;
+    };
+}>, {
+    disabled: boolean;
+    modelValue: boolean;
+    activeClass: string | string[] | Record<string, boolean>;
+    disabledClass: string | string[] | Record<string, boolean>;
+    unactiveClass: string | string[] | Record<string, boolean>;
+    activateEvent: ActivateEvent;
+}>;
+
+declare const iconProps: {
+    src: {
+        type: StringConstructor;
+        required: true;
+    };
+    size: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+    };
+    width: {
+        type: (StringConstructor | NumberConstructor)[];
+    };
+    height: {
+        type: (StringConstructor | NumberConstructor)[];
+    };
+    color: {
+        type: StringConstructor;
+    };
+    mask: {
+        type: PropType<boolean | "auto">;
+        default: () => "auto";
+    };
+};
+type HiIconProps = typeof iconProps;
+declare const useIcon: _hoci_shared.HookComponent<{
+    style: vue.ComputedRef<CSSProperties$1>;
+}, vue.EmitsOptions, {
+    src: {
+        type: StringConstructor;
+        required: true;
+    };
+    size: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+    };
+    width: {
+        type: (StringConstructor | NumberConstructor)[];
+    };
+    height: {
+        type: (StringConstructor | NumberConstructor)[];
+    };
+    color: {
+        type: StringConstructor;
+    };
+    mask: {
+        type: PropType<boolean | "auto">;
+        default: () => "auto";
+    };
+}, vue.ExtractPropTypes<{
+    src: {
+        type: StringConstructor;
+        required: true;
+    };
+    size: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+    };
+    width: {
+        type: (StringConstructor | NumberConstructor)[];
+    };
+    height: {
+        type: (StringConstructor | NumberConstructor)[];
+    };
+    color: {
+        type: StringConstructor;
+    };
+    mask: {
+        type: PropType<boolean | "auto">;
+        default: () => "auto";
+    };
+}>, {
+    mask: boolean | "auto";
+    size: string | number;
+}>;
+
+export { AFFIX_TARGET_KEY, type AffixProps, type HiIconProps, type HiItemSlotsData, type HiSelectionContext, type HiSelectionSlotData, type HiSwitchProps, type InitFunction, type Option, type SelectionProps, affixEmits, affixProps, iconProps, itemProps, provideAffixTarget, selectionEmits, selectionProps, switchEmits, switchProps, useAffix, useIcon, useSelectionContext, useSelectionItem, useSelectionList, useSwitch };