bkui-vue 0.0.1-beta.47 → 0.0.1-beta.470

package/lib/message/messageConstructor.d.ts

@@ -1,21 +1,108 @@
+import { VNode } from 'vue';
+declare enum MessageContentType {
+    KEY_VALUE = "key-value",
+    JSON = "json"
+}
+declare enum IMessageActionType {
+    /**
+     * 联系助手：默认直接拉起企业微信与助手的聊天，需要在 message.assistant 配置对应的企微群ID
+     */
+    ASSISTANT = "assistant",
+    /**
+     * 展开详情：展开面向开发的详情
+     */
+    DETAILS = "details",
+    /**
+     * 图钉按钮：点击后，Message 不会自动消失
+     */
+    FIX = "fix",
+    /**
+     * 关闭：点击关闭，Message 消失
+     */
+    CLOSE = "close"
+}
+type IMessageAction = {
+    /**
+     * 唯一ID，从给定的 IMessageActionType 中选择
+     * 如果是自定义的其他操作，此ID可以自定义，此时将会作为一个新的操作项追加
+     */
+    id: IMessageActionType;
+    /**
+     * 需要展示的文本，如果不设置显示默认
+     */
+    text?: () => string | string;
+    /**
+     * 需要展示的ICON，如果不设置显示默认
+     */
+    icon?: () => VNode | string | VNode;
+    /**
+     * 鼠标点击事件，如果返回false则阻止默认点击行为
+     * 如果返回其他，默认行为不会阻止
+     * @returns
+     */
+    onClick?: (...args: any[]) => Boolean | void;
+    /**
+     * 自定义渲染 & 事件处理
+     * 如果设置了render则整个渲染都需要自己处理，默认渲染将会被阻止
+     * @returns VNode
+     */
+    render?: () => VNode;
+    /**
+     * 是否禁用此功能
+     * 如果设置为true，则此功能不展示
+     */
+    disabled?: boolean;
+    /**
+     * 是否只读
+     * 如果设置为true，则此功能只做文本展示
+     */
+    readonly?: boolean;
+    /**
+     * 需要添加到操作项外层元素的样式列表
+     */
+    classList?: string | string[];
+};
+type IMessageActions = IMessageAction[];
+export type IMessage = {
+    /**
+     * 错误码
+     */
+    code: string | number;
+    /**
+     * 错误概述
+     */
+    overview: string;
+    /**
+     * 操作建议
+     */
+    suggestion: string;
+    /**
+     * 详情
+     */
+    details: string | Record<string, any> | Array<Record<string, any> | string | number | boolean>;
+    /**
+     * 助手
+     */
+    assistant: string;
+    /**
+     * 展开详情：数据展示格式
+     * 详情分为：Key Value 类详情、JSON 类详情
+     * 可选值：'key-value', 'json'
+     */
+    type: MessageContentType;
+};
 declare const _default: import("vue").DefineComponent<{
     id: import("vue-types").VueTypeValidableDef<string> & {
         default: string;
     } & {
         default: string;
     };
-    message: import("vue-types").VueTypeValidableDef<string> & {
-        default: string;
-    } & {
-        default: string;
-    };
-    theme: import("vue-types").VueTypeDef<string> & {
-        default: string;
+    message: import("vue-types").VueTypeDef<string | IMessage>;
+    theme: import("vue-types").VueTypeDef<"error" | "success" | "warning" | "primary"> & {
+        default: "error" | "success" | "warning" | "primary";
     };
     delay: import("vue-types").VueTypeValidableDef<number> & {
         default: number;
-    } & {
-        default: number;
     };
     dismissable: import("vue-types").VueTypeValidableDef<boolean> & {
         default: boolean;
@@ -40,32 +127,52 @@ declare const _default: import("vue").DefineComponent<{
     onClose: import("vue-types").VueTypeValidableDef<(...args: any[]) => any> & {
         default: (...args: any[]) => any;
     };
+    getContainer: import("vue-types").VueTypeDef<HTMLElement>;
+    width: import("vue-types").VueTypeDef<string | number>;
+    actions: import("vue-types").VueTypeShape<IMessageActions>;
 }, {
     classNames: import("vue").ComputedRef<string[]>;
     styles: import("vue").ComputedRef<{
         top: string;
         zIndex: number;
+        position: "fixed" | "absolute";
+        width: string | number;
     }>;
     visible: import("vue").Ref<boolean>;
-    close: () => void;
-}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "destory"[], "destory", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    close: (e: Event) => void;
+    setDetailsShow: (e: MouseEvent, isShow?: boolean) => void;
+    fixMesage: (_e: MouseEvent, isFix?: boolean) => void;
+    copyMessage: (_e: MouseEvent) => void;
+    parseJson: (value: any) => any;
+    handleMouseenter: (_e: MouseEvent) => void;
+    handleMouseleave: (_e: MouseEvent) => void;
+    renderMessageActions: () => unknown[];
+    refJsonContent: any;
+    refCopyStatus: any;
+    refCopyMsgDiv: any;
+    toolOperation: {
+        isFix: boolean;
+        isDetailShow: boolean;
+    };
+    copyStatus: any;
+    t: import("vue").ComputedRef<{
+        assistant: string;
+        details: string;
+        copySuccess: string;
+        copyFailed: string;
+    }>;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "destroy"[], "destroy", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     id: import("vue-types").VueTypeValidableDef<string> & {
         default: string;
     } & {
         default: string;
     };
-    message: import("vue-types").VueTypeValidableDef<string> & {
-        default: string;
-    } & {
-        default: string;
-    };
-    theme: import("vue-types").VueTypeDef<string> & {
-        default: string;
+    message: import("vue-types").VueTypeDef<string | IMessage>;
+    theme: import("vue-types").VueTypeDef<"error" | "success" | "warning" | "primary"> & {
+        default: "error" | "success" | "warning" | "primary";
     };
     delay: import("vue-types").VueTypeValidableDef<number> & {
         default: number;
-    } & {
-        default: number;
     };
     dismissable: import("vue-types").VueTypeValidableDef<boolean> & {
         default: boolean;
@@ -90,17 +197,19 @@ declare const _default: import("vue").DefineComponent<{
     onClose: import("vue-types").VueTypeValidableDef<(...args: any[]) => any> & {
         default: (...args: any[]) => any;
     };
+    getContainer: import("vue-types").VueTypeDef<HTMLElement>;
+    width: import("vue-types").VueTypeDef<string | number>;
+    actions: import("vue-types").VueTypeShape<IMessageActions>;
 }>> & {
-    onDestory?: (...args: any[]) => any;
+    onDestroy?: (...args: any[]) => any;
 }, {
+    extCls: string;
+    theme: "error" | "success" | "warning" | "primary";
     id: string;
     onClose: (...args: any[]) => any;
-    theme: string;
-    extCls: string;
-    message: string;
-    spacing: number;
     delay: number;
-    dismissable: boolean;
     offsetY: number;
-}>;
+    spacing: number;
+    dismissable: boolean;
+}, {}>;
 export default _default;