Skip to content

Commit

Permalink
adding deprecated jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
eileenmguo committed Jan 23, 2024
1 parent 7740170 commit 115e282
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 2 deletions.
4 changes: 4 additions & 0 deletions packages/libs/react-ui/src/components/NavAccordion/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ export interface INavAccordionProps {
Link: FC<INavAccordionLinkProps>;
}

/**
* A component used for grouping items in a navigation accordion.
* @deprecated This component will be redesigned.
*/
export const NavAccordion: INavAccordionProps = {
Root: NavAccordionRoot,
Section: NavAccordionSection,
Expand Down
4 changes: 2 additions & 2 deletions packages/libs/react-ui/src/components/Tree/Tree.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ const meta: Meta<{} & ITreeProps> = {
title: 'Components/Tree',
parameters: {
status: {
type: ['needsRevision'],
type: ['deprecated'],
},
docs: {
description: {
component:
'<strong>Deprecated. Do not use.</strong><br />Will be refactored as it does not meet our standards.<br /><br /><em>The Tree component renders a tree structure with a root node and child nodes. The tree can be expanded and collapsed by clicking on the root node. The tree can be set to open by default with the `isOpen` prop. The tree can be set to close its siblings when opened with the `linked` prop.</em>',
'The Tree component renders a tree structure with a root node and child nodes. The tree can be expanded and collapsed by clicking on the root node. The tree can be set to open by default with the `isOpen` prop. The tree can be set to close its siblings when opened with the `linked` prop.</em>',
},
},
},
Expand Down
4 changes: 4 additions & 0 deletions packages/libs/react-ui/src/components/Tree/Tree.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ export interface ITreeProps {
onClose?: () => void;
}

/**
* A component used for grouping items in a tree.
* @deprecated This component will be redesigned.
*/
export const Tree: FC<ITreeProps> = ({
title,
items,
Expand Down

0 comments on commit 115e282

Please sign in to comment.