@carbon/react/lib/components/UIShell/SideNavHeader.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 PropTypes from 'prop-types';
import React from 'react';
export interface SideNavHeaderProps {
    /**
     * The child nodes to be rendered
     */
    children?: React.ReactNode;
    /**
     * Provide an optional class to be applied to the containing node
     */
    className?: string;
    /**
     * Property to indicate if the side nav container is open (or not). Use to
     * keep local state and styling in step with the SideNav expansion state.
     */
    isSideNavExpanded?: boolean;
    /**
     * A component used to render an icon.
     */
    renderIcon: React.ComponentType;
}
declare const SideNavHeader: {
    ({ children, className: customClassName, renderIcon: IconElement, }: SideNavHeaderProps): import("react/jsx-runtime").JSX.Element;
    displayName: string;
    propTypes: {
        /**
         * The child nodes to be rendered
         */
        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
        /**
         * Provide an optional class to be applied to the containing node
         */
        className: PropTypes.Requireable<string>;
        /**
         * Property to indicate if the side nav container is open (or not). Use to
         * keep local state and styling in step with the SideNav expansion state.
         */
        isSideNavExpanded: PropTypes.Requireable<boolean>;
        /**
         * A component used to render an icon.
         */
        renderIcon: PropTypes.Validator<object>;
    };
};
export default SideNavHeader;