WIP(ui-top-nav-bar): add onclick documentation

instructure · Nov 7, 2023 · f05a0d2 · f05a0d2
1 parent 86e82ab
commit f05a0d2
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/packages/ui-top-nav-bar/src/TopNavBar/TopNavBarBreadcrumb/props.ts b/packages/ui-top-nav-bar/src/TopNavBar/TopNavBarBreadcrumb/props.ts
@@ -53,6 +53,10 @@ type TopNavBarBreadcrumbOwnProps = {
    * The children to be rendered within the `<TopNavBarBreadcrumb />`. Children must be type of `Breadcrumb`.
    */
   children: ChildrenOfType<ComponentElement<BreadcrumbProps, Breadcrumb>>
+
+  /**
+   * A callback function to be called, if the user clicks on the hamburger icon.
+   */
   onClick?: (
     event: React.MouseEvent<ViewOwnProps> | React.KeyboardEvent<ViewOwnProps>
   ) => void