@intility/bifrost-react
Version:
React library for Intility's design system, Bifrost.
39 lines (38 loc) • 1.12 kB
TypeScript
import type { PropsFor } from "../../types.js";
export type MenuProps = PropsFor<"div", {
/** Apply a horizontal (inline) layout for child elements. */
horizontal?: boolean;
}>;
/**
* Optional wrapper for menu items. Simple flex container with `8px` gap (no
* background or other styling).
* @example
* // basic (vertical) menu
* <Menu>
* <a href="/"><Menu.Item>Home</Menu.Item></a>
* <a href="/profile"><Menu.Item>Profile</Menu.Item></a>
* <a href="/applications"><Menu.Item>Applications</Menu.Item></a>
* </Menu>
* @example
* // horizontal (inline) menu with step icons
* <Menu horizontal>
* <a href="/step1">
* <Menu.Item>
* <Icon.Step variant="completed" marginRight />
* Step 1
* </Menu.Item>
* </a>
* <a href="/step2" class="active" >
* <Menu.Item>
* <Icon.Step variant="active" marginRight />
* Step 1
* </Menu.Item>
* </a>
* [more steps...]
* </Menu>
*/
declare const Menu: {
({ horizontal, className, ...props }: MenuProps): import("react/jsx-runtime").JSX.Element;
displayName: string;
};
export default Menu;