@arolariu/components/dist/components/ui/navigation-menu.d.ts

🎨 70+ beautiful, accessible React components built on Base UI. TypeScript-first, CSS Modules styling, tree-shakeable, SSR-ready. Perfect for modern web apps, design systems & rapid prototyping. Zero config, maximum flexibility! ⚡

import { NavigationMenu as BaseNavigationMenu } from "@base-ui/react/navigation-menu";
import { useRender } from "@base-ui/react/use-render";
import * as React from "react";
/** Returns the CSS classes used by the navigation menu trigger wrapper. */
export declare function navigationMenuTriggerStyle(className?: string): string;
interface NavigationMenuProps extends Omit<React.ComponentPropsWithRef<typeof BaseNavigationMenu.Root>, "className"> {
    /**
     * Applies additional CSS classes to the component root element.
     * @default undefined
     */
    className?: string;
}
interface NavigationMenuListProps extends Omit<React.ComponentPropsWithRef<typeof BaseNavigationMenu.List>, "className"> {
    /**
     * Applies additional CSS classes to the component root element.
     * @default undefined
     */
    className?: string;
}
interface NavigationMenuTriggerProps extends Omit<React.ComponentPropsWithRef<typeof BaseNavigationMenu.Trigger>, "className"> {
    /**
     * Applies additional CSS classes to the component root element.
     * @default undefined
     */
    className?: string;
}
interface NavigationMenuContentProps extends Omit<React.ComponentPropsWithRef<typeof BaseNavigationMenu.Content>, "className"> {
    /**
     * Applies additional CSS classes to the component root element.
     * @default undefined
     */
    className?: string;
}
interface NavigationMenuLinkProps extends Omit<React.ComponentPropsWithRef<typeof BaseNavigationMenu.Link>, "className"> {
    /**
     * Applies additional CSS classes to the component root element.
     * @default undefined
     */
    className?: string;
}
interface NavigationMenuViewportProps extends Omit<React.ComponentPropsWithRef<typeof BaseNavigationMenu.Viewport>, "className"> {
    /**
     * Applies additional CSS classes to the component root element.
     * @default undefined
     */
    className?: string;
}
interface NavigationMenuIndicatorProps extends React.ComponentPropsWithRef<"div"> {
    /**
     * Applies additional CSS classes to the component root element.
     * @default undefined
     */
    className?: string;
    /**
     * Overrides the default rendered element while preserving component behavior.
     * @default undefined
     */
    render?: useRender.RenderProp<Record<string, never>>;
    /**
     * Enables child element composition instead of rendering the default wrapper.
     * @default false
     * @deprecated Prefer Base UI's `render` prop.
     */
    asChild?: boolean;
}
/**
 * Coordinates navigation menu state and accessibility behavior.
 *
 * @remarks
 * - Renders a `<nav>` element by default
 * - Built on {@link https://base-ui.com/react/components/navigation-menu | Base UI Navigation Menu}
 * - Supports the `render` prop for element composition
 *
 * @example
 * ```tsx
 * <NavigationMenu>Content</NavigationMenu>
 * ```
 *
 * @see {@link https://base-ui.com/react/components/navigation-menu | Base UI Documentation}
 */
declare function NavigationMenu(props: Readonly<NavigationMenu.Props>): React.ReactElement;
declare namespace NavigationMenu {
    var displayName: string;
}
/**
 * Renders the navigation menu list.
 *
 * @remarks
 * - Renders a `<ul>` element by default
 * - Built on {@link https://base-ui.com/react/components/navigation-menu | Base UI Navigation Menu}
 * - Supports the `render` prop for element composition
 *
 * @example
 * ```tsx
 * <NavigationMenuList>Content</NavigationMenuList>
 * ```
 *
 * @see {@link https://base-ui.com/react/components/navigation-menu | Base UI Documentation}
 */
declare function NavigationMenuList(props: Readonly<NavigationMenuList.Props>): React.ReactElement;
declare namespace NavigationMenuList {
    var displayName: string;
}
/**
 * Renders the navigation menu item.
 *
 * @remarks
 * - Delegates structure and state to the underlying Base UI primitive
 * - Built on {@link https://base-ui.com/react/components/navigation-menu | Base UI Navigation Menu}
 * - Preserves the underlying primitive API for advanced composition
 *
 * @example
 * ```tsx
 * <NavigationMenuItem>Content</NavigationMenuItem>
 * ```
 *
 * @see {@link https://base-ui.com/react/components/navigation-menu | Base UI Documentation}
 */
declare const NavigationMenuItem: React.ForwardRefExoticComponent<Omit<import("@base-ui/react").NavigationMenuItemProps, "ref"> & React.RefAttributes<HTMLLIElement>>;
/**
 * Renders the navigation menu trigger.
 *
 * @remarks
 * - Renders a `<button>` element by default
 * - Built on {@link https://base-ui.com/react/components/navigation-menu | Base UI Navigation Menu}
 * - Supports the `render` prop for element composition
 *
 * @example
 * ```tsx
 * <NavigationMenuTrigger>Content</NavigationMenuTrigger>
 * ```
 *
 * @see {@link https://base-ui.com/react/components/navigation-menu | Base UI Documentation}
 */
declare const NavigationMenuTrigger: React.ForwardRefExoticComponent<Omit<NavigationMenuTriggerProps, "ref"> & React.RefAttributes<HTMLButtonElement>>;
/**
 * Renders the navigation menu content.
 *
 * @remarks
 * - Renders a `<div>` element by default
 * - Built on {@link https://base-ui.com/react/components/navigation-menu | Base UI Navigation Menu}
 * - Supports the `render` prop for element composition
 *
 * @example
 * ```tsx
 * <NavigationMenuContent>Content</NavigationMenuContent>
 * ```
 *
 * @see {@link https://base-ui.com/react/components/navigation-menu | Base UI Documentation}
 */
declare const NavigationMenuContent: React.ForwardRefExoticComponent<Omit<NavigationMenuContentProps, "ref"> & React.RefAttributes<HTMLDivElement>>;
/**
 * Renders the navigation menu link.
 *
 * @remarks
 * - Renders a `<a>` element by default
 * - Built on {@link https://base-ui.com/react/components/navigation-menu | Base UI Navigation Menu}
 * - Supports the `render` prop for element composition
 *
 * @example
 * ```tsx
 * <NavigationMenuLink>Content</NavigationMenuLink>
 * ```
 *
 * @see {@link https://base-ui.com/react/components/navigation-menu | Base UI Documentation}
 */
declare const NavigationMenuLink: React.ForwardRefExoticComponent<Omit<NavigationMenuLinkProps, "ref"> & React.RefAttributes<HTMLAnchorElement>>;
/**
 * Renders the navigation menu viewport.
 *
 * @remarks
 * - Renders a `<div>` element by default
 * - Built on {@link https://base-ui.com/react/components/navigation-menu | Base UI Navigation Menu}
 * - Supports the `render` prop for element composition
 *
 * @example
 * ```tsx
 * <NavigationMenuViewport>Content</NavigationMenuViewport>
 * ```
 *
 * @see {@link https://base-ui.com/react/components/navigation-menu | Base UI Documentation}
 */
declare function NavigationMenuViewport(props: Readonly<NavigationMenuViewport.Props>): React.ReactElement;
declare namespace NavigationMenuViewport {
    var displayName: string;
}
/**
 * Renders the navigation menu indicator.
 *
 * @remarks
 * - Renders a `<div>` element by default
 * - Built on {@link https://base-ui.com/react/components/navigation-menu | Base UI Navigation Menu}
 * - Supports the `render` prop for element composition
 *
 * @example
 * ```tsx
 * <NavigationMenuIndicator>Content</NavigationMenuIndicator>
 * ```
 *
 * @see {@link https://base-ui.com/react/components/navigation-menu | Base UI Documentation}
 */
declare function NavigationMenuIndicator(props: Readonly<NavigationMenuIndicator.Props>): React.ReactElement;
declare namespace NavigationMenuIndicator {
    var displayName: string;
}
declare namespace NavigationMenu {
    type Props = NavigationMenuProps;
    type State = BaseNavigationMenu.Root.State;
}
declare namespace NavigationMenuList {
    type Props = NavigationMenuListProps;
    type State = BaseNavigationMenu.List.State;
}
declare namespace NavigationMenuTrigger {
    type Props = NavigationMenuTriggerProps;
    type State = BaseNavigationMenu.Trigger.State;
}
declare namespace NavigationMenuContent {
    type Props = NavigationMenuContentProps;
    type State = BaseNavigationMenu.Content.State;
}
declare namespace NavigationMenuLink {
    type Props = NavigationMenuLinkProps;
    type State = BaseNavigationMenu.Link.State;
}
declare namespace NavigationMenuViewport {
    type Props = NavigationMenuViewportProps;
    type State = BaseNavigationMenu.Viewport.State;
}
declare namespace NavigationMenuIndicator {
    type Props = NavigationMenuIndicatorProps;
    type State = Record<string, never>;
}
export { NavigationMenu, NavigationMenuContent, NavigationMenuIndicator, NavigationMenuItem, NavigationMenuLink, NavigationMenuList, NavigationMenuTrigger, NavigationMenuViewport, };
//# sourceMappingURL=navigation-menu.d.ts.map