@arco-design/web-vue/es/layout/index.d.ts

Arco Design Vue 2.0: A Vue.js 3 UI Library

import type { App } from 'vue';
import type { ArcoOptions } from '../_utils/types';
import _Layout from './layout';
import _LayoutHeader from './header';
import _LayoutContent from './content';
import _LayoutFooter from './footer';
import _LayoutSider from './sider';
declare const Layout: {
    new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("vue").ExtractPropTypes<{
        hasSider: {
            type: BooleanConstructor;
        };
    }>> & Readonly<{}>, {
        classNames: import("vue").ComputedRef<(string | {
            [x: string]: number | true;
        })[]>;
    }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, import("vue").PublicProps, {
        hasSider: boolean;
    }, true, {}, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, {}, any, import("vue").ComponentProvideOptions, {
        P: {};
        B: {};
        D: {};
        C: {};
        M: {};
        Defaults: {};
    }, Readonly<import("vue").ExtractPropTypes<{
        hasSider: {
            type: BooleanConstructor;
        };
    }>> & Readonly<{}>, {
        classNames: import("vue").ComputedRef<(string | {
            [x: string]: number | true;
        })[]>;
    }, {}, {}, {}, {
        hasSider: boolean;
    }>;
    __isFragment?: undefined;
    __isTeleport?: undefined;
    __isSuspense?: undefined;
} & import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
    hasSider: {
        type: BooleanConstructor;
    };
}>> & Readonly<{}>, {
    classNames: import("vue").ComputedRef<(string | {
        [x: string]: number | true;
    })[]>;
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {
    hasSider: boolean;
}, {}, string, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, import("vue").ComponentProvideOptions> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & {
    Header: import("vue").DefineComponent<{}, {
        classNames: string[];
    }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
    Content: import("vue").DefineComponent<{}, {
        classNames: string[];
    }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
    Footer: import("vue").DefineComponent<{}, {
        classNames: string[];
    }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
    Sider: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
        theme: {
            type: import("vue").PropType<"dark" | "light">;
            default: string;
        };
        collapsed: {
            type: BooleanConstructor;
            default: undefined;
        };
        defaultCollapsed: {
            type: BooleanConstructor;
        };
        collapsible: {
            type: BooleanConstructor;
        };
        width: {
            type: NumberConstructor;
            default: number;
        };
        collapsedWidth: {
            type: NumberConstructor;
            default: number;
        };
        reverseArrow: {
            type: BooleanConstructor;
        };
        breakpoint: {
            type: import("vue").PropType<"xxl" | "xl" | "lg" | "md" | "sm" | "xs">;
        };
        resizeDirections: {
            type: import("vue").PropType<("top" | "bottom" | "left" | "right")[]>;
            default: undefined;
        };
        hideTrigger: {
            type: BooleanConstructor;
        };
    }>, {
        componentTag: import("vue").ComputedRef<"div" | "ResizeBox">;
        prefixCls: string;
        classNames: import("vue").ComputedRef<(string | {
            [x: string]: boolean | undefined;
        })[]>;
        triggerClassNames: import("vue").ComputedRef<(string | {
            [x: string]: boolean;
        })[]>;
        localCollapsed: import("vue").ComputedRef<boolean>;
        siderWidth: import("vue").ComputedRef<string>;
        showTrigger: import("vue").ComputedRef<boolean>;
        toggleTrigger: () => void;
    }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("collapse" | "update:collapsed" | "breakpoint")[], "collapse" | "update:collapsed" | "breakpoint", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
        theme: {
            type: import("vue").PropType<"dark" | "light">;
            default: string;
        };
        collapsed: {
            type: BooleanConstructor;
            default: undefined;
        };
        defaultCollapsed: {
            type: BooleanConstructor;
        };
        collapsible: {
            type: BooleanConstructor;
        };
        width: {
            type: NumberConstructor;
            default: number;
        };
        collapsedWidth: {
            type: NumberConstructor;
            default: number;
        };
        reverseArrow: {
            type: BooleanConstructor;
        };
        breakpoint: {
            type: import("vue").PropType<"xxl" | "xl" | "lg" | "md" | "sm" | "xs">;
        };
        resizeDirections: {
            type: import("vue").PropType<("top" | "bottom" | "left" | "right")[]>;
            default: undefined;
        };
        hideTrigger: {
            type: BooleanConstructor;
        };
    }>> & Readonly<{
        onCollapse?: ((...args: any[]) => any) | undefined;
        "onUpdate:collapsed"?: ((...args: any[]) => any) | undefined;
        onBreakpoint?: ((...args: any[]) => any) | undefined;
    }>, {
        width: number;
        collapsed: boolean;
        theme: "dark" | "light";
        defaultCollapsed: boolean;
        collapsible: boolean;
        collapsedWidth: number;
        reverseArrow: boolean;
        resizeDirections: ("top" | "bottom" | "left" | "right")[];
        hideTrigger: boolean;
    }, {}, {
        IconLeft: any;
        IconRight: any;
        ResizeBox: {
            new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("vue").ExtractPropTypes<{
                width: {
                    type: NumberConstructor;
                };
                height: {
                    type: NumberConstructor;
                };
                component: {
                    type: StringConstructor;
                    default: string;
                };
                directions: {
                    type: import("vue").PropType<("top" | "bottom" | "left" | "right")[]>;
                    default: () => string[];
                };
            }>> & Readonly<{
                "onUpdate:width"?: ((width: number) => any) | undefined;
                "onUpdate:height"?: ((height: number) => any) | undefined;
                onMovingStart?: ((ev: MouseEvent) => any) | undefined;
                onMoving?: ((size: {
                    width: number;
                    height: number;
                }, ev: MouseEvent) => any) | undefined;
                onMovingEnd?: ((ev: MouseEvent) => any) | undefined;
            }>, {
                prefixCls: string;
                classNames: import("vue").ComputedRef<string[]>;
                styles: import("vue").ComputedRef<{
                    "padding-left"?: string | undefined;
                    "padding-right"?: string | undefined;
                    "padding-top"?: string | undefined;
                    "padding-bottom"?: string | undefined;
                    height?: string | undefined;
                    width?: string | undefined;
                }>;
                wrapperRef: import("vue").Ref<HTMLDivElement | undefined, HTMLDivElement | undefined>;
                onMoveStart: (direction: import("../resize-box/resize-box").DirectionType, e: MouseEvent) => void;
                isHorizontal: (direction: import("../resize-box/resize-box").DirectionType) => boolean;
                allowDirections: import("vue").ComputedRef<("top" | "bottom" | "left" | "right")[]>;
                onTiggerResize: (direction: import("../resize-box/resize-box").DirectionType, entry: ResizeObserverEntry) => void;
            }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
                'update:width': (width: number) => true;
                'update:height': (height: number) => true;
                movingStart: (ev: MouseEvent) => true;
                moving: (size: {
                    width: number;
                    height: number;
                }, ev: MouseEvent) => true;
                movingEnd: (ev: MouseEvent) => true;
            }, import("vue").PublicProps, {
                component: string;
                directions: ("top" | "bottom" | "left" | "right")[];
            }, true, {}, {}, {
                ResizeTrigger: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
                    prefixCls: {
                        type: StringConstructor;
                        required: true;
                    };
                    direction: {
                        type: import("vue").PropType<"horizontal" | "vertical">;
                        default: string;
                    };
                }>, {
                    classNames: import("vue").ComputedRef<(string | {
                        [x: string]: boolean;
                    })[]>;
                    onResize: (entry: ResizeObserverEntry) => void;
                    isHorizontal: import("vue").ComputedRef<boolean>;
                }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "resize"[], "resize", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
                    prefixCls: {
                        type: StringConstructor;
                        required: true;
                    };
                    direction: {
                        type: import("vue").PropType<"horizontal" | "vertical">;
                        default: string;
                    };
                }>> & Readonly<{
                    onResize?: ((...args: any[]) => any) | undefined;
                }>, {
                    direction: "horizontal" | "vertical";
                }, {}, {
                    ResizeObserver: import("vue").DefineComponent<{}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
                        [key: string]: any;
                    }> | null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "resize"[], "resize", import("vue").PublicProps, Readonly<{}> & Readonly<{
                        onResize?: ((...args: any[]) => any) | undefined;
                    }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
                    IconDragDot: any;
                    IconDragDotVertical: any;
                }, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
            } & import("vue").GlobalComponents, import("vue").GlobalDirectives, string, {}, any, import("vue").ComponentProvideOptions, {
                P: {};
                B: {};
                D: {};
                C: {};
                M: {};
                Defaults: {};
            }, Readonly<import("vue").ExtractPropTypes<{
                width: {
                    type: NumberConstructor;
                };
                height: {
                    type: NumberConstructor;
                };
                component: {
                    type: StringConstructor;
                    default: string;
                };
                directions: {
                    type: import("vue").PropType<("top" | "bottom" | "left" | "right")[]>;
                    default: () => string[];
                };
            }>> & Readonly<{
                "onUpdate:width"?: ((width: number) => any) | undefined;
                "onUpdate:height"?: ((height: number) => any) | undefined;
                onMovingStart?: ((ev: MouseEvent) => any) | undefined;
                onMoving?: ((size: {
                    width: number;
                    height: number;
                }, ev: MouseEvent) => any) | undefined;
                onMovingEnd?: ((ev: MouseEvent) => any) | undefined;
            }>, {
                prefixCls: string;
                classNames: import("vue").ComputedRef<string[]>;
                styles: import("vue").ComputedRef<{
                    "padding-left"?: string | undefined;
                    "padding-right"?: string | undefined;
                    "padding-top"?: string | undefined;
                    "padding-bottom"?: string | undefined;
                    height?: string | undefined;
                    width?: string | undefined;
                }>;
                wrapperRef: import("vue").Ref<HTMLDivElement | undefined, HTMLDivElement | undefined>;
                onMoveStart: (direction: import("../resize-box/resize-box").DirectionType, e: MouseEvent) => void;
                isHorizontal: (direction: import("../resize-box/resize-box").DirectionType) => boolean;
                allowDirections: import("vue").ComputedRef<("top" | "bottom" | "left" | "right")[]>;
                onTiggerResize: (direction: import("../resize-box/resize-box").DirectionType, entry: ResizeObserverEntry) => void;
            }, {}, {}, {}, {
                component: string;
                directions: ("top" | "bottom" | "left" | "right")[];
            }>;
            __isFragment?: undefined;
            __isTeleport?: undefined;
            __isSuspense?: undefined;
        } & import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
            width: {
                type: NumberConstructor;
            };
            height: {
                type: NumberConstructor;
            };
            component: {
                type: StringConstructor;
                default: string;
            };
            directions: {
                type: import("vue").PropType<("top" | "bottom" | "left" | "right")[]>;
                default: () => string[];
            };
        }>> & Readonly<{
            "onUpdate:width"?: ((width: number) => any) | undefined;
            "onUpdate:height"?: ((height: number) => any) | undefined;
            onMovingStart?: ((ev: MouseEvent) => any) | undefined;
            onMoving?: ((size: {
                width: number;
                height: number;
            }, ev: MouseEvent) => any) | undefined;
            onMovingEnd?: ((ev: MouseEvent) => any) | undefined;
        }>, {
            prefixCls: string;
            classNames: import("vue").ComputedRef<string[]>;
            styles: import("vue").ComputedRef<{
                "padding-left"?: string | undefined;
                "padding-right"?: string | undefined;
                "padding-top"?: string | undefined;
                "padding-bottom"?: string | undefined;
                height?: string | undefined;
                width?: string | undefined;
            }>;
            wrapperRef: import("vue").Ref<HTMLDivElement | undefined, HTMLDivElement | undefined>;
            onMoveStart: (direction: import("../resize-box/resize-box").DirectionType, e: MouseEvent) => void;
            isHorizontal: (direction: import("../resize-box/resize-box").DirectionType) => boolean;
            allowDirections: import("vue").ComputedRef<("top" | "bottom" | "left" | "right")[]>;
            onTiggerResize: (direction: import("../resize-box/resize-box").DirectionType, entry: ResizeObserverEntry) => void;
        }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
            'update:width': (width: number) => true;
            'update:height': (height: number) => true;
            movingStart: (ev: MouseEvent) => true;
            moving: (size: {
                width: number;
                height: number;
            }, ev: MouseEvent) => true;
            movingEnd: (ev: MouseEvent) => true;
        }, string, {
            component: string;
            directions: ("top" | "bottom" | "left" | "right")[];
        }, {}, string, {}, {
            ResizeTrigger: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
                prefixCls: {
                    type: StringConstructor;
                    required: true;
                };
                direction: {
                    type: import("vue").PropType<"horizontal" | "vertical">;
                    default: string;
                };
            }>, {
                classNames: import("vue").ComputedRef<(string | {
                    [x: string]: boolean;
                })[]>;
                onResize: (entry: ResizeObserverEntry) => void;
                isHorizontal: import("vue").ComputedRef<boolean>;
            }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "resize"[], "resize", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
                prefixCls: {
                    type: StringConstructor;
                    required: true;
                };
                direction: {
                    type: import("vue").PropType<"horizontal" | "vertical">;
                    default: string;
                };
            }>> & Readonly<{
                onResize?: ((...args: any[]) => any) | undefined;
            }>, {
                direction: "horizontal" | "vertical";
            }, {}, {
                ResizeObserver: import("vue").DefineComponent<{}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
                    [key: string]: any;
                }> | null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "resize"[], "resize", import("vue").PublicProps, Readonly<{}> & Readonly<{
                    onResize?: ((...args: any[]) => any) | undefined;
                }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
                IconDragDot: any;
                IconDragDotVertical: any;
            }, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
        } & import("vue").GlobalComponents, import("vue").GlobalDirectives, string, import("vue").ComponentProvideOptions> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & {
            install: (app: App<any>, options?: ArcoOptions | undefined) => void;
        };
    }, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
    install: (app: App, options?: ArcoOptions | undefined) => void;
};
export declare type LayoutInstance = InstanceType<typeof _Layout>;
export declare type LayoutHeaderInstance = InstanceType<typeof _LayoutHeader>;
export declare type LayoutContentInstance = InstanceType<typeof _LayoutContent>;
export declare type LayoutFooterInstance = InstanceType<typeof _LayoutFooter>;
export declare type LayoutSiderInstance = InstanceType<typeof _LayoutSider>;
export type { LayoutProps, SiderProps } from './interface';
export { _LayoutHeader as LayoutHeader, _LayoutContent as LayoutContent, _LayoutFooter as LayoutFooter, _LayoutSider as LayoutSider, };
export default Layout;