x-next 0.0.0-alpha.9 → 1.0.0

package/dist/components/form-switch/Switch.vue.d.ts

@@ -0,0 +1,354 @@
+import { PropType } from 'vue';
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    /**
+     * @zh 绑定值
+     * @en Value
+     */
+    modelValue: {
+        type: (StringConstructor | BooleanConstructor | NumberConstructor)[];
+        default: undefined;
+    };
+    /**
+     * @zh 默认选中状态（非受控状态）
+     * @en Default selected state (uncontrolled state)
+     */
+    defaultChecked: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 是否禁用
+     * @en Whether to disable
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 是否为加载中状态
+     * @en Whether it is loading state
+     */
+    loading: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 是否自动获取焦点
+     * @en Whether to automatically focus
+     */
+    autofocus: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 开关的类型
+     * @en Type of switch
+     * @values 'circle', 'round', 'line'
+     */
+    type: {
+        type: PropType<"circle" | "round" | "line">;
+        default: string;
+    };
+    /**
+     * @zh 开关的大小
+     * @en Size of switch
+     * @defaultValue 'medium'
+     */
+    size: {
+        type: PropType<"mini" | "small" | "medium" | "large">;
+    };
+    /**
+     * @zh 选中时的值
+     * @en Value when checked
+     * @version 2.12.0
+     */
+    checkedValue: {
+        type: (StringConstructor | BooleanConstructor | NumberConstructor)[];
+        default: boolean;
+    };
+    /**
+     * @zh 未选中时的值
+     * @en Value when unchecked
+     * @version 2.12.0
+     */
+    uncheckedValue: {
+        type: (StringConstructor | BooleanConstructor | NumberConstructor)[];
+        default: boolean;
+    };
+    /**
+     * @zh 选中时的开关颜色
+     * @en The color of the switch when checked
+     * @version 2.12.0
+     */
+    checkedColor: {
+        type: StringConstructor;
+    };
+    /**
+     * @zh 未选中时的开关颜色
+     * @en The color of the switch when unchecked
+     * @version 2.12.0
+     */
+    uncheckedColor: {
+        type: StringConstructor;
+    };
+    /**
+     * @zh switch 状态改变前的钩子， 返回 false 或者返回 Promise 且被 reject 则停止切换。
+     * @en before-change hook before the switch state changes. If false is returned or a Promise is returned and then is rejected, will stop switching
+     * @version 2.37.0
+     */
+    beforeChange: {
+        type: PropType<(newValue: string | number | boolean) => Promise<boolean | void> | boolean | void>;
+    };
+    /**
+     * @zh 打开状态时的文案（`type='line'`时不生效）
+     * @en Copywriting when opened (not effective when `type='line'`)
+     * @version 2.45.0
+     */
+    checkedText: {
+        type: StringConstructor;
+    };
+    /**
+     * @zh 关闭状态时的文案（`type='line'`时不生效）
+     * @en Copywriting when closed (not effective when `type='line'`)
+     * @version 2.45.0
+     */
+    uncheckedText: {
+        type: StringConstructor;
+    };
+}>, {
+    className: {
+        block: string;
+        element: (className: string) => string;
+        modifier: (className: string) => string;
+        is: (className: string) => string;
+    };
+    cls: import('vue').ComputedRef<(string | {
+        [x: string]: string | boolean | undefined;
+    })[]>;
+    switchRef: import('vue').Ref<HTMLButtonElement | undefined, HTMLButtonElement | undefined>;
+    mergedDisabled: import('vue').ComputedRef<boolean>;
+    buttonStyle: import('vue').ComputedRef<{
+        '--custom-color': string;
+        backgroundColor?: undefined;
+    } | {
+        backgroundColor: string;
+        '--custom-color'?: undefined;
+    } | undefined>;
+    computedCheck: import('vue').ComputedRef<boolean>;
+    computedLoading: import('vue').ComputedRef<boolean>;
+    showText: import('vue').ComputedRef<boolean>;
+    handleClick: (ev: MouseEvent) => Promise<void>;
+    handleKeydown: (ev: KeyboardEvent) => Promise<void>;
+    handleFocus: (ev: FocusEvent) => void;
+    handleBlur: (ev: FocusEvent) => void;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    'update:modelValue': (value: boolean | string | number) => true;
+    /**
+     * @zh 值改变时触发
+     * @en Trigger when the value changes
+     * @param { boolean | string | number } value
+     * @param {Event} ev
+     */
+    change: (value: boolean | string | number, ev: Event) => true;
+    /**
+     * @zh 组件获得焦点时触发
+     * @en Triggered when the component gets focus
+     * @property {FocusEvent} ev
+     */
+    focus: (ev: FocusEvent) => true;
+    /**
+     * @zh 组件失去焦点时触发
+     * @en Fired when the component loses focus
+     * @property {FocusEvent} ev
+     */
+    blur: (ev: FocusEvent) => true;
+    /**
+     * @zh 点击时触发
+     * @en Triggered when clicked
+     * @param { boolean | string | number } value
+     * @param {MouseEvent} ev
+     */
+    click: (value: boolean | string | number, ev: MouseEvent) => true;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * @zh 绑定值
+     * @en Value
+     */
+    modelValue: {
+        type: (StringConstructor | BooleanConstructor | NumberConstructor)[];
+        default: undefined;
+    };
+    /**
+     * @zh 默认选中状态（非受控状态）
+     * @en Default selected state (uncontrolled state)
+     */
+    defaultChecked: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 是否禁用
+     * @en Whether to disable
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 是否为加载中状态
+     * @en Whether it is loading state
+     */
+    loading: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 是否自动获取焦点
+     * @en Whether to automatically focus
+     */
+    autofocus: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * @zh 开关的类型
+     * @en Type of switch
+     * @values 'circle', 'round', 'line'
+     */
+    type: {
+        type: PropType<"circle" | "round" | "line">;
+        default: string;
+    };
+    /**
+     * @zh 开关的大小
+     * @en Size of switch
+     * @defaultValue 'medium'
+     */
+    size: {
+        type: PropType<"mini" | "small" | "medium" | "large">;
+    };
+    /**
+     * @zh 选中时的值
+     * @en Value when checked
+     * @version 2.12.0
+     */
+    checkedValue: {
+        type: (StringConstructor | BooleanConstructor | NumberConstructor)[];
+        default: boolean;
+    };
+    /**
+     * @zh 未选中时的值
+     * @en Value when unchecked
+     * @version 2.12.0
+     */
+    uncheckedValue: {
+        type: (StringConstructor | BooleanConstructor | NumberConstructor)[];
+        default: boolean;
+    };
+    /**
+     * @zh 选中时的开关颜色
+     * @en The color of the switch when checked
+     * @version 2.12.0
+     */
+    checkedColor: {
+        type: StringConstructor;
+    };
+    /**
+     * @zh 未选中时的开关颜色
+     * @en The color of the switch when unchecked
+     * @version 2.12.0
+     */
+    uncheckedColor: {
+        type: StringConstructor;
+    };
+    /**
+     * @zh switch 状态改变前的钩子， 返回 false 或者返回 Promise 且被 reject 则停止切换。
+     * @en before-change hook before the switch state changes. If false is returned or a Promise is returned and then is rejected, will stop switching
+     * @version 2.37.0
+     */
+    beforeChange: {
+        type: PropType<(newValue: string | number | boolean) => Promise<boolean | void> | boolean | void>;
+    };
+    /**
+     * @zh 打开状态时的文案（`type='line'`时不生效）
+     * @en Copywriting when opened (not effective when `type='line'`)
+     * @version 2.45.0
+     */
+    checkedText: {
+        type: StringConstructor;
+    };
+    /**
+     * @zh 关闭状态时的文案（`type='line'`时不生效）
+     * @en Copywriting when closed (not effective when `type='line'`)
+     * @version 2.45.0
+     */
+    uncheckedText: {
+        type: StringConstructor;
+    };
+}>> & Readonly<{
+    onClick?: ((value: string | number | boolean, ev: MouseEvent) => any) | undefined;
+    onFocus?: ((ev: FocusEvent) => any) | undefined;
+    onBlur?: ((ev: FocusEvent) => any) | undefined;
+    onChange?: ((value: string | number | boolean, ev: Event) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: string | number | boolean) => any) | undefined;
+}>, {
+    autofocus: boolean;
+    type: "round" | "circle" | "line";
+    disabled: boolean;
+    loading: boolean;
+    modelValue: string | number | boolean;
+    defaultChecked: boolean;
+    checkedValue: string | number | boolean;
+    uncheckedValue: string | number | boolean;
+}, {}, {
+    IconLoading: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        size: {
+            type: (StringConstructor | NumberConstructor)[];
+            default: undefined;
+        };
+        rotate: {
+            type: NumberConstructor;
+            default: undefined;
+        };
+        spin: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        color: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        fillColor: {
+            type: ArrayConstructor;
+            default: undefined;
+        };
+    }>, () => VNode, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        size: {
+            type: (StringConstructor | NumberConstructor)[];
+            default: undefined;
+        };
+        rotate: {
+            type: NumberConstructor;
+            default: undefined;
+        };
+        spin: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        color: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        fillColor: {
+            type: ArrayConstructor;
+            default: undefined;
+        };
+    }>> & Readonly<{}>, {
+        size: string | number;
+        rotate: number;
+        spin: boolean;
+        color: string;
+        fillColor: unknown[];
+    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;