@shijiu/jsview-vue 2.3.0 → 2.3.728-alpha.0

package/dist/types/utils/JsViewEngineWidget/CheckType.d.ts

@@ -0,0 +1,7 @@
+/** 
+ + @file {@link file://./../../../utils/JsViewEngineWidget/CheckType.js}
+ */
+
+export function checkType(value: any, type: any): boolean;
+export function toRawType(value: any): string;
+export function getTypeName(ctor: any): any;

package/dist/types/utils/JsViewEngineWidget/JsvFocus/JsvFocusBlock.vue.d.ts

@@ -0,0 +1,106 @@
+/** 
+ + @file {@link file://./../../../../utils/JsViewEngineWidget/JsvFocus/JsvFocusBlock.vue}
+ */
+
+/**
+ * @file
+ *
+ *  props:
+ *    onKeyUp: 按键抬起回调
+ *           @params keyEvent
+ *           @return 是否消耗 true: 已消耗，不再冒泡; false: 继续冒泡
+ *    onKeyDown: 按键落下回调
+ *             @params keyEvent
+ *             @return 是否消耗 true: 已消耗，不再冒泡; false: 继续冒泡
+ *    onFocus: 获得焦点回调
+ *    onBlur: 失去焦点回调
+ *    onDispatchKeyDown: 分发按键落下事件回调
+ *                    @params keyEvent
+ *                    @return 是否消耗 true: 已消耗，不再分发; false: 继续分发
+ *    onDispatchKeyUp: 分发按键抬起事件回调
+ *                 @params keyEvent
+ *                 @return 是否消耗 true: 已消耗，不再分发; false: 继续分发
+ *    name: 用于设置焦点的id
+ *    namespace: 焦点id的命名空间
+ *    autoFocus: 当Mount后自动获得焦点, 设置为"exact"，将把其子节点的焦点给抢过来
+ *  methods:
+ *    async getFullName
+        @description 获取其从根节点开始到本节点的全名
+        @params {string} name 节点的id名
+ *    async requestFocus
+        @description 赋予焦点
+        @params {boolean} passToChild 焦点由子往父时是否保持子的焦点
+*/
+
+declare const _default: {
+    new (...args: any[]): {
+        $: import("vue").ComponentInternalInstance;
+        $data: {};
+        $props: Partial<{}> & Omit<Readonly<import("vue").ExtractPropTypes<{}>> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, never>;
+        $attrs: {
+            [x: string]: unknown;
+        };
+        $refs: {
+            [x: string]: unknown;
+        };
+        $slots: Readonly<{
+            [name: string]: import("vue").Slot | undefined;
+        }>;
+        $root: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string>, {}> | null;
+        $parent: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string>, {}> | null;
+        $emit: (event: string, ...args: any[]) => void;
+        $el: any;
+        $options: import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{}>>, {
+            getFullName: () => Promise<any>;
+            requestFocus: (passToChild: any) => Promise<void>;
+            bubbleCustomEvent: (ev: any) => void;
+            returnFocusToParent: (ev: any) => void;
+            $props: {
+                [x: string]: any;
+            };
+        }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {}, {}, string> & {
+            beforeCreate?: ((() => void) | (() => void)[]) | undefined;
+            created?: ((() => void) | (() => void)[]) | undefined;
+            beforeMount?: ((() => void) | (() => void)[]) | undefined;
+            mounted?: ((() => void) | (() => void)[]) | undefined;
+            beforeUpdate?: ((() => void) | (() => void)[]) | undefined;
+            updated?: ((() => void) | (() => void)[]) | undefined;
+            activated?: ((() => void) | (() => void)[]) | undefined;
+            deactivated?: ((() => void) | (() => void)[]) | undefined;
+            beforeDestroy?: ((() => void) | (() => void)[]) | undefined;
+            beforeUnmount?: ((() => void) | (() => void)[]) | undefined;
+            destroyed?: ((() => void) | (() => void)[]) | undefined;
+            unmounted?: ((() => void) | (() => void)[]) | undefined;
+            renderTracked?: (((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
+            renderTriggered?: (((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
+            errorCaptured?: (((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string>, {}> | null, info: string) => boolean | void) | ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string>, {}> | null, info: string) => boolean | void)[]) | undefined;
+        };
+        $forceUpdate: () => void;
+        $nextTick: typeof import("vue").nextTick;
+        $watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (args_0: R, args_1: R) => any : (...args: any) => any, options?: import("vue").WatchOptions<boolean> | undefined): import("vue").WatchStopHandle;
+    } & Readonly<import("vue").ExtractPropTypes<{}>> & import("vue").ShallowUnwrapRef<{
+        getFullName: () => Promise<any>;
+        requestFocus: (passToChild: any) => Promise<void>;
+        bubbleCustomEvent: (ev: any) => void;
+        returnFocusToParent: (ev: any) => void;
+        $props: {
+            [x: string]: any;
+        };
+    }> & {} & import("vue").ComponentCustomProperties & {};
+    __isFragment?: undefined;
+    __isTeleport?: undefined;
+    __isSuspense?: undefined;
+} & import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{}>>, {
+    getFullName: () => Promise<any>;
+    requestFocus: (passToChild: any) => Promise<void>;
+    bubbleCustomEvent: (ev: any) => void;
+    returnFocusToParent: (ev: any) => void;
+    $props: {
+        [x: string]: any;
+    };
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {}, {}, string> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
+    $slots: {
+        default: (_: {}) => any;
+    };
+});
+export default _default;

package/dist/types/utils/JsViewEngineWidget/JsvFocus/JsvFocusHub.d.ts

@@ -0,0 +1,128 @@
+/** 
+ + @file {@link file://./../../../../utils/JsViewEngineWidget/JsvFocus/JsvFocusHub.ts}
+ */
+
+declare class JsvFocusHubApi {
+    private _FocusHub;
+    constructor(focusableHubRef: any);
+    getOrigin(): Object;
+    /**
+     * getFocusCallToken
+     *
+     * 获取当前焦点切换SetFocus被调用的序列号, 每次setFocus调用时会递增
+     * 便于框架中一些自动setFocus行为识别出是否回调中App开发端已经进行了SetFocus操作, 避免重复setFocus
+     *
+     * @return {number} 当前焦点切换的序列号
+     */
+    getFocusCallToken(): number;
+    /**
+     * setFocus
+     *
+     * 设置焦点，在焦点对应的 JsvFocusBlock 完成mounted之前设置的话，
+     * 会在JsvFocusBlock完成mounted后立即设上焦点
+     *
+     * @param {string} focusName
+     *         当前命名空间的名字/全局命名空间的名字。
+     *         当前命名空间的名字: 是指和当前节点相同命名空间的名字(首字符不为".")。
+     *         对于二级命名空间，可以使用 "{namespace}.{name}"的方式。
+     *         全局命名空间的名字: 是指通过getName()函数获取后再附加下级节点的名字。
+     *         *请注意: 请避免手写的全局命名空间名字，防止在二次集成时可能会出现名字找不到的问题。
+     * @param {boolean} passToChild 保持/恢复子焦点的聚焦状态(若此焦点的子焦点为聚焦状态，
+     *         当本焦点从失焦状态恢复为聚焦状态时，子焦点也自动回复为聚焦状态)，默认为不保持/恢复。
+     */
+    setFocus(focusName: string, passToChild?: boolean): void;
+    /**
+     * returnFocusToParent
+     *
+     * 将焦点从当前节点还给其父JsvFocusBlock节点
+     */
+    returnFocusToParent(): void;
+    /**
+     * getCurrentFocus
+     *
+     * 获取当前焦点的的 focusName 信息，用于后续的进行的 setFocus 操作
+     * (注意1: 获取的NameSpace不带NameSpace)
+     * (注意2: 如果当前状态所设焦点还没Mounted时，也会返回null)
+     *
+     * @return {string} 当前焦点的focusName
+     */
+    getCurrentFocus(): string;
+    /**
+     * getLastFocus
+     *
+     * 获得切到到当前焦点前的上一个焦点链中离root最远的节点的焦点的name(注意, 不带NameSpace),
+     *
+     * @return {string} 焦点的focusName
+     */
+    getLastFocus(): string;
+    /**
+     * getLastFocusNear
+     *
+     * 获得切到到当前焦点前的上一个焦点链中离root最近的节点的焦点的name(注意, 不带NameSpace),
+     *
+     * @return {string} 焦点的focusName
+     */
+    getLastFocusNear(): string;
+    /**
+     * getDeactivedPageFocus
+     *
+     * 在对一个keep-alive的界面进行deactive后，为了未来将其active时恢复离开时的焦点时使用。
+     * 在 onDeactive 回调中调用
+     * 注意: 只有当一个有焦点的keep-alive倍deactive时才能获得
+     *
+     * @return {string} 焦点的focusName
+     */
+    getDeactivedPageFocus(): string;
+    /**
+     * getNameSpace
+     *
+     * 获取当前FocusHub的nameSpace
+     *
+     * @return {string} 当前FocusHub的nameSpace
+     */
+    getNameSpace(): string;
+    /**
+     * enableFocusTrace
+     *
+     * 调试API: 启用焦点变化时的回调日志，通过console.log打出，其中含产生此行为的调用堆栈
+     *
+     * @param {boolean} needCallStack 是否打印焦点变化时产生变化的api调用的堆栈，例如setFocus, unmount之类
+     */
+    enableFocusTrace(needCallStack?: boolean): void;
+    /**
+     * printAllFocusable
+     *
+     * 调试API: console.log当前 Hub 中所有的节点引用，只打印当前NameSpace的内容
+     */
+    printAllFocusable(): void;
+    /**
+     * getCurrentFocusStack
+     *
+     * 调试API: console.log当前焦点的焦点链条(从root到此节点的链条)
+     *
+     * @return {Array} 当前焦点的链条队列
+     */
+    getCurrentFocusStack(): Array<Object>;
+    /**
+     * addFocusChangeListener
+     *
+     * 添加焦点变化监听器, 主要用来追踪焦点name的变化，例如路由切换的场景
+     *
+     * @param {Function} listener 焦点变化监听器, 参数为 {focusName: string}
+     * @param {boolean} onRequest 监听时机，true: 在focus请求时即回调，无论节点是否存在；
+     *                             false: 在节点真实存在后，确认进行focus时才回调(在正准备Focus()调用前)
+     */
+    addFocusChangeListener(listener: Function, onRequest?: boolean): void;
+    /**
+     * removeFocusChangeListener
+     *
+     * 删除焦点变化监听器
+     *
+     * @param {Function} listener 由addFocusChangeListener添加的变化监听器
+     * @param {boolean} onRequest 和addFocusChangeListener时设置的参数要完全对应
+     */
+    removeFocusChangeListener(listener: Function, onRequest?: boolean): void;
+}
+declare const ROOT_HUB_PROVIDE_NAME = "__jsvFocusRootHub__";
+declare const HUB_NS_PROVIDE_NAME = "__jsvFocusNameSpace__";
+export { JsvFocusHubApi, ROOT_HUB_PROVIDE_NAME, HUB_NS_PROVIDE_NAME };

package/dist/types/utils/JsViewEngineWidget/JsvFocus/JsvFocusManager.d.ts

@@ -0,0 +1,25 @@
+/** 
+ + @file {@link file://./../../../../utils/JsViewEngineWidget/JsvFocus/JsvFocusManager.ts}
+ */
+
+declare const useFocusHub: (withNameSpace: any) => unknown;
+export declare class JsvFocusManager {
+    private $_appMount;
+    private $_topFDiv;
+    private $_autoSearchFocus;
+    constructor(config: any);
+    install(app: any, ...options: any): void;
+    getCurrentFocusStack(): any;
+    $_hookMount(app: any, rootNodeId: any): (rootContainer: any) => any;
+    $_doAppMount(rootContainer: any): any;
+}
+/**
+ * 创建 JsView 焦点管理器
+ *
+ * @param {Object} config: 对象设置，子参数有{
+ *                autoSearchFocus{boolean}: 是否开启自动寻焦，默认为false(兼容旧代码)
+ *             }
+ * @return JsvFocusManager
+ */
+declare function jsvCreateFocusManager(config?: Object | null): JsvFocusManager;
+export { jsvCreateFocusManager, useFocusHub };

package/dist/types/utils/JsViewEngineWidget/MetroWidget/Const.d.ts

@@ -0,0 +1,23 @@
+/** 
+ + @file {@link file://./../../../../utils/JsViewEngineWidget/MetroWidget/Const.ts}
+ */
+
+declare const METRO_WIDGET: {
+    SLIDE: number;
+    CHILD_SLIDE_EVENT: number;
+    ON_KEY_DOWN: number;
+    ITEM_RESIZE: {
+        ANCHOR: number;
+        WIDGET_SET: number;
+        CUSTOMER_SET: number;
+    };
+    ITEM_SLIDE: {
+        DISABLE: number;
+        ACT_ITEM_FOCUS: number;
+        ACT_FOCUS_RECT_EVENT: number;
+    };
+};
+declare const ONEDGE_TYPE: {
+    SPATIAL_NAV: string;
+};
+export { METRO_WIDGET, METRO_WIDGET as METRO_WIDGET_CONST, ONEDGE_TYPE, };

package/dist/types/utils/JsViewEngineWidget/MetroWidget/DebugFrame.vue.d.ts

@@ -0,0 +1,12 @@
+/** 
+ + @file {@link file://./../../../../utils/JsViewEngineWidget/MetroWidget/DebugFrame.vue}
+ */
+
+declare const _default: import("vue").DefineComponent<{}, {
+    $props: {
+        readonly width?: number | undefined;
+        readonly height?: number | undefined;
+        readonly sourceId?: string | undefined;
+    };
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
+export default _default;

package/dist/types/utils/JsViewEngineWidget/MetroWidget/DebugTools.d.ts

@@ -0,0 +1,9 @@
+/** 
+ + @file {@link file://./../../../../utils/JsViewEngineWidget/MetroWidget/DebugTools.ts}
+ */
+
+export declare const randomColor: () => string;
+export declare function createCanvasText(width: number): {
+    sourceId: String;
+    releaseHandler: () => void;
+};

package/dist/types/utils/JsViewEngineWidget/MetroWidget/Dispatcher.d.ts

@@ -0,0 +1,16 @@
+/** 
+ + @file {@link file://./../../../../utils/JsViewEngineWidget/MetroWidget/Dispatcher.ts}
+ */
+
+import { BaseDispatcher } from "../WidgetCommon";
+declare class Dispatcher extends BaseDispatcher {
+    static Type: {
+        setFocusId: symbol;
+        updateItem: symbol;
+        slideToItem: symbol;
+        setEnterFocusId: symbol;
+        setEnterFocusRect: symbol;
+    };
+}
+export { Dispatcher as SWidgetDispatcher };
+export default Dispatcher;