Add jsdoc documents - fix some ae-missing-release-tag warnings in api-report

Signed-off-by: hiba-aldalaty <hibaaldalaty@gmail.com>
This commit is contained in:
hiba-aldalaty
2021-11-19 11:33:43 +00:00
parent 3805cd7d36
commit a9d85516e6
3 changed files with 13 additions and 5 deletions
+2 -5
View File
@@ -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,
@@ -176,6 +176,12 @@ export function Sidebar(props: PropsWithChildren<Props>) {
);
}
/**
* 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);
@@ -91,6 +91,11 @@ type SubmenuItemProps = {
dropdownItems?: DropDownItem[];
};
/**
* Item used inside a submenu within the sidebar.
*
* @public
*/
export const SubmenuItem = ({
title,
to,