@aplus-frontend/ui 0.0.1-beta.16 → 0.0.1-beta.17

package/lib/src/modal/interface.d.ts

@@ -1,182 +1,182 @@
 import { ButtonProps } from 'ant-design-vue';
 import { CSSProperties, ComputedRef, VNode, VNodeChild } from 'vue';
-
-export interface ModalWrapperProps {
-    footerOffset?: number;
-    loading: boolean;
-    modalHeaderHeight: number;
-    modalFooterHeight: number;
-    minHeight: number;
-    height: number;
-    open: boolean;
-    fullScreen: boolean;
-    useWrapper: boolean;
-}
-export interface ModalProps {
-    minHeight?: number;
-    height?: number;
-    wrapperFooterOffset?: number;
-    draggable?: boolean;
-    scrollTop?: boolean;
-    canFullscreen?: boolean;
-    defaultFullscreen?: boolean;
-    open?: boolean;
-    helpMessage: string | string[];
-    useWrapper: boolean;
-    loading: boolean;
-    loadingTip?: string;
-    wrapperProps: Omit<ModalWrapperProps, 'loading'>;
-    showOkBtn: boolean;
-    showCancelBtn: boolean;
-    closeFunc: () => Promise<any>;
-    /**
-     * Specify a function that will be called when modal is closed completely.
-     * @type Function
-     */
-    afterClose?: () => any;
-    /**
-     * Body style for modal body element. Such as height, padding etc.
-     * @default {}
-     * @type object
-     */
-    bodyStyle?: CSSProperties;
-    /**
-     * Text of the Cancel button
-     * @default 'cancel'
-     * @type string
-     */
-    cancelText?: string;
-    /**
-     * Centered Modal
-     * @default false
-     * @type boolean
-     */
-    centered?: boolean;
-    /**
-     * Whether a close (x) button is visible on top right of the modal dialog or not
-     * @default true
-     * @type boolean
-     */
-    closable?: boolean;
-    /**
-     * Whether a close (x) button is visible on top right of the modal dialog or not
-     */
-    closeIcon?: VNode | VNodeChild;
-    /**
-     * Whether to apply loading visual effect for OK button or not
-     * @default false
-     * @type boolean
-     */
-    confirmLoading?: boolean;
-    /**
-     * Whether to unmount child components on onClose
-     * @default false
-     * @type boolean
-     */
-    destroyOnClose?: boolean;
-    /**
-     * Footer content, set as :footer="null" when you don't need default buttons
-     * @default OK and Cancel buttons
-     * @type any (string | slot)
-     */
-    footer?: VNodeChild | VNode;
-    /**
-     * Return the mount node for Modal
-     * @default () => document.body
-     * @type Function
-     */
-    getContainer?: (instance: any) => HTMLElement;
-    /**
-     * Whether show mask or not.
-     * @default true
-     * @type boolean
-     */
-    mask?: boolean;
-    /**
-     * Whether to close the modal dialog when the mask (area outside the modal) is clicked
-     * @default true
-     * @type boolean
-     */
-    maskClosable?: boolean;
-    /**
-     * Style for modal's mask element.
-     * @default {}
-     * @type object
-     */
-    maskStyle?: CSSProperties;
-    /**
-     * Text of the OK button
-     * @default 'OK'
-     * @type string
-     */
-    okText?: string;
-    /**
-     * Button type of the OK button
-     * @default 'primary'
-     * @type string
-     */
-    okType?: 'primary' | 'danger' | 'dashed' | 'ghost' | 'default';
-    /**
-     * The ok button props, follow jsx rules
-     * @type object
-     */
-    okButtonProps?: ButtonProps;
-    /**
-     * The cancel button props, follow jsx rules
-     * @type object
-     */
-    cancelButtonProps?: ButtonProps;
-    /**
-     * The modal dialog's title
-     * @type any (string | slot)
-     */
-    title?: VNodeChild | VNode;
-    /**
-     * Width of the modal dialog
-     * @default 520
-     * @type string | number
-     */
-    width?: string | number;
-    /**
-     * The class name of the container of the modal dialog
-     * @type string
-     */
-    wrapClassName?: string;
-    /**
-     * The z-index of the Modal
-     * @default 1000
-     * @type number
-     */
-    zIndex?: number;
-}
-export type ModalCloseProps = {
-    canFullscreen?: boolean;
-    fullScreen?: boolean;
-};
-export type ModalHeaderProps = {
-    helpMessage?: string | string[];
-    title?: string;
-};
-/**
- * @description: 弹窗对外暴露的方法
- */
-export interface ModalMethods {
-    setModalProps: (props: Partial<ModalProps>) => void;
-    emitOpen?: (open: boolean, uid: number) => void;
-    redoModalHeight?: () => void;
-}
-export type RegisterFn = (modalMethods: ModalMethods, uuid: number) => void;
-export interface ReturnMethods extends ModalMethods {
-    openModal: <T = any>(props?: boolean, data?: T, openOnSet?: boolean) => void;
-    closeModal: () => void;
-    getOpen?: ComputedRef<boolean>;
-}
-export type UseModalReturnType = [RegisterFn, ReturnMethods];
-export interface ReturnInnerMethods extends ModalMethods {
-    closeModal: () => void;
-    changeLoading: (loading: boolean) => void;
-    changeOkLoading: (loading: boolean) => void;
-    getOpen?: ComputedRef<boolean>;
-    redoModalHeight: () => void;
-}
-export type UseModalInnerReturnType = [RegisterFn, ReturnInnerMethods];
+
+export interface ModalWrapperProps {
+    footerOffset?: number;
+    loading: boolean;
+    modalHeaderHeight: number;
+    modalFooterHeight: number;
+    minHeight: number;
+    height: number;
+    open: boolean;
+    fullScreen: boolean;
+    useWrapper: boolean;
+}
+export interface ModalProps {
+    minHeight?: number;
+    height?: number;
+    wrapperFooterOffset?: number;
+    draggable?: boolean;
+    scrollTop?: boolean;
+    canFullscreen?: boolean;
+    defaultFullscreen?: boolean;
+    open?: boolean;
+    helpMessage: string | string[];
+    useWrapper: boolean;
+    loading: boolean;
+    loadingTip?: string;
+    wrapperProps: Omit<ModalWrapperProps, 'loading'>;
+    showOkBtn: boolean;
+    showCancelBtn: boolean;
+    closeFunc: () => Promise<any>;
+    /**
+     * Specify a function that will be called when modal is closed completely.
+     * @type Function
+     */
+    afterClose?: () => any;
+    /**
+     * Body style for modal body element. Such as height, padding etc.
+     * @default {}
+     * @type object
+     */
+    bodyStyle?: CSSProperties;
+    /**
+     * Text of the Cancel button
+     * @default 'cancel'
+     * @type string
+     */
+    cancelText?: string;
+    /**
+     * Centered Modal
+     * @default false
+     * @type boolean
+     */
+    centered?: boolean;
+    /**
+     * Whether a close (x) button is visible on top right of the modal dialog or not
+     * @default true
+     * @type boolean
+     */
+    closable?: boolean;
+    /**
+     * Whether a close (x) button is visible on top right of the modal dialog or not
+     */
+    closeIcon?: VNode | VNodeChild;
+    /**
+     * Whether to apply loading visual effect for OK button or not
+     * @default false
+     * @type boolean
+     */
+    confirmLoading?: boolean;
+    /**
+     * Whether to unmount child components on onClose
+     * @default false
+     * @type boolean
+     */
+    destroyOnClose?: boolean;
+    /**
+     * Footer content, set as :footer="null" when you don't need default buttons
+     * @default OK and Cancel buttons
+     * @type any (string | slot)
+     */
+    footer?: VNodeChild | VNode;
+    /**
+     * Return the mount node for Modal
+     * @default () => document.body
+     * @type Function
+     */
+    getContainer?: (instance: any) => HTMLElement;
+    /**
+     * Whether show mask or not.
+     * @default true
+     * @type boolean
+     */
+    mask?: boolean;
+    /**
+     * Whether to close the modal dialog when the mask (area outside the modal) is clicked
+     * @default true
+     * @type boolean
+     */
+    maskClosable?: boolean;
+    /**
+     * Style for modal's mask element.
+     * @default {}
+     * @type object
+     */
+    maskStyle?: CSSProperties;
+    /**
+     * Text of the OK button
+     * @default 'OK'
+     * @type string
+     */
+    okText?: string;
+    /**
+     * Button type of the OK button
+     * @default 'primary'
+     * @type string
+     */
+    okType?: 'primary' | 'danger' | 'dashed' | 'ghost' | 'default';
+    /**
+     * The ok button props, follow jsx rules
+     * @type object
+     */
+    okButtonProps?: ButtonProps;
+    /**
+     * The cancel button props, follow jsx rules
+     * @type object
+     */
+    cancelButtonProps?: ButtonProps;
+    /**
+     * The modal dialog's title
+     * @type any (string | slot)
+     */
+    title?: VNodeChild | VNode;
+    /**
+     * Width of the modal dialog
+     * @default 520
+     * @type string | number
+     */
+    width?: string | number;
+    /**
+     * The class name of the container of the modal dialog
+     * @type string
+     */
+    wrapClassName?: string;
+    /**
+     * The z-index of the Modal
+     * @default 1000
+     * @type number
+     */
+    zIndex?: number;
+}
+export type ModalCloseProps = {
+    canFullscreen?: boolean;
+    fullScreen?: boolean;
+};
+export type ModalHeaderProps = {
+    helpMessage?: string | string[];
+    title?: string;
+};
+/**
+ * @description: 弹窗对外暴露的方法
+ */
+export interface ModalMethods {
+    setModalProps: (props: Partial<ModalProps>) => void;
+    emitOpen?: (open: boolean, uid: number) => void;
+    redoModalHeight?: () => void;
+}
+export type RegisterFn = (modalMethods: ModalMethods, uuid: number) => void;
+export interface ReturnMethods extends ModalMethods {
+    openModal: <T = any>(props?: boolean, data?: T, openOnSet?: boolean) => void;
+    closeModal: () => void;
+    getOpen?: ComputedRef<boolean>;
+}
+export type UseModalReturnType = [RegisterFn, ReturnMethods];
+export interface ReturnInnerMethods extends ModalMethods {
+    closeModal: () => void;
+    changeLoading: (loading: boolean) => void;
+    changeOkLoading: (loading: boolean) => void;
+    getOpen?: ComputedRef<boolean>;
+    redoModalHeight: () => void;
+}
+export type UseModalInnerReturnType = [RegisterFn, ReturnInnerMethods];