@spacego/fe-components 0.0.1-alpha.1

package/lib/types/store/modules/layout-config.store.d.ts

@@ -0,0 +1,612 @@
+import { AxiosRequestConfig } from 'axios';
+import { TUpdateStore } from '../../typings';
+export interface TabItem {
+    key: string;
+    label: string;
+    path: string;
+    closable?: boolean;
+}
+type State = {
+    /** Tabs 配置 */
+    tabsAttribute: {
+        /** 已打开的页面标签列表 */
+        tabsList: TabItem[];
+        /** 当前激活的标签页 key */
+        tabsActiveKey: string;
+    };
+    /** Loading 配置 */
+    loadingConfig: {
+        show: boolean;
+        limit: number;
+        timer: number | null;
+    };
+    /** 侧边栏折叠状态 */
+    sidebarCollapsed: boolean;
+};
+type Update = TUpdateStore<State>;
+type Actions = {
+    SET_STATE: (data: Update) => void;
+    /** 添加标签页 */
+    ADD_TAB: (tab: TabItem) => void;
+    /** 移除标签页 */
+    REMOVE_TAB: (key: string) => void;
+    /** 设置当前激活的标签页 */
+    SET_ACTIVE_TAB_KEY: (key: string) => void;
+    /** 清空所有标签页 */
+    CLEAR_TABS: () => void;
+    /** 设置loading配置 */
+    SET_LOADING: (config?: AxiosRequestConfig) => void;
+    /** 取消loading */
+    HIDE_LOADING: (config?: AxiosRequestConfig) => void;
+    /** 清除loading定时器 */
+    CLEAR_LOADING_TIMER: () => void;
+    /** 设置侧边栏折叠状态 */
+    SET_SIDEBAR_COLLAPSED: (collapsed: boolean) => void;
+    /** 切换侧边栏折叠状态 */
+    TOGGLE_SIDEBAR_COLLAPSED: () => void;
+    /** 重置 */
+    RESET: () => void;
+    /** 设置通知的reactNode */
+    SET_NOTICE_RENDER: (render: React.ReactNode) => void;
+};
+type LayoutConfigStore = State & Actions;
+export declare const useLayoutConfigStore: import('zustand').UseBoundStore<Omit<import('zustand').StoreApi<Omit<LayoutConfigStore, "SET_STATE" | "ADD_TAB" | "REMOVE_TAB" | "SET_ACTIVE_TAB_KEY" | "CLEAR_TABS" | "SET_LOADING" | "HIDE_LOADING" | "CLEAR_LOADING_TIMER" | "SET_SIDEBAR_COLLAPSED" | "TOGGLE_SIDEBAR_COLLAPSED" | "RESET"> & {
+    SET_STATE: (data: Update) => unknown;
+    /**
+     * 添加标签页
+     */
+    ADD_TAB: (tab: TabItem) => void;
+    /**
+     * 移除标签页
+     */
+    REMOVE_TAB: (key: string) => TabItem;
+    /**
+     * 设置当前激活的标签页
+     */
+    SET_ACTIVE_TAB_KEY: (key: string) => void;
+    /**
+     * 清空所有标签页
+     */
+    CLEAR_TABS: () => void;
+    /**
+     * 设置loading配置
+     */
+    SET_LOADING: (config?: AxiosRequestConfig) => void;
+    /**
+     * 取消loading
+     */
+    HIDE_LOADING: (config?: AxiosRequestConfig) => void;
+    /**
+     * 清除loading定时器
+     */
+    CLEAR_LOADING_TIMER(): void;
+    /**
+     * 设置侧边栏折叠状态
+     */
+    SET_SIDEBAR_COLLAPSED: (collapsed: boolean) => void;
+    /**
+     * 切换侧边栏折叠状态
+     */
+    TOGGLE_SIDEBAR_COLLAPSED: () => void;
+    /**
+     * 重置
+     */
+    RESET: () => void;
+}>, "setState" | "persist"> & {
+    setState(partial: (Omit<LayoutConfigStore, "SET_STATE" | "ADD_TAB" | "REMOVE_TAB" | "SET_ACTIVE_TAB_KEY" | "CLEAR_TABS" | "SET_LOADING" | "HIDE_LOADING" | "CLEAR_LOADING_TIMER" | "SET_SIDEBAR_COLLAPSED" | "TOGGLE_SIDEBAR_COLLAPSED" | "RESET"> & {
+        SET_STATE: (data: Update) => unknown;
+        /**
+         * 添加标签页
+         */
+        ADD_TAB: (tab: TabItem) => void;
+        /**
+         * 移除标签页
+         */
+        REMOVE_TAB: (key: string) => TabItem;
+        /**
+         * 设置当前激活的标签页
+         */
+        SET_ACTIVE_TAB_KEY: (key: string) => void;
+        /**
+         * 清空所有标签页
+         */
+        CLEAR_TABS: () => void;
+        /**
+         * 设置loading配置
+         */
+        SET_LOADING: (config?: AxiosRequestConfig) => void;
+        /**
+         * 取消loading
+         */
+        HIDE_LOADING: (config?: AxiosRequestConfig) => void;
+        /**
+         * 清除loading定时器
+         */
+        CLEAR_LOADING_TIMER(): void;
+        /**
+         * 设置侧边栏折叠状态
+         */
+        SET_SIDEBAR_COLLAPSED: (collapsed: boolean) => void;
+        /**
+         * 切换侧边栏折叠状态
+         */
+        TOGGLE_SIDEBAR_COLLAPSED: () => void;
+        /**
+         * 重置
+         */
+        RESET: () => void;
+    }) | Partial<Omit<LayoutConfigStore, "SET_STATE" | "ADD_TAB" | "REMOVE_TAB" | "SET_ACTIVE_TAB_KEY" | "CLEAR_TABS" | "SET_LOADING" | "HIDE_LOADING" | "CLEAR_LOADING_TIMER" | "SET_SIDEBAR_COLLAPSED" | "TOGGLE_SIDEBAR_COLLAPSED" | "RESET"> & {
+        SET_STATE: (data: Update) => unknown;
+        /**
+         * 添加标签页
+         */
+        ADD_TAB: (tab: TabItem) => void;
+        /**
+         * 移除标签页
+         */
+        REMOVE_TAB: (key: string) => TabItem;
+        /**
+         * 设置当前激活的标签页
+         */
+        SET_ACTIVE_TAB_KEY: (key: string) => void;
+        /**
+         * 清空所有标签页
+         */
+        CLEAR_TABS: () => void;
+        /**
+         * 设置loading配置
+         */
+        SET_LOADING: (config?: AxiosRequestConfig) => void;
+        /**
+         * 取消loading
+         */
+        HIDE_LOADING: (config?: AxiosRequestConfig) => void;
+        /**
+         * 清除loading定时器
+         */
+        CLEAR_LOADING_TIMER(): void;
+        /**
+         * 设置侧边栏折叠状态
+         */
+        SET_SIDEBAR_COLLAPSED: (collapsed: boolean) => void;
+        /**
+         * 切换侧边栏折叠状态
+         */
+        TOGGLE_SIDEBAR_COLLAPSED: () => void;
+        /**
+         * 重置
+         */
+        RESET: () => void;
+    }> | ((state: Omit<LayoutConfigStore, "SET_STATE" | "ADD_TAB" | "REMOVE_TAB" | "SET_ACTIVE_TAB_KEY" | "CLEAR_TABS" | "SET_LOADING" | "HIDE_LOADING" | "CLEAR_LOADING_TIMER" | "SET_SIDEBAR_COLLAPSED" | "TOGGLE_SIDEBAR_COLLAPSED" | "RESET"> & {
+        SET_STATE: (data: Update) => unknown;
+        /**
+         * 添加标签页
+         */
+        ADD_TAB: (tab: TabItem) => void;
+        /**
+         * 移除标签页
+         */
+        REMOVE_TAB: (key: string) => TabItem;
+        /**
+         * 设置当前激活的标签页
+         */
+        SET_ACTIVE_TAB_KEY: (key: string) => void;
+        /**
+         * 清空所有标签页
+         */
+        CLEAR_TABS: () => void;
+        /**
+         * 设置loading配置
+         */
+        SET_LOADING: (config?: AxiosRequestConfig) => void;
+        /**
+         * 取消loading
+         */
+        HIDE_LOADING: (config?: AxiosRequestConfig) => void;
+        /**
+         * 清除loading定时器
+         */
+        CLEAR_LOADING_TIMER(): void;
+        /**
+         * 设置侧边栏折叠状态
+         */
+        SET_SIDEBAR_COLLAPSED: (collapsed: boolean) => void;
+        /**
+         * 切换侧边栏折叠状态
+         */
+        TOGGLE_SIDEBAR_COLLAPSED: () => void;
+        /**
+         * 重置
+         */
+        RESET: () => void;
+    }) => (Omit<LayoutConfigStore, "SET_STATE" | "ADD_TAB" | "REMOVE_TAB" | "SET_ACTIVE_TAB_KEY" | "CLEAR_TABS" | "SET_LOADING" | "HIDE_LOADING" | "CLEAR_LOADING_TIMER" | "SET_SIDEBAR_COLLAPSED" | "TOGGLE_SIDEBAR_COLLAPSED" | "RESET"> & {
+        SET_STATE: (data: Update) => unknown;
+        /**
+         * 添加标签页
+         */
+        ADD_TAB: (tab: TabItem) => void;
+        /**
+         * 移除标签页
+         */
+        REMOVE_TAB: (key: string) => TabItem;
+        /**
+         * 设置当前激活的标签页
+         */
+        SET_ACTIVE_TAB_KEY: (key: string) => void;
+        /**
+         * 清空所有标签页
+         */
+        CLEAR_TABS: () => void;
+        /**
+         * 设置loading配置
+         */
+        SET_LOADING: (config?: AxiosRequestConfig) => void;
+        /**
+         * 取消loading
+         */
+        HIDE_LOADING: (config?: AxiosRequestConfig) => void;
+        /**
+         * 清除loading定时器
+         */
+        CLEAR_LOADING_TIMER(): void;
+        /**
+         * 设置侧边栏折叠状态
+         */
+        SET_SIDEBAR_COLLAPSED: (collapsed: boolean) => void;
+        /**
+         * 切换侧边栏折叠状态
+         */
+        TOGGLE_SIDEBAR_COLLAPSED: () => void;
+        /**
+         * 重置
+         */
+        RESET: () => void;
+    }) | Partial<Omit<LayoutConfigStore, "SET_STATE" | "ADD_TAB" | "REMOVE_TAB" | "SET_ACTIVE_TAB_KEY" | "CLEAR_TABS" | "SET_LOADING" | "HIDE_LOADING" | "CLEAR_LOADING_TIMER" | "SET_SIDEBAR_COLLAPSED" | "TOGGLE_SIDEBAR_COLLAPSED" | "RESET"> & {
+        SET_STATE: (data: Update) => unknown;
+        /**
+         * 添加标签页
+         */
+        ADD_TAB: (tab: TabItem) => void;
+        /**
+         * 移除标签页
+         */
+        REMOVE_TAB: (key: string) => TabItem;
+        /**
+         * 设置当前激活的标签页
+         */
+        SET_ACTIVE_TAB_KEY: (key: string) => void;
+        /**
+         * 清空所有标签页
+         */
+        CLEAR_TABS: () => void;
+        /**
+         * 设置loading配置
+         */
+        SET_LOADING: (config?: AxiosRequestConfig) => void;
+        /**
+         * 取消loading
+         */
+        HIDE_LOADING: (config?: AxiosRequestConfig) => void;
+        /**
+         * 清除loading定时器
+         */
+        CLEAR_LOADING_TIMER(): void;
+        /**
+         * 设置侧边栏折叠状态
+         */
+        SET_SIDEBAR_COLLAPSED: (collapsed: boolean) => void;
+        /**
+         * 切换侧边栏折叠状态
+         */
+        TOGGLE_SIDEBAR_COLLAPSED: () => void;
+        /**
+         * 重置
+         */
+        RESET: () => void;
+    }>), replace?: false | undefined): unknown;
+    setState(state: (Omit<LayoutConfigStore, "SET_STATE" | "ADD_TAB" | "REMOVE_TAB" | "SET_ACTIVE_TAB_KEY" | "CLEAR_TABS" | "SET_LOADING" | "HIDE_LOADING" | "CLEAR_LOADING_TIMER" | "SET_SIDEBAR_COLLAPSED" | "TOGGLE_SIDEBAR_COLLAPSED" | "RESET"> & {
+        SET_STATE: (data: Update) => unknown;
+        /**
+         * 添加标签页
+         */
+        ADD_TAB: (tab: TabItem) => void;
+        /**
+         * 移除标签页
+         */
+        REMOVE_TAB: (key: string) => TabItem;
+        /**
+         * 设置当前激活的标签页
+         */
+        SET_ACTIVE_TAB_KEY: (key: string) => void;
+        /**
+         * 清空所有标签页
+         */
+        CLEAR_TABS: () => void;
+        /**
+         * 设置loading配置
+         */
+        SET_LOADING: (config?: AxiosRequestConfig) => void;
+        /**
+         * 取消loading
+         */
+        HIDE_LOADING: (config?: AxiosRequestConfig) => void;
+        /**
+         * 清除loading定时器
+         */
+        CLEAR_LOADING_TIMER(): void;
+        /**
+         * 设置侧边栏折叠状态
+         */
+        SET_SIDEBAR_COLLAPSED: (collapsed: boolean) => void;
+        /**
+         * 切换侧边栏折叠状态
+         */
+        TOGGLE_SIDEBAR_COLLAPSED: () => void;
+        /**
+         * 重置
+         */
+        RESET: () => void;
+    }) | ((state: Omit<LayoutConfigStore, "SET_STATE" | "ADD_TAB" | "REMOVE_TAB" | "SET_ACTIVE_TAB_KEY" | "CLEAR_TABS" | "SET_LOADING" | "HIDE_LOADING" | "CLEAR_LOADING_TIMER" | "SET_SIDEBAR_COLLAPSED" | "TOGGLE_SIDEBAR_COLLAPSED" | "RESET"> & {
+        SET_STATE: (data: Update) => unknown;
+        /**
+         * 添加标签页
+         */
+        ADD_TAB: (tab: TabItem) => void;
+        /**
+         * 移除标签页
+         */
+        REMOVE_TAB: (key: string) => TabItem;
+        /**
+         * 设置当前激活的标签页
+         */
+        SET_ACTIVE_TAB_KEY: (key: string) => void;
+        /**
+         * 清空所有标签页
+         */
+        CLEAR_TABS: () => void;
+        /**
+         * 设置loading配置
+         */
+        SET_LOADING: (config?: AxiosRequestConfig) => void;
+        /**
+         * 取消loading
+         */
+        HIDE_LOADING: (config?: AxiosRequestConfig) => void;
+        /**
+         * 清除loading定时器
+         */
+        CLEAR_LOADING_TIMER(): void;
+        /**
+         * 设置侧边栏折叠状态
+         */
+        SET_SIDEBAR_COLLAPSED: (collapsed: boolean) => void;
+        /**
+         * 切换侧边栏折叠状态
+         */
+        TOGGLE_SIDEBAR_COLLAPSED: () => void;
+        /**
+         * 重置
+         */
+        RESET: () => void;
+    }) => Omit<LayoutConfigStore, "SET_STATE" | "ADD_TAB" | "REMOVE_TAB" | "SET_ACTIVE_TAB_KEY" | "CLEAR_TABS" | "SET_LOADING" | "HIDE_LOADING" | "CLEAR_LOADING_TIMER" | "SET_SIDEBAR_COLLAPSED" | "TOGGLE_SIDEBAR_COLLAPSED" | "RESET"> & {
+        SET_STATE: (data: Update) => unknown;
+        /**
+         * 添加标签页
+         */
+        ADD_TAB: (tab: TabItem) => void;
+        /**
+         * 移除标签页
+         */
+        REMOVE_TAB: (key: string) => TabItem;
+        /**
+         * 设置当前激活的标签页
+         */
+        SET_ACTIVE_TAB_KEY: (key: string) => void;
+        /**
+         * 清空所有标签页
+         */
+        CLEAR_TABS: () => void;
+        /**
+         * 设置loading配置
+         */
+        SET_LOADING: (config?: AxiosRequestConfig) => void;
+        /**
+         * 取消loading
+         */
+        HIDE_LOADING: (config?: AxiosRequestConfig) => void;
+        /**
+         * 清除loading定时器
+         */
+        CLEAR_LOADING_TIMER(): void;
+        /**
+         * 设置侧边栏折叠状态
+         */
+        SET_SIDEBAR_COLLAPSED: (collapsed: boolean) => void;
+        /**
+         * 切换侧边栏折叠状态
+         */
+        TOGGLE_SIDEBAR_COLLAPSED: () => void;
+        /**
+         * 重置
+         */
+        RESET: () => void;
+    }), replace: true): unknown;
+    persist: {
+        setOptions: (options: Partial<import('zustand/middleware').PersistOptions<Omit<LayoutConfigStore, "SET_STATE" | "ADD_TAB" | "REMOVE_TAB" | "SET_ACTIVE_TAB_KEY" | "CLEAR_TABS" | "SET_LOADING" | "HIDE_LOADING" | "CLEAR_LOADING_TIMER" | "SET_SIDEBAR_COLLAPSED" | "TOGGLE_SIDEBAR_COLLAPSED" | "RESET"> & {
+            SET_STATE: (data: Update) => unknown;
+            /**
+             * 添加标签页
+             */
+            ADD_TAB: (tab: TabItem) => void;
+            /**
+             * 移除标签页
+             */
+            REMOVE_TAB: (key: string) => TabItem;
+            /**
+             * 设置当前激活的标签页
+             */
+            SET_ACTIVE_TAB_KEY: (key: string) => void;
+            /**
+             * 清空所有标签页
+             */
+            CLEAR_TABS: () => void;
+            /**
+             * 设置loading配置
+             */
+            SET_LOADING: (config?: AxiosRequestConfig) => void;
+            /**
+             * 取消loading
+             */
+            HIDE_LOADING: (config?: AxiosRequestConfig) => void;
+            /**
+             * 清除loading定时器
+             */
+            CLEAR_LOADING_TIMER(): void;
+            /**
+             * 设置侧边栏折叠状态
+             */
+            SET_SIDEBAR_COLLAPSED: (collapsed: boolean) => void;
+            /**
+             * 切换侧边栏折叠状态
+             */
+            TOGGLE_SIDEBAR_COLLAPSED: () => void;
+            /**
+             * 重置
+             */
+            RESET: () => void;
+        }, unknown, unknown>>) => void;
+        clearStorage: () => void;
+        rehydrate: () => Promise<void> | void;
+        hasHydrated: () => boolean;
+        onHydrate: (fn: (state: Omit<LayoutConfigStore, "SET_STATE" | "ADD_TAB" | "REMOVE_TAB" | "SET_ACTIVE_TAB_KEY" | "CLEAR_TABS" | "SET_LOADING" | "HIDE_LOADING" | "CLEAR_LOADING_TIMER" | "SET_SIDEBAR_COLLAPSED" | "TOGGLE_SIDEBAR_COLLAPSED" | "RESET"> & {
+            SET_STATE: (data: Update) => unknown;
+            /**
+             * 添加标签页
+             */
+            ADD_TAB: (tab: TabItem) => void;
+            /**
+             * 移除标签页
+             */
+            REMOVE_TAB: (key: string) => TabItem;
+            /**
+             * 设置当前激活的标签页
+             */
+            SET_ACTIVE_TAB_KEY: (key: string) => void;
+            /**
+             * 清空所有标签页
+             */
+            CLEAR_TABS: () => void;
+            /**
+             * 设置loading配置
+             */
+            SET_LOADING: (config?: AxiosRequestConfig) => void;
+            /**
+             * 取消loading
+             */
+            HIDE_LOADING: (config?: AxiosRequestConfig) => void;
+            /**
+             * 清除loading定时器
+             */
+            CLEAR_LOADING_TIMER(): void;
+            /**
+             * 设置侧边栏折叠状态
+             */
+            SET_SIDEBAR_COLLAPSED: (collapsed: boolean) => void;
+            /**
+             * 切换侧边栏折叠状态
+             */
+            TOGGLE_SIDEBAR_COLLAPSED: () => void;
+            /**
+             * 重置
+             */
+            RESET: () => void;
+        }) => void) => () => void;
+        onFinishHydration: (fn: (state: Omit<LayoutConfigStore, "SET_STATE" | "ADD_TAB" | "REMOVE_TAB" | "SET_ACTIVE_TAB_KEY" | "CLEAR_TABS" | "SET_LOADING" | "HIDE_LOADING" | "CLEAR_LOADING_TIMER" | "SET_SIDEBAR_COLLAPSED" | "TOGGLE_SIDEBAR_COLLAPSED" | "RESET"> & {
+            SET_STATE: (data: Update) => unknown;
+            /**
+             * 添加标签页
+             */
+            ADD_TAB: (tab: TabItem) => void;
+            /**
+             * 移除标签页
+             */
+            REMOVE_TAB: (key: string) => TabItem;
+            /**
+             * 设置当前激活的标签页
+             */
+            SET_ACTIVE_TAB_KEY: (key: string) => void;
+            /**
+             * 清空所有标签页
+             */
+            CLEAR_TABS: () => void;
+            /**
+             * 设置loading配置
+             */
+            SET_LOADING: (config?: AxiosRequestConfig) => void;
+            /**
+             * 取消loading
+             */
+            HIDE_LOADING: (config?: AxiosRequestConfig) => void;
+            /**
+             * 清除loading定时器
+             */
+            CLEAR_LOADING_TIMER(): void;
+            /**
+             * 设置侧边栏折叠状态
+             */
+            SET_SIDEBAR_COLLAPSED: (collapsed: boolean) => void;
+            /**
+             * 切换侧边栏折叠状态
+             */
+            TOGGLE_SIDEBAR_COLLAPSED: () => void;
+            /**
+             * 重置
+             */
+            RESET: () => void;
+        }) => void) => () => void;
+        getOptions: () => Partial<import('zustand/middleware').PersistOptions<Omit<LayoutConfigStore, "SET_STATE" | "ADD_TAB" | "REMOVE_TAB" | "SET_ACTIVE_TAB_KEY" | "CLEAR_TABS" | "SET_LOADING" | "HIDE_LOADING" | "CLEAR_LOADING_TIMER" | "SET_SIDEBAR_COLLAPSED" | "TOGGLE_SIDEBAR_COLLAPSED" | "RESET"> & {
+            SET_STATE: (data: Update) => unknown;
+            /**
+             * 添加标签页
+             */
+            ADD_TAB: (tab: TabItem) => void;
+            /**
+             * 移除标签页
+             */
+            REMOVE_TAB: (key: string) => TabItem;
+            /**
+             * 设置当前激活的标签页
+             */
+            SET_ACTIVE_TAB_KEY: (key: string) => void;
+            /**
+             * 清空所有标签页
+             */
+            CLEAR_TABS: () => void;
+            /**
+             * 设置loading配置
+             */
+            SET_LOADING: (config?: AxiosRequestConfig) => void;
+            /**
+             * 取消loading
+             */
+            HIDE_LOADING: (config?: AxiosRequestConfig) => void;
+            /**
+             * 清除loading定时器
+             */
+            CLEAR_LOADING_TIMER(): void;
+            /**
+             * 设置侧边栏折叠状态
+             */
+            SET_SIDEBAR_COLLAPSED: (collapsed: boolean) => void;
+            /**
+             * 切换侧边栏折叠状态
+             */
+            TOGGLE_SIDEBAR_COLLAPSED: () => void;
+            /**
+             * 重置
+             */
+            RESET: () => void;
+        }, unknown, unknown>>;
+    };
+}>;
+export {};