@heroui/navbar/dist/navbar-context.d.mts

A responsive navigation header positioned on top side of your page that includes support for branding, links, navigation, collapse and more.

import * as framer_motion from 'framer-motion';
import * as _heroui_theme from '@heroui/theme';
import * as react from 'react';
import * as tailwind_variants from 'tailwind-variants';
import * as _heroui_system from '@heroui/system';

declare const NavbarProvider: react.Provider<{
    Component: _heroui_system.As<any>;
    slots: {
        base: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        wrapper: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        toggle: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        srOnly: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        toggleIcon: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        brand: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        content: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        item: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        menu: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        menuItem: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
    } & {
        base: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        wrapper: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        toggle: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        srOnly: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        toggleIcon: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        brand: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        content: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        item: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        menu: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        menuItem: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
    } & {};
    domRef: react.RefObject<HTMLElement>;
    height: string | number;
    isHidden: boolean;
    disableAnimation: boolean;
    shouldHideOnScroll: boolean;
    isMenuOpen: boolean;
    classNames: _heroui_theme.SlotsToClasses<"base" | "menu" | "content" | "wrapper" | "toggle" | "srOnly" | "toggleIcon" | "brand" | "item" | "menuItem"> | undefined;
    setIsMenuOpen: (value: boolean, ...args: any[]) => void;
    motionProps: Omit<framer_motion.HTMLMotionProps<"nav">, "ref"> | undefined;
    getBaseProps: _heroui_system.PropGetter;
    getWrapperProps: _heroui_system.PropGetter;
}>;
declare const useNavbarContext: () => {
    Component: _heroui_system.As<any>;
    slots: {
        base: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        wrapper: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        toggle: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        srOnly: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        toggleIcon: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        brand: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        content: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        item: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        menu: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        menuItem: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
    } & {
        base: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        wrapper: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        toggle: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        srOnly: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        toggleIcon: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        brand: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        content: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        item: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        menu: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
        menuItem: (slotProps?: ({
            maxWidth?: "lg" | "sm" | "md" | "xl" | "2xl" | "full" | undefined;
            position?: "static" | "sticky" | undefined;
            isBlurred?: boolean | undefined;
            hideOnScroll?: boolean | undefined;
            isBordered?: boolean | undefined;
            disableAnimation?: boolean | undefined;
        } & tailwind_variants.ClassProp<tailwind_variants.ClassValue>) | undefined) => string;
    } & {};
    domRef: react.RefObject<HTMLElement>;
    height: string | number;
    isHidden: boolean;
    disableAnimation: boolean;
    shouldHideOnScroll: boolean;
    isMenuOpen: boolean;
    classNames: _heroui_theme.SlotsToClasses<"base" | "menu" | "content" | "wrapper" | "toggle" | "srOnly" | "toggleIcon" | "brand" | "item" | "menuItem"> | undefined;
    setIsMenuOpen: (value: boolean, ...args: any[]) => void;
    motionProps: Omit<framer_motion.HTMLMotionProps<"nav">, "ref"> | undefined;
    getBaseProps: _heroui_system.PropGetter;
    getWrapperProps: _heroui_system.PropGetter;
};

export { NavbarProvider, useNavbarContext };