-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(component): add SideNavItems.tsx component
- Loading branch information
Showing
3 changed files
with
87 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| /** | ||
| * Copyright IBM Corp. 2016, 2023 | ||
| * | ||
| * 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 cx from 'classnames'; | ||
| import PropTypes from 'prop-types'; | ||
| import React from 'react'; | ||
| import { CARBON_SIDENAV_ITEMS } from './_utils'; | ||
| import { usePrefix } from '../../internal/usePrefix'; | ||
|
|
||
| interface SideNavItemsProps { | ||
| /** | ||
| * Provide an optional class to be applied to the containing node | ||
| */ | ||
| className?: string; | ||
| /** | ||
| * Provide a single icon as the child to `SideNavIcon` to render in the | ||
| * container, and it is required | ||
| */ | ||
| children: React.ReactNode; | ||
| /** | ||
| * 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; | ||
| } | ||
|
|
||
| const SideNavItems: React.FC<SideNavItemsProps> = ({ | ||
| className: customClassName, | ||
| children, | ||
| isSideNavExpanded, | ||
| }) => { | ||
| const prefix = usePrefix(); | ||
| const className = cx([`${prefix}--side-nav__items`], customClassName); | ||
| const childrenWithExpandedState = React.Children.map(children, (child) => { | ||
| // avoid spreading `isSideNavExpanded` to non-Carbon UI Shell children | ||
| if (React.isValidElement(child)) { | ||
| const childType = child.type as React.ComponentType<any>; | ||
| if (childType && childType.displayName) { | ||
| return React.cloneElement(child, { | ||
| ...(CARBON_SIDENAV_ITEMS.includes(childType.displayName) | ||
| ? { | ||
| isSideNavExpanded, | ||
| } | ||
| : {}), | ||
| }); | ||
| } | ||
| } | ||
| }); | ||
| return <ul className={className}>{childrenWithExpandedState}</ul>; | ||
| }; | ||
|
|
||
| SideNavItems.displayName = 'SideNavItems'; | ||
|
|
||
| SideNavItems.propTypes = { | ||
| /** | ||
| // * Provide a single icon as the child to `SideNavIcon` to render in the | ||
| // * container | ||
| // */ | ||
| children: PropTypes.node.isRequired, | ||
| // | ||
| // /** | ||
| // * Provide an optional class to be applied to the containing node | ||
| // */ | ||
| className: PropTypes.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.bool, | ||
| }; | ||
|
|
||
| export default SideNavItems; |