@octopusdeploy/design-system-components
Version:
The design systems component library.
34 lines (33 loc) • 1.4 kB
TypeScript
import React from "react";
import type { BadgeProps } from "../Badge/Badge";
import type { NavigationBarActionData } from "../NavigationBar/NavigationBarActions";
import type { AreaNavListItem, AreaNavListLinkItem } from "./AreaNavList";
import type { SideNavBarTabLink, BottomSideNavBarItem, TopSideNavBarItem } from "./SideNavBar";
export interface GlobalLayoutProps {
topNavBar: {
logo?: React.ReactElement;
searchBar?: React.ReactElement;
banner?: React.ReactElement;
actions?: NavigationBarActionData[];
};
sideNavBar: {
topItems: ReadonlyArray<TopSideNavBarItem>;
bottomItems: ReadonlyArray<BottomSideNavBarItem>;
onLinkClicked?: (item: SideNavBarTabLink) => void;
};
areaNavPanel: {
items: ReadonlyArray<AreaNavListItem>;
title?: string;
badge?: React.ReactElement<BadgeProps>;
displayMode: "overlay" | "inline";
onLinkClicked?: (item: AreaNavListLinkItem) => void;
};
helpPanel: {
isExpanded: boolean;
content: React.ReactElement;
};
children: React.ReactNode;
onSideBarClickAway?: () => void;
scrollAreaRef: React.RefObject<HTMLDivElement>;
}
export declare function GlobalLayout({ topNavBar, sideNavBar, areaNavPanel, onSideBarClickAway, children, scrollAreaRef, helpPanel }: GlobalLayoutProps): import("react/jsx-runtime").JSX.Element;