UNPKG

@intility/bifrost-react

Version:

React library for Intility's design system, Bifrost.

40 lines (39 loc) 1.33 kB
import { type NavTopProps } from "./Nav.Top.js"; import { type NavSideProps } from "./Nav.Side.js"; import { type NavMobileProps } from "./Nav.Mobile.js"; import type { PropsFor } from "../../types.js"; export type NavProps = PropsFor<"main", { /** Top nav content */ top?: React.ReactNode; /** Top bar props */ topProps?: Partial<Omit<NavTopProps, "children">>; /** Side nav content */ side?: React.ReactNode; /** Side nav props */ sideProps?: Partial<Omit<NavSideProps, "children">>; /** Mobile fullscreen nav content (optional, defaults to side content) */ mobile?: React.ReactNode; /** Mobile nav props */ mobileProps?: Omit<NavMobileProps, "children">; /** * Custom logo, overrides `appName`, `logoHref`, and `logoOnClick` * @example * logo="App Name" * @example * logo={ * <a href="/" className="bf-neutral-link"> * <Nav.Logo logo="logo.svg"> * App Name * </Nav.Logo> * </a> * } */ logo: React.ReactNode; /** Hide "an intility service" in bottom of sidebar */ hideBranding?: boolean; }>; /** * Responsive component for Bifrost navigation menus */ declare const Nav: import("react").ForwardRefExoticComponent<NavProps & import("react").RefAttributes<HTMLElement>>; export default Nav;