Hiyve Components - v1.0.0
    Preparing search index...

    Interface PortalLayoutProps

    Props for the PortalLayout component.

    interface PortalLayoutProps {
        children?: ReactNode;
        colors?: Partial<PortalLayoutColors>;
        currentPath: string;
        labels?: Partial<PortalLayoutLabels>;
        mobileNavPaths?: string[];
        navItems: NavItem[];
        onNavigate: (path: string) => void;
        sx?: SxProps<Theme>;
        title: string;
    }
    Index

    Properties

    children? colors? currentPath labels? mobileNavPaths? navItems onNavigate sx? title

    Properties

    children?: ReactNode

    Main-content children (e.g. <Outlet /> when using react-router).

    colors?: Partial<PortalLayoutColors>

    Custom colors

    currentPath: string

    Current pathname — used to highlight the active nav item and detect the active bottom-nav tab.

    labels?: Partial<PortalLayoutLabels>

    Custom labels

    mobileNavPaths?: string[]

    Paths to show in the mobile bottom nav (ideally 3–4). Any remaining items go into a "More" bottom drawer. Omit to show every top-level item.

    navItems: NavItem[]

    Navigation items shown in the sidebar (and optionally the mobile bottom nav).

    onNavigate: (path: string) => void

    Called when a nav item is activated — via sidebar click, bottom-nav tap, or More-drawer selection.

    sx?: SxProps<Theme>

    MUI sx prop applied to the root container

    title: string

    Title rendered at the top of the sidebar.

    Settings

    Member Visibility

    On This Page

    Properties