diff --git a/packages/core-components/api-report.md b/packages/core-components/api-report.md index 7d5f60220b..68044840b3 100644 --- a/packages/core-components/api-report.md +++ b/packages/core-components/api-report.md @@ -1105,9 +1105,7 @@ export const SidebarDivider: React_2.ComponentType< } >; -// Warning: (ae-missing-release-tag) "SidebarExpandButton" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// -// @public (undocumented) +// @public export const SidebarExpandButton: () => JSX.Element | null; // Warning: (ae-missing-release-tag) "SidebarIntro" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) @@ -2090,9 +2088,8 @@ export type StructuredMetadataTableListClassKey = 'root'; export type StructuredMetadataTableNestedListClassKey = 'root'; // Warning: (ae-forgotten-export) The symbol "SubmenuItemProps" needs to be exported by the entry point index.d.ts -// Warning: (ae-missing-release-tag) "SubmenuItem" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // -// @public (undocumented) +// @public export const SubmenuItem: ({ title, to, diff --git a/packages/core-components/src/layout/Sidebar/Bar.tsx b/packages/core-components/src/layout/Sidebar/Bar.tsx index 1fb8dc5fc6..a4cd4349a2 100644 --- a/packages/core-components/src/layout/Sidebar/Bar.tsx +++ b/packages/core-components/src/layout/Sidebar/Bar.tsx @@ -176,6 +176,12 @@ export function Sidebar(props: PropsWithChildren) { ); } +/** + * A button which allows you to expand the sidebar when clicked. + * Use optionally to replace sidebar's expand-on-hover feature with expand-on-click. + * + * @public + */ export const SidebarExpandButton = () => { const classes = useStyles(); const { isOpen, handleOpen, handleClose } = useContext(SidebarContext); diff --git a/packages/core-components/src/layout/Sidebar/SubmenuItem.tsx b/packages/core-components/src/layout/Sidebar/SubmenuItem.tsx index bdf62c225e..c8a2dcd14d 100644 --- a/packages/core-components/src/layout/Sidebar/SubmenuItem.tsx +++ b/packages/core-components/src/layout/Sidebar/SubmenuItem.tsx @@ -91,6 +91,11 @@ type SubmenuItemProps = { dropdownItems?: DropDownItem[]; }; +/** + * Item used inside a submenu within the sidebar. + * + * @public + */ export const SubmenuItem = ({ title, to,