@carbon/react
Version:
React components for the Carbon Design System
46 lines (45 loc) • 1.57 kB
TypeScript
/**
* 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 SideNavItemsProps {
/**
* 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;
/**
* 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;
}
declare const SideNavItems: {
({ className: customClassName, children, isSideNavExpanded, }: SideNavItemsProps): import("react/jsx-runtime").JSX.Element;
displayName: string;
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>;
/**
* 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>;
};
};
export default SideNavItems;