@eds/app-layout
v4.0.2
AppLayout
A component for building consistent application layouts.Prop | Required | Description | Type |
---|---|---|---|
banner | — | Banner component for imporant messages. | string | number | false | true | ReactElement<any, string | JSXElementConstructor<any>> | ReactPortal | { key?: string | number; ref?: null; props?: { children?: boolean | ReactChild | ReactPortal | StrictReactFragment; }; } | (boolean | ReactChild | ReactPortal | StrictReactFragment)[] |
compactBreakpoint | — | Sets the threshold for entering the compact state. Defaults to xlarge. | "xsmall" | "small" | "medium" | "large" | "xlarge" |
sideNavigation | — | Specific container for the menu, repositioned at the top on compact state. | string | number | false | true | ReactElement<any, string | JSXElementConstructor<any>> | ReactPortal | { key?: string | number; ref?: null; props?: { children?: boolean | ReactChild | ReactPortal | StrictReactFragment; }; } | (boolean | ReactChild | ReactPortal | StrictReactFragment)[] |
topNavigation | — | Specific container for the top navigation, hidden on compact state. | string | number | false | true | ReactElement<any, string | JSXElementConstructor<any>> | ReactPortal | { key?: string | number; ref?: null; props?: { children?: boolean | ReactChild | ReactPortal | StrictReactFragment; }; } | (boolean | ReactChild | ReactPortal | StrictReactFragment)[] |
Prop | Required | Description | Type |
---|---|---|---|
align | — | Alignment of the content. Defaults to start. | "start" | "center" |
header | — | Header of the page, usually the PageHeader component. | string | number | false | true | ReactElement<any, string | JSXElementConstructor<any>> | ReactPortal | { key?: string | number; ref?: null; props?: { children?: boolean | ReactChild | ReactPortal | StrictReactFragment; }; } | (boolean | ReactChild | ReactPortal | StrictReactFragment)[] |
size | — | Sets the content size. | "small" | "medium" | "large" |
stickyHeader | — | Sets the sticky behavior of the header. Defaults to false | boolean |