@admin-layout/client 1.0.3-alpha.105

package/lib/interfaces/default-settings.d.ts

@@ -0,0 +1,72 @@
+export declare type ContentWidth = 'Fluid' | 'Fixed';
+export declare type MenuTheme = 'light' | 'dark';
+export interface RenderSetting {
+    headerRender?: false;
+    footerRender?: false;
+    menuRender?: false;
+    menuHeaderRender?: false;
+}
+export interface PureSettings {
+    /**
+     * @name theme for nav menu
+     */
+    navTheme?: MenuTheme | 'realDark' | undefined;
+    /**
+     * @name The color of the top menu, effective in mix mode
+     */
+    headerTheme?: MenuTheme;
+    /**
+     * @name nav menu position: `side` or `top`
+     */
+    headerHeight?: number;
+    /**
+     * @name customize header height
+     */
+    layout?: 'side' | 'top' | 'mix';
+    /**
+     * @name layout of content: `Fluid` or `Fixed`, only works when layout is top
+     */
+    contentWidth?: ContentWidth;
+    /**
+     * @name sticky header
+     */
+    fixedHeader?: boolean;
+    /**
+     * @name sticky siderbar
+     */
+    fixSiderbar?: boolean;
+    /**
+     * @name menu Some related configurations
+     */
+    menu?: {
+        locale?: boolean;
+        defaultOpenAll?: boolean;
+        loading?: boolean;
+    };
+    /**
+     * @name Layout The title will also be displayed on the browser tab
+     * @description Set to false, only pageName is displayed in the layout, not pageName-title
+     */
+    title: string | false;
+    /**
+     * Your custom iconfont Symbol script Url
+     * eg：//at.alicdn.com/t/font_1039637_btcrd5co4w.js
+     * Note: If you need multi-color icons, batch decolorization should be performed in the Iconfont icon project
+     * Usage: https://github.com/ant-design/ant-design-pro/pull/3517
+     */
+    iconfontUrl?: string;
+    /**
+     * @name Main color, need to be used with umi
+     */
+    primaryColor?: string;
+    /**
+     * @name Global increase filter
+     */
+    colorWeak?: boolean;
+    /**
+     * @name Splitting menu
+     * @description Only works in mix mode
+     */
+    splitMenus?: boolean;
+}
+export declare type ProSettings = PureSettings & RenderSetting;