@carbon/react/es/components/UIShell/SideNavMenu.d.ts

React components for the Carbon Design System

/**
 * Copyright IBM Corp. 2016, 2025
 *
 * This source code is licensed under the Apache-2.0 license found in the
 * LICENSE file in the root directory of this source tree.
 */
import React from 'react';
export interface SideNavMenuProps {
    /**
     * An optional CSS class to apply to the component.
     */
    className?: string;
    /**
     * The content to render within the SideNavMenu component.
     */
    children?: React.ReactNode;
    /**
     * Specifies whether the menu should be expanded by default.
     */
    defaultExpanded?: boolean;
    /**
     * Indicates whether the SideNavMenu is active.
     */
    isActive?: boolean;
    /**
     * Specifies whether the SideNavMenu is in a large variation.
     */
    large?: boolean;
    /**
     * A component used to render an icon.
     */
    renderIcon?: React.ComponentType;
    /**
     * Indicates if the side navigation container is expanded or collapsed.
     */
    isSideNavExpanded?: boolean;
    /**
     * The tabIndex for the button element.
     * If not specified, the default validation will be applied.
     */
    tabIndex?: number;
    title: string;
}
declare const SideNavMenu: React.ForwardRefExoticComponent<SideNavMenuProps & React.RefAttributes<HTMLElement>>;
export default SideNavMenu;
export { SideNavMenu };