@carbon/react/lib/components/UIShell/SideNavIcon.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 SideNavIconProps {
    /**
     * Provide a single icon as the child to `SideNavIcon` to render in the
     * container
     */
    children: React.ReactNode;
    /**
     * Provide an optional class to be applied to the containing node
     */
    className?: string;
    /**
     * Specify whether the icon should be placed in a smaller bounding box
     * Since the 'small' prop is not provided, we make it optional and set a default value to `false`.
     */
    small?: boolean;
}
declare const SideNavIcon: {
    ({ children, className: customClassName, small, }: SideNavIconProps): import("react/jsx-runtime").JSX.Element;
    propTypes: {
        /**
         * Provide a single icon as the child to `SideNavIcon` to render in the
         * container
         */
        children: PropTypes.Validator<NonNullable<PropTypes.ReactNodeLike>>;
        /**
         * Provide an optional class to be applied to the containing node
         */
        className: PropTypes.Requireable<string>;
        /**
         * Specify whether the icon should be placed in a smaller bounding box
         */
        small: PropTypes.Requireable<boolean>;
    };
};
export default SideNavIcon;