@polyv/chat-ui 2.2.0-rc-20251113.1 → 2.4.0-rc-20251225.2

package/index.d.ts

@@ -1,3 +1,4 @@
+import { AskMsgType } from '@polyv/chat';
 import { ChatMessageUser } from '@polyv/chat';
 import { ChatMsgRewardType } from '@polyv/chat';
 import { ChatMsgSource } from '@polyv/chat';
@@ -22,8 +23,36 @@ import { SystemMsgType } from '@polyv/chat';
 import { ValidatorFunction } from 'vue-types/dist/types';
 import { Vue3Instance } from 'vue/types/v3-component-public-instance';
 import { VueTypeValidableDef } from 'vue-types';
+import { VueTypeValidableDef as VueTypeValidableDef_2 } from 'vue-types';
+import { VueTypeValidableDef as VueTypeValidableDef_3 } from 'vue-types';
 
-declare const __VLS_component: DefineComponent<    {
+declare const __VLS_component: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
+
+declare const __VLS_component_2: DefineComponent<    {
+/**
+* 是否显示发送图片图标
+* @default false
+*/
+showSendImage: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+default: boolean;
+} & {
+default: boolean;
+};
+}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {
+/**
+* 是否显示发送图片图标
+* @default false
+*/
+showSendImage: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+default: boolean;
+} & {
+default: boolean;
+};
+}>>, {
+showSendImage: boolean;
+}>;
+
+declare const __VLS_component_3: DefineComponent<    {
 defaultHeight: VueTypeValidableDef<number, ValidatorFunction<number>> & {
 default: number;
 } & {
@@ -52,9 +81,27 @@ defaultHeight: number;
 showMore: boolean;
 }>;
 
-declare const __VLS_component_2: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
-
 declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        'body-suffix'?(_: {}): any;
+        suffix?(_: {}): any;
+    };
+    refs: {};
+    rootEl: HTMLDivElement;
+};
+
+declare function __VLS_template_2(): {
+    attrs: Partial<{}>;
+    slots: {
+        'body-suffix'?(_: {}): any;
+        suffix?(_: {}): any;
+    };
+    refs: {};
+    rootEl: HTMLDivElement;
+};
+
+declare function __VLS_template_3(): {
     attrs: Partial<{}>;
     slots: {
         'more-panel'?(_: {}): any;
@@ -64,6 +111,7 @@ declare function __VLS_template(): {
     };
     refs: {
         msgInputBaseRef: (Vue3Instance<    {}, Readonly<ExtractPropTypes<    {
+        resizeStorageKey: VueTypeValidableDef<string, ValidatorFunction<string>>;
         defaultHeight: VueTypeValidableDef<number, ValidatorFunction<number>> & {
         default: number;
         } & {
@@ -74,6 +122,11 @@ declare function __VLS_template(): {
         } & {
         default: boolean;
         };
+        showSendImage: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
         placeholder: VueTypeValidableDef<string, ValidatorFunction<string>> & {
         default: string;
         };
@@ -92,7 +145,18 @@ declare function __VLS_template(): {
         } & {
         default: number;
         };
+        showFaceEmotion: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
+        showImageEmotion: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
         }>>, Readonly<ExtractPropTypes<    {
+        resizeStorageKey: VueTypeValidableDef<string, ValidatorFunction<string>>;
         defaultHeight: VueTypeValidableDef<number, ValidatorFunction<number>> & {
         default: number;
         } & {
@@ -103,6 +167,11 @@ declare function __VLS_template(): {
         } & {
         default: boolean;
         };
+        showSendImage: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
         placeholder: VueTypeValidableDef<string, ValidatorFunction<string>> & {
         default: string;
         };
@@ -121,6 +190,16 @@ declare function __VLS_template(): {
         } & {
         default: number;
         };
+        showFaceEmotion: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
+        showImageEmotion: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
         }>>, {
         submit: (arg: {
         contentList: InputContent[];
@@ -132,12 +211,16 @@ declare function __VLS_template(): {
         "click-send-image": (arg?: void | undefined) => void;
         }, {
         disabledInput: boolean;
+        showFaceEmotion: boolean;
+        showImageEmotion: boolean;
         placeholder: string;
         disabledSubmitBtn: boolean;
         maxInputTextLength: number;
         defaultHeight: number;
         showBottom: boolean;
+        showSendImage: boolean;
         }, true, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, any>> & Readonly<Readonly<ExtractPropTypes<    {
+        resizeStorageKey: VueTypeValidableDef<string, ValidatorFunction<string>>;
         defaultHeight: VueTypeValidableDef<number, ValidatorFunction<number>> & {
         default: number;
         } & {
@@ -148,6 +231,11 @@ declare function __VLS_template(): {
         } & {
         default: boolean;
         };
+        showSendImage: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
         placeholder: VueTypeValidableDef<string, ValidatorFunction<string>> & {
         default: string;
         };
@@ -166,9 +254,20 @@ declare function __VLS_template(): {
         } & {
         default: number;
         };
+        showFaceEmotion: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
+        showImageEmotion: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
         }>>> & ShallowUnwrapRef<    {
         focusInput: () => void;
         }> & ExtractComputedReturns<    {}> & ComponentCustomProperties & Readonly<ExtractPropTypes<    {
+        resizeStorageKey: VueTypeValidableDef<string, ValidatorFunction<string>>;
         defaultHeight: VueTypeValidableDef<number, ValidatorFunction<number>> & {
         default: number;
         } & {
@@ -179,6 +278,11 @@ declare function __VLS_template(): {
         } & {
         default: boolean;
         };
+        showSendImage: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
         placeholder: VueTypeValidableDef<string, ValidatorFunction<string>> & {
         default: string;
         };
@@ -197,6 +301,16 @@ declare function __VLS_template(): {
         } & {
         default: number;
         };
+        showFaceEmotion: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
+        showImageEmotion: VueTypeValidableDef<boolean, ValidatorFunction<boolean>> & {
+        default: boolean;
+        } & {
+        default: boolean;
+        };
         }>> & {
             $scopedSlots: {
                 'panel-suffix'?(_: {}): any;
@@ -207,24 +321,17 @@ declare function __VLS_template(): {
                 'bottom-suffix'?(_: {}): any;
             };
         }) | null;
+        morePanelRef: HTMLDivElement;
     };
     rootEl: HTMLDivElement;
 };
 
-declare function __VLS_template_2(): {
-    attrs: Partial<{}>;
-    slots: {
-        'body-suffix'?(_: {}): any;
-        suffix?(_: {}): any;
-    };
-    refs: {};
-    rootEl: HTMLDivElement;
-};
-
 declare type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
 
 declare type __VLS_TemplateResult_2 = ReturnType<typeof __VLS_template_2>;
 
+declare type __VLS_TemplateResult_3 = ReturnType<typeof __VLS_template_3>;
+
 declare type __VLS_WithTemplateSlots<T, S> = T & {
     new (): {
         $scopedSlots: S;
@@ -237,21 +344,84 @@ declare type __VLS_WithTemplateSlots_2<T, S> = T & {
     };
 };
 
+declare type __VLS_WithTemplateSlots_3<T, S> = T & {
+    new (): {
+        $scopedSlots: S;
+    };
+};
+
 /**
  * 动画来源
  */
 declare type AnimationSource = 'donate-animation' | 'chat-like' | 'special-effect-animation';
 
+/**
+ * 提问配置
+ */
+declare interface AskConfig {
+    /**
+     * 提问欢迎语
+     * @default ''
+     */
+    askWelcomeText?: string;
+    /**
+     * 显示在线状态
+     * @default false
+     */
+    showOnlineStatus?: boolean;
+    /**
+     * 提问新消息回调
+     */
+    onNewAskMessage?: (askMsg: AskMsgType) => void;
+}
+
+export declare const AskManager: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+"open-ask": (arg?: void | undefined) => void;
+}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
+
+export declare const AskMessageInputControl: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+
+export declare const AskMessageInputPopup: DefineComponent<    {}, {
+showInputPopup: typeof showInputPopup;
+closeInputPopup: typeof closeInputPopup;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+"visible-change": (arg: boolean) => void;
+}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
+
+export declare const AskMessageInputSection: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
+
+export declare const AskMessageList: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
+
+export declare const AskUserList: DefineComponent<    {}, {
+addAskUser: (data: {
+targetUserId: string;
+user: ChatMessageUser;
+setActive?: boolean;
+}) => void;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
+
 export declare const BanList: DefineComponent<    {}, {
 openBanList: () => void;
 closeBanList: () => void;
 }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
 
+export declare interface BaseConfig {
+    /**
+     * 是否隐藏昵称
+     * @default false
+     */
+    hideNickname?: boolean;
+}
+
 export declare interface ChatGlobalInject {
     /**
      * 获取聊天室实例对象
      */
     getChatTarget: () => PolyvChat;
+    /**
+     * 获取基础配置
+     */
+    getBaseConfig?: () => BaseConfig;
     /**
      * 获取消息配置
      */
@@ -292,6 +462,10 @@ export declare interface ChatGlobalInject {
      * 获取是否显示动画
      */
     getAnimationVisible?: (animationSource: AnimationSource) => boolean;
+    /**
+     * 获取提问配置
+     */
+    getAskConfig?: () => AskConfig;
     /**
      * 拦截处理，返回 true 表示终止后续的业务逻辑执行
      */
@@ -300,12 +474,16 @@ export declare interface ChatGlobalInject {
 
 export declare const ChatLike: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
 
+export declare const ChatMessageInputControl: __VLS_WithTemplateSlots_2<typeof __VLS_component_2, __VLS_TemplateResult_2["slots"]>;
+
 export declare const ChatMessageInputPopup: DefineComponent<    {}, {
-showInputPopup: typeof showInputPopup;
-closeInputPopup: typeof closeInputPopup;
-}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
+showInputPopup: typeof showInputPopup_2;
+closeInputPopup: typeof closeInputPopup_2;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+"visible-change": (arg: boolean) => void;
+}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
 
-export declare const ChatMessageInputSection: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export declare const ChatMessageInputSection: __VLS_WithTemplateSlots_3<typeof __VLS_component_3, __VLS_TemplateResult_3["slots"]>;
 
 export declare const ChatMessageList: DefineComponent<    {}, {
 setIsOnlySpecialMsg: (value: boolean) => void;
@@ -313,14 +491,16 @@ setIsOnlySpecialMsg: (value: boolean) => void;
 
 declare function closeInputPopup(): void;
 
+declare function closeInputPopup_2(): void;
+
 export declare const DonateAnimation: DefineComponent<    {
-trackCount: VueTypeValidableDef<number, ValidatorFunction<number>> & {
+trackCount: VueTypeValidableDef_2<number, ValidatorFunction<number>> & {
 default: number;
 } & {
 default: number;
 };
 }, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {
-trackCount: VueTypeValidableDef<number, ValidatorFunction<number>> & {
+trackCount: VueTypeValidableDef_2<number, ValidatorFunction<number>> & {
 default: number;
 } & {
 default: number;
@@ -352,14 +532,14 @@ export declare interface HistoryConfig {
      * @default false
      */
     workWechatMyCustomerHistory?: boolean;
+    /**
+     * 是否获取聊天历史消息
+     * @default true
+     */
+    getChatHistory?: boolean;
 }
 
 export declare interface InputConfig {
-    /**
-     * 聊天室输入框占位符
-     * @default ''
-     */
-    inputPlaceholder?: string;
     /**
      * 黄脸表情开关
      * @default true
@@ -376,15 +556,29 @@ export declare interface InputConfig {
      */
     disabledInput?: boolean;
     /**
-     * 发送图片开关
+     * 输入框遮罩文案
+     * @default ''
+     */
+    inputMaskPlaceholder?: string;
+    /**
+     * 聊天室输入框占位符
+     * @default ''
+     */
+    chatInputPlaceholder?: string;
+    /**
+     * 聊天区发送图片开关
      * @default true
      */
-    sendImageEnabled?: boolean;
+    sendChatImageEnabled?: boolean;
     /**
-     * 输入框遮罩文案
+     * 提问区输入框占位符
      * @default ''
      */
-    inputMaskPlaceholder?: string;
+    askInputPlaceholder?: string;
+    /**
+     * 提问区发送图片开关
+     */
+    sendAskImageEnabled?: boolean;
 }
 
 export declare type InputContent = InputContentText | InputContentImage;
@@ -442,6 +636,19 @@ declare interface LikeConfig {
      * @default 40
      */
     triggerSize?: number;
+    /**
+     * 气泡列表
+     */
+    bubbles?: string[];
+    /**
+     * 是否显示点赞数
+     * @default true
+     */
+    showCount?: boolean;
+    /**
+     * 图标图片
+     */
+    triggerImage?: string;
 }
 
 /**
@@ -488,10 +695,6 @@ export declare interface ManageConfig {
      * @default false
      */
     askUserEnabled?: boolean;
-    /**
-     * 私聊用户回调
-     */
-    askUserCallback?: boolean | ((user: ChatMessageUser) => void);
     /**
      * 聊天室全体禁言开关
      * @default false
@@ -516,9 +719,23 @@ export declare interface ManageConfig {
     downloadOnlineListEnabled?: boolean;
 }
 
-export declare const ManagerInputControl: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
-
-export declare const MemberList: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
+export declare const MemberList: DefineComponent<    {
+showTop: VueTypeValidableDef_3<boolean, ValidatorFunction<boolean>> & {
+default: boolean;
+} & {
+default: boolean;
+};
+}, {
+openRulePopup: typeof openRulePopup;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {
+showTop: VueTypeValidableDef_3<boolean, ValidatorFunction<boolean>> & {
+default: boolean;
+} & {
+default: boolean;
+};
+}>>, {
+showTop: boolean;
+}>;
 
 export declare interface MessageConfig {
     /**
@@ -526,6 +743,11 @@ export declare interface MessageConfig {
      * @default ''
      */
     introductionText?: string;
+    /**
+     * 聊天区系统消息
+     * @default ''
+     */
+    systemText?: string;
     /**
      * 是否显示聊天室空数据提示
      * @default false
@@ -777,6 +999,21 @@ export declare interface OnlineConfig {
      * @default 200
      */
     requestCount?: number;
+    /**
+     * 搜索在线列表开关
+     * @default true
+     */
+    searchEnabled?: boolean;
+    /**
+     * 规则开关
+     * @default false
+     */
+    ruleEnabled?: boolean;
+    /**
+     * 轮训间隔，单位：毫秒
+     * @default 10000
+     */
+    pollingTime?: number;
     /**
      * 在线人数更新回调
      * @param count 在线人数
@@ -784,14 +1021,16 @@ export declare interface OnlineConfig {
     onlineCountCallback?: (count: number) => void;
 }
 
+declare function openRulePopup(): void;
+
 export declare const RunwayEffect: DefineComponent<    {
-left: VueTypeValidableDef<number, ValidatorFunction<number>> & {
+left: VueTypeValidableDef_2<number, ValidatorFunction<number>> & {
 default: number;
 } & {
 default: number;
 };
 }, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {
-left: VueTypeValidableDef<number, ValidatorFunction<number>> & {
+left: VueTypeValidableDef_2<number, ValidatorFunction<number>> & {
 default: number;
 } & {
 default: number;
@@ -802,6 +1041,8 @@ left: number;
 
 declare function showInputPopup(): void;
 
+declare function showInputPopup_2(): void;
+
 export declare const SpecialEffectAnimation: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
 
 /**
@@ -824,6 +1065,27 @@ export declare interface SpecialEffectConfig {
     visibleChangeCallback?: (visible: boolean) => void;
 }
 
+export declare const SwiperSection: DefineComponent<    {
+swiperList: VueTypeValidableDef_2<("ask" | "chat")[], ValidatorFunction<("ask" | "chat")[]>> & {
+default: () => ("ask" | "chat")[];
+} & {
+default: () => ("ask" | "chat")[];
+};
+}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+"slide-reach-end": (arg?: void | undefined) => void;
+"slide-reach-beginning": (arg?: void | undefined) => void;
+}, string, Readonly<ExtractPropTypes<    {
+swiperList: VueTypeValidableDef_2<("ask" | "chat")[], ValidatorFunction<("ask" | "chat")[]>> & {
+default: () => ("ask" | "chat")[];
+} & {
+default: () => ("ask" | "chat")[];
+};
+}>>, {
+swiperList: ("ask" | "chat")[];
+}>;
+
+export declare const SwiperSectionControl: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
+
 export declare const TopingMsgList: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes<    {}>>, {}>;
 
 export declare const useChatGlobalProvide: (injectData: ChatGlobalInject) => void;
@@ -835,7 +1097,7 @@ setIsOnlySpecialMsg: (value: boolean) => void;
 toggleOnlySpecialMsg: () => void;
 }>;
 
-export declare const useSendMsg: () => {
+export declare const useSendChatMsg: () => {
     sendSpeakMsg: (options: SendSpeakMsgOptions) => Promise<void>;
     sendImageMsg: (options: SendImageMsgOptions) => Promise<void>;
     sendEmotionImageMsg: (options: SendEmotionImageMsgOptions) => Promise<void>;
@@ -855,6 +1117,4 @@ showSpecialEffect: () => void;
 hideSpecialEffect: () => void;
 }>;
 
-export declare const ViewerInputControl: __VLS_WithTemplateSlots_2<typeof __VLS_component_2, __VLS_TemplateResult_2["slots"]>;
-
 export { }