@gx-design-vue/pro-layout 0.1.0-beta.60 → 0.1.0-beta.61

package/dist/props.d.ts

@@ -0,0 +1,291 @@
+import type { CSSProperties, PropType } from 'vue';
+import type { DeepPartial, ProAliasToken } from '@gx-design-vue/pro-provider';
+import type { AppRouteModule } from './route';
+import type { BreadcrumbProps } from './Context';
+import type { CopyrightRender, FooterRender } from './RenderTypings';
+import type { Links } from './components/GlobalFooter';
+export declare const basicLayoutProps: {
+    pure: BooleanConstructor;
+    token: PropType<DeepPartial<ProAliasToken>>;
+    waterMark: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * 是否禁用移动端模式，有的管理系统不需要移动端模式，此属性设置为true即可
+     */
+    disableMobile: {
+        type: BooleanConstructor;
+        required: boolean;
+    };
+    contentStyle: {
+        type: PropType<CSSProperties>;
+        default: () => null;
+    };
+    breadcrumb: PropType<BreadcrumbProps>;
+    disableContentMargin: import("vue-types").VueTypeValidableDef<boolean>;
+    isChildrenLayout: import("vue-types").VueTypeValidableDef<boolean>;
+    loading: import("vue-types").VueTypeValidableDef<boolean>;
+    footerLinks: {
+        type: PropType<Links>;
+        default: ({
+            key: string;
+            title: string;
+            href: string;
+            blankTarget: boolean;
+        } | {
+            key: string;
+            title: JSX.Element;
+            href: string;
+            blankTarget: boolean;
+        })[];
+    };
+    copyrightRender: {
+        type: PropType<CopyrightRender>;
+        default: () => undefined;
+    };
+    footerRender: {
+        type: PropType<FooterRender>;
+        default: () => undefined;
+    };
+    menuData: {
+        type: PropType<AppRouteModule[]>;
+        default: () => AppRouteModule[];
+    };
+    levelMenuData: {
+        type: PropType<AppRouteModule[]>;
+        default: () => AppRouteModule[];
+    };
+    collapsed: import("vue-types").VueTypeValidableDef<boolean>;
+    usePageCard: {
+        type: PropType<boolean>;
+        default: () => undefined;
+    };
+    pageCardProps: PropType<{
+        loading?: boolean;
+        bodyStyle: CSSProperties;
+    }>;
+    pageContentStyle: import("vue-types").VueTypeValidableDef<CSSProperties>;
+    pageChildrenContentStyle: import("vue-types").VueTypeValidableDef<CSSProperties>;
+    waterMarkProps: {
+        type: PropType<import("@gx-design-vue/pro-watermark/dist").WaterMarkProps>;
+    };
+    pageHeaderRender: {
+        type: PropType<import("./RenderTypings").DefaultPropRender>;
+        default: () => undefined;
+    };
+    pageChildrenExtraRender: {
+        type: PropType<() => import("@gx-design-vue/pro-utils/dist").CustomRender>;
+        default: () => undefined;
+    };
+    contentRender: {
+        type: PropType<import("@gx-design-vue/pro-utils/dist").WithFalse<() => import("@gx-design-vue/pro-utils/dist").CustomRender>>;
+        default: () => undefined;
+    };
+    breadcrumbRender: {
+        type: PropType<import("./RenderTypings").PageHeaderRender>;
+        default: () => undefined;
+    };
+    pageHeaderStyle: import("vue-types").VueTypeValidableDef<CSSProperties>;
+    isMobile: import("vue-types").VueTypeValidableDef<boolean>;
+    siderWidth: import("vue-types").VueTypeValidableDef<number> & {
+        default: number;
+    } & {
+        default: number;
+    };
+    collapsedWidth: import("vue-types").VueTypeValidableDef<number> & {
+        default: number;
+    } & {
+        default: number;
+    };
+    isFixedMultiTab: {
+        type: PropType<import("@gx-design-vue/pro-provider/dist").ThemeConfig["fixedMultiTab"]>;
+        default: boolean;
+    };
+    onReloadPage: {
+        type: PropType<() => void>;
+    };
+    onChangeTabs: {
+        type: PropType<(list: AppRouteModule[]) => void>;
+    };
+    'onUpdate:tabs': {
+        type: PropType<(list: AppRouteModule[]) => void>;
+    };
+    headerTitleRender: {
+        type: PropType<import("@gx-design-vue/pro-utils/dist").WithFalse<(props: any, defaultDom: import("@gx-design-vue/pro-utils/dist").CustomRender) => import("@gx-design-vue/pro-utils/dist").CustomRender>>;
+        default: () => undefined;
+    };
+    headerRender: {
+        type: PropType<import("@gx-design-vue/pro-utils/dist").WithFalse<(props: any, defaultDom: import("@gx-design-vue/pro-utils/dist").CustomRender, logoDom?: import("./RenderTypings").LogoRender) => import("@gx-design-vue/pro-utils/dist").CustomRender>>;
+        default: () => undefined;
+    };
+    headerContentRender: {
+        type: PropType<import("@gx-design-vue/pro-utils/dist").WithFalse<(props: any) => import("@gx-design-vue/pro-utils/dist").CustomRender>>;
+        default: () => undefined;
+    };
+    hasSiderMenu: PropType<boolean>;
+    logo: {
+        type: PropType<import("@gx-design-vue/pro-utils/dist").CustomRender>;
+        default: () => undefined;
+    };
+    logoStyle: {
+        type: PropType<CSSProperties>;
+        default: () => undefined;
+    };
+    logoDirection: {
+        type: PropType<"horizontal" | "vertical">;
+        default: string;
+    };
+    menuLoading: PropType<boolean>;
+    autoHideHeader: PropType<boolean>;
+    headerTheme: {
+        type: PropType<import("@gx-design-vue/pro-provider/dist").ThemeType>;
+        default: string;
+    };
+    menuRender: {
+        type: PropType<import("@gx-design-vue/pro-utils/dist").WithFalse<(props: any, defaultDom: import("@gx-design-vue/pro-utils/dist").CustomRender) => import("@gx-design-vue/pro-utils/dist").CustomRender>>;
+        default: () => undefined;
+    };
+    extraRightDropdownRender: {
+        type: PropType<import("./RenderTypings").ExtraRightDropdownRender>;
+        default: () => undefined;
+    };
+    rightContentRender: {
+        type: PropType<import("./RenderTypings").RightContentRender>;
+        default: () => undefined;
+    };
+    collapsedButtonRender: {
+        type: PropType<import("@gx-design-vue/pro-utils/dist").WithFalse<(collapsed?: boolean) => import("@gx-design-vue/pro-utils/dist").CustomRender>>;
+        default: () => undefined;
+    };
+    matchMenuKeys: {
+        type: PropType<string[]>;
+        default: () => never[];
+    };
+    onCollapse: {
+        type: PropType<(collapsed: boolean) => void>;
+    };
+    onOpenKeys: {
+        type: PropType<(openKeys: string[]) => void>;
+    };
+    onMenuHeaderClick: PropType<Function>;
+    onSelect: {
+        type: PropType<(selectedKeys: string[]) => void>;
+    };
+    mode: {
+        type: PropType<import("ant-design-vue").MenuMode>;
+        default: string;
+    };
+    theme: {
+        type: PropType<import("@gx-design-vue/pro-provider/dist").MenuTheme>;
+        default: string;
+    };
+    layout: {
+        type: PropType<import("@gx-design-vue/pro-provider/dist").ThemeConfig["layout"]>;
+        default: string;
+    };
+    openKeys: {
+        type: PropType<string[] | boolean>;
+        default: () => never[];
+    };
+    selectedKeys: {
+        type: PropType<string[]>;
+        default: () => never[];
+    };
+    menuProps: {
+        type: PropType<Record<string, any>>;
+        default: () => null;
+    };
+    menuItemRender: {
+        type: PropType<import("./components/SiderMenu/BaseMenu").CustomMenuRender["menuItemRender"]>;
+        default: () => undefined;
+    };
+    subMenuItemRender: {
+        type: PropType<import("./components/SiderMenu/BaseMenu").CustomMenuRender["subMenuItemRender"]>;
+        default: () => undefined;
+    };
+    onClick: PropType<(...args: any) => void>;
+    wideWidth: {
+        type: PropType<import("@gx-design-vue/pro-provider/dist").ThemeConfig["wideWidth"]>;
+        default: number | undefined;
+    };
+    splitMenus: {
+        type: PropType<import("@gx-design-vue/pro-provider/dist").ThemeConfig["splitMenus"]>;
+        default: boolean;
+    };
+    fixedMultiTab: {
+        type: PropType<import("@gx-design-vue/pro-provider/dist").ThemeConfig["fixedMultiTab"]>;
+        default: boolean;
+    };
+    showProgressBar: {
+        type: PropType<import("@gx-design-vue/pro-provider/dist").ThemeConfig["showProgressBar"]>;
+        default: boolean;
+    };
+    fixedHeader: {
+        type: PropType<import("@gx-design-vue/pro-provider/dist").ThemeConfig["fixedHeader"]>;
+        default: boolean;
+    };
+    fixSiderbar: {
+        type: PropType<import("@gx-design-vue/pro-provider/dist").ThemeConfig["fixSiderbar"]>;
+        default: boolean;
+    };
+    showTabsBar: {
+        type: PropType<import("@gx-design-vue/pro-provider/dist").ThemeConfig["showTabsBar"]>;
+        default: boolean;
+    };
+    showFullScreen: {
+        type: PropType<import("@gx-design-vue/pro-provider/dist").ThemeConfig["showFullScreen"]>;
+        default: boolean | undefined;
+    };
+    headerHeight: {
+        type: PropType<import("@gx-design-vue/pro-provider/dist").ThemeConfig["headerHeight"]>;
+        default: number | undefined;
+    };
+    title: {
+        type: PropType<import("@gx-design-vue/pro-provider/dist").ThemeConfig["title"]>;
+        default: string;
+    };
+    iconfontUrl: {
+        type: PropType<import("@gx-design-vue/pro-provider/dist").ThemeConfig["iconfontUrl"]>;
+        default: string | undefined;
+    };
+    animate: {
+        type: PropType<import("@gx-design-vue/pro-provider/dist").ThemeConfig["animate"]>;
+        default: {
+            disabled?: boolean;
+            name: string;
+            direction: string;
+        } | undefined;
+    };
+    primaryColor: {
+        type: PropType<import("@gx-design-vue/pro-provider/dist").ThemeConfig["primaryColor"]>;
+        default: string;
+    };
+    links: {
+        type: PropType<import("./RenderTypings").LinksRender>;
+        default: () => undefined;
+    };
+    menuHeaderRender: {
+        type: PropType<import("./RenderTypings").HeaderLogoRender>;
+        default: () => undefined;
+    };
+    menuFooterRender: {
+        type: PropType<import("./RenderTypings").MenuFooterRender>;
+        default: () => boolean;
+    };
+    menuContentRender: {
+        type: PropType<import("./RenderTypings").MenuContentRender>;
+        default: () => boolean;
+    };
+    menuExtraRender: {
+        type: PropType<import("./RenderTypings").MenuExtraRender>;
+        default: () => boolean;
+    };
+    breakpoint: {
+        type: PropType<import("./components/SiderMenu/typings").SiderProps["breakpoint"] | false>;
+        default: () => boolean;
+    };
+    onMenuClick: import("vue-types").VueTypeValidableDef<(...args: any[]) => any> & {
+        default: (...args: any[]) => any;
+    };
+};

package/dist/route.d.ts

@@ -0,0 +1,62 @@
+import type { defineComponent } from 'vue';
+import type { RouteRecordRaw } from 'vue-router';
+import type { RecordType } from '@gx-design-vue/pro-utils';
+import { RouteLocation } from 'vue-router';
+export type Component<T = any> = ReturnType<typeof defineComponent> | (() => Promise<typeof import('*.vue')>) | (() => Promise<T>);
+export type AppRouteModule = {
+    meta?: Meta;
+    query?: RecordType;
+    params?: RecordType;
+    fullPath?: string;
+    linkPath?: string;
+    children?: AppRouteModule[];
+    hidden?: boolean;
+    redirect?: string | ((to: RouteLocation) => string);
+    component?: Component;
+} & Omit<RouteRecordRaw, 'meta' | 'children' | 'redirect'>;
+export interface MenuDataItem extends MenuMeta {
+    id?: number;
+    menuId?: number;
+    parentId?: number;
+    createTime?: string;
+    orderNum?: string;
+    name?: string;
+    path?: string;
+    fullPath?: string;
+    target?: string;
+    linkPath?: string;
+    key?: string;
+    redirect?: string;
+    component?: string;
+    hidden?: boolean;
+    meta?: MenuMeta;
+    children?: MenuDataItem[];
+}
+export interface MenuMeta extends Meta {
+    isFrame?: '0' | '1';
+    menuType?: 'M' | 'C' | null;
+    homePageFlag?: 1 | 0;
+    outLinkType?: 0 | 1;
+}
+export interface Meta {
+    key?: string;
+    title?: string;
+    homePage?: 1 | 0;
+    icon?: string;
+    iconType?: number;
+    hidden?: boolean;
+    hideInMenu?: boolean;
+    hideChildrenInMenu?: boolean;
+    targetStatus?: number;
+    target?: string;
+    redirect?: string;
+    tagHidden?: '0' | '1' | boolean;
+    tagFixed?: '0' | '1' | boolean;
+    originTagPath?: string;
+    currenFulltPath?: string;
+    type?: string;
+    disabled?: boolean;
+    danger?: boolean;
+    keepAlive?: boolean;
+    animateDisabled?: boolean;
+}

package/dist/style/index.d.ts

@@ -0,0 +1,14 @@
+import type { GenerateStyle } from 'ant-design-vue/es/theme/internal';
+import type { ProAliasToken } from '@gx-design-vue/pro-provider';
+export interface ProLayoutToken extends ProAliasToken {
+    componentCls: string;
+}
+/**
+ * 主要区别：
+ * 需要手动引入 import 'antd/dist/antd.css';
+ * 需要重置 menu 的样式
+ * @param token
+ * @returns
+ */
+export declare const compatibleStyle: GenerateStyle<ProLayoutToken>;
+export declare const genProLayoutStyle: GenerateStyle<ProLayoutToken>;

package/dist/typings.d.ts

@@ -0,0 +1 @@
+export type ProProps = Record<never, never>;

package/dist/utils/animate.d.ts

@@ -0,0 +1,8 @@
+export interface AnimateConfig {
+    preset: {
+        name: string;
+        alias: string;
+        directions: string[];
+    }[];
+}
+export declare const animateSeting: AnimateConfig;

package/dist/utils/coverToNewToken.d.ts

@@ -0,0 +1,10 @@
+import type { ProAliasToken, ThemeType } from '@gx-design-vue/pro-provider';
+export declare function coverToNewToken({ type, token, theme, staticToken, layoutThemeKey, }: {
+    staticToken: Record<string, string | number | undefined>;
+    token: ProAliasToken;
+    theme: ThemeType;
+    layoutThemeKey: string;
+    type: 'sider' | 'header';
+}): Record<string, string | number | undefined> & {
+    [k: string]: unknown;
+};

package/dist/utils/getMenuData.d.ts

@@ -0,0 +1,9 @@
+import type { RecordType } from '@gx-design-vue/pro-utils';
+import type { AppRouteModule } from '../route';
+export { clearMenuItem, flatMap, getMenuFirstChildren, getMenuFirstLastChildPath, getMatchedList } from '../utils';
+export type MenuData = {
+    menuData: AppRouteModule[];
+    breadcrumb: RecordType;
+    levelMenuData: AppRouteModule[];
+};
+export declare const getMenuData: (routes: AppRouteModule[]) => MenuData;

package/dist/utils/index.d.ts

@@ -0,0 +1,42 @@
+import type { ThemeConfig } from '@gx-design-vue/pro-provider';
+import type { AppRouteModule } from '../route';
+export { default as isUrl } from './isUrl';
+export { default as isImg } from './isImg';
+export * from './coverToNewToken';
+export * from './animate';
+export declare function clearMenuItem(menusData: AppRouteModule[]): AppRouteModule[];
+export declare function flatMap(menusData: AppRouteModule[]): AppRouteModule[];
+export declare function getMenuFirstChildren(menus: AppRouteModule[], key?: string): AppRouteModule[];
+export declare function getMenuFirstLastChildPath(data: AppRouteModule[]): string;
+export declare function getMatchedList(data: AppRouteModule[], path: string): AppRouteModule[];
+export declare function handleThemeConfig(config: ThemeConfig): {
+    theme: import("@gx-design-vue/pro-provider/dist").MenuTheme | undefined;
+    layout: import("@gx-design-vue/pro-provider/dist").ThemeLayout;
+    splitMenus: boolean;
+    fixedMultiTab: boolean;
+    fixedHeader: boolean;
+    fixSiderbar: boolean;
+    showProgressBar: boolean;
+    showTabsBar: boolean;
+    showFullScreen?: boolean;
+    headerHeight?: number;
+    wideWidth?: number;
+    autoHideHeader: boolean;
+    title: string;
+    colorWeak?: boolean;
+    iconfontUrl?: string;
+    animate?: {
+        disabled?: boolean;
+        name: string;
+        direction: string;
+    };
+    primaryColor: string;
+};
+export declare function checkThemeStatus(config: Partial<ThemeConfig>): ThemeConfig;
+export type StringKeyOf<T> = Extract<keyof T, string>;
+/**
+ * Creates an object composed of the picked object properties.
+ * @param obj The source object
+ * @param paths The property paths to pick
+ */
+export declare function pick<T, K extends keyof T>(obj: T, paths: K[]): Pick<T, K>;

package/dist/utils/isImg/index.d.ts

@@ -0,0 +1,3 @@
+/** 判断是否是图片链接 */
+declare function isImg(path: string): boolean;
+export default isImg;

package/dist/utils/isUrl/index.d.ts

@@ -0,0 +1,2 @@
+declare const isUrl: (path: string) => boolean;
+export default isUrl;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gx-design-vue/pro-layout",
-  "version": "0.1.0-beta.60",
+  "version": "0.1.0-beta.61",
   "scripts": {
     "dev": "vite",
     "build": "vite build",