mtxt-ui3 0.0.2

package/dist/hooks/index.d.ts

@@ -0,0 +1,127 @@
+import * as vue from 'vue';
+import { Ref } from 'vue';
+import { Dayjs } from 'dayjs';
+import _ from 'lodash';
+import { MaybeRef, MaybeComputedRef } from '@vueuse/core';
+import { Key } from 'ant-design-vue/lib/table/interface';
+
+/**
+ * 获取当前时间并格式化
+ * @param pattern 格式化字符串 不传返回dayjs对象
+ */
+declare function useNow(): Ref<Dayjs>;
+declare function useNow(pattern: string): Ref<string>;
+
+/**
+ * 通用表格查询hook
+ * @param getData 获取数据的函数 返回Promise
+ * @param listProp 数据列表在data中的属性 不传代表不分页
+ * @param totalName 总数在data中的属性 默认为totalCount
+ * @param pageNum 自定义每页条数 默认为10
+ */
+declare function useTableList(getData: () => Promise<any>, listProp?: string, totalName?: string, pageNum?: number): {
+    isLoading: vue.Ref<boolean>;
+    tableList: any;
+    currPage: vue.Ref<number>;
+    handlePageChange: (page: number) => void;
+    pageSize: vue.Ref<number>;
+    hanldePageSizeChange: (size: number) => void;
+    total: vue.Ref<number>;
+    refresh: _.DebouncedFunc<() => Promise<void>>;
+    pagination: {
+        current: number;
+        pageSize: number;
+        total: number;
+        showSizeChanger: boolean;
+        showQuickJumper: boolean;
+        showTotal: (total: number) => string;
+        "onUpdate:current": (page: number) => void;
+        "onUpdate:pageSize": (size: number) => void;
+    };
+};
+
+type UseModalVisibleOption = {
+    clone?: boolean;
+    defaultVisible?: boolean;
+};
+/**
+ * 控制是否展示对话框
+ * @param defaultVisible 默认是否展示
+ * @returns {[boolean, function, object]} [是否显示，处理点击(传入row)，传入的对象]
+ * @example
+ * const [isVisible, handleDetailClick, detailRecord] = useModalVisible();
+ * // 表格或列表中
+ * <a-button onClick={() => handleDetailClick(row)}>编辑</a-button>
+ */
+declare function useModalVisible<T = any>(option?: UseModalVisibleOption): [Ref<Boolean>, (r?: T) => void, Ref<T | undefined>];
+
+/**
+ * 事件hook
+ * 监听： useEvent('xxx', handleEvent);
+ * 触发： const emitXXX = useEvent('xxx'); emitXXX(...any);
+ * @param name 时间名称
+ * @param listener 回调
+ */
+declare function useEvent(name: string, listener?: (...ard: any[]) => any): (event?: unknown, payload?: any) => void;
+
+/**
+ * 自适应zoom 根据设计尺寸和实际window宽度计算
+ * @param designWidth 设计尺寸宽度 可以传数字或ref
+ * @returns zoom值
+ * @example
+ * const zoom = useZoomAdaptation(1920);
+ * () => <div style={{zoom: zoom.value}}><div/>
+ */
+declare function useZoomAdaptation(designWidth?: MaybeRef<number>): vue.Ref<number>;
+
+type RequetFunction = (...args: any[]) => any;
+/**
+ * 卡片轮询
+ * @param reqFn 获取数据函数
+ * @param isInterval 轮询开始/停止 @default true
+ * @param interval 间隔 @default 5000
+ * @param immediate 是否立即执行 @default true
+ * @param immediateCallback 是否立即执行回调 @default true
+ */
+declare function usePoolingReq(reqFn: RequetFunction, isInterval?: MaybeComputedRef<Boolean>, interval?: number, immediate?: true, immediateCallback?: true): void;
+
+interface PlayVideoArgs {
+    videoElm: string;
+    videoDom?: Document;
+    mediaServerAddr: string;
+    cameraUserName: string;
+    cameraPwd: string;
+    cameraIp: string;
+    cameraRtspPort: string;
+    cameraChannel: string;
+    cameraStream: string;
+    addRtspProxyUrl: string;
+}
+declare const playOneWebRtcMt: (uuid: string, domId: string, dom?: Document, token?: string) => Promise<any>;
+
+interface useSelectVo<T> {
+    onSelect: (record: T, selected: boolean) => void;
+    onSelectAll: (selected: boolean, selectedRows: T[], changeRows: T[]) => void;
+    resetSelectKey: () => void;
+    selectedRecords: Ref<T[]>;
+    selectedKeys: Ref<Key[]>;
+    selectedRowKeys: Ref<Key[]>;
+}
+/**
+ * Ant Table 跨页多选
+ * @param key 定义多选 key 值字段名 默认为 id
+ * 注意设置 rowKey 与 rowSelection.selectedRowKeys
+ */
+declare const useTableSelec: <T>(key?: Key) => useSelectVo<T>;
+
+/**
+ * 获取班次信息
+ * @param deptId 部门ID
+ * @param jobPostId 岗位ID
+ * @returns
+ * @example
+ * const shiftTime = useShiftTime(502166152148713472,457847136966696960);
+ */
+declare function useShiftTime(deptId: any, jobPostId: any): any;
+
+export { PlayVideoArgs, playOneWebRtcMt, useEvent, useModalVisible, useNow, usePoolingReq, useShiftTime, useTableList, useTableSelec, useZoomAdaptation };