From 115e2829959c5c149e02f539c1873cec9a83dca9 Mon Sep 17 00:00:00 2001 From: Eileen Guo Date: Tue, 23 Jan 2024 15:43:58 +0100 Subject: [PATCH] adding deprecated jsdoc --- packages/libs/react-ui/src/components/NavAccordion/index.ts | 4 ++++ packages/libs/react-ui/src/components/Tree/Tree.stories.tsx | 4 ++-- packages/libs/react-ui/src/components/Tree/Tree.tsx | 4 ++++ 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/packages/libs/react-ui/src/components/NavAccordion/index.ts b/packages/libs/react-ui/src/components/NavAccordion/index.ts index 24fb580132..57ea13fee3 100644 --- a/packages/libs/react-ui/src/components/NavAccordion/index.ts +++ b/packages/libs/react-ui/src/components/NavAccordion/index.ts @@ -22,6 +22,10 @@ export interface INavAccordionProps { Link: FC; } +/** + * A component used for grouping items in a navigation accordion. + * @deprecated This component will be redesigned. + */ export const NavAccordion: INavAccordionProps = { Root: NavAccordionRoot, Section: NavAccordionSection, diff --git a/packages/libs/react-ui/src/components/Tree/Tree.stories.tsx b/packages/libs/react-ui/src/components/Tree/Tree.stories.tsx index 478828cec0..086eb23860 100644 --- a/packages/libs/react-ui/src/components/Tree/Tree.stories.tsx +++ b/packages/libs/react-ui/src/components/Tree/Tree.stories.tsx @@ -7,12 +7,12 @@ const meta: Meta<{} & ITreeProps> = { title: 'Components/Tree', parameters: { status: { - type: ['needsRevision'], + type: ['deprecated'], }, docs: { description: { component: - 'Deprecated. Do not use.
Will be refactored as it does not meet our standards.

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.', + '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.', }, }, }, diff --git a/packages/libs/react-ui/src/components/Tree/Tree.tsx b/packages/libs/react-ui/src/components/Tree/Tree.tsx index 7be86b3998..01b53ba8a5 100644 --- a/packages/libs/react-ui/src/components/Tree/Tree.tsx +++ b/packages/libs/react-ui/src/components/Tree/Tree.tsx @@ -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 = ({ title, items,