hendrik/lens
1
0
Fork 0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
Code Issues Projects Releases Wiki Activity

adding @jsdoc comments to SidebarItem

Browse Source 
Signed-off-by: Roman <ixrock@gmail.com>
This commit is contained in:
Roman 2021-03-20 18:41:06 +02:00
parent 5b9e788730
commit 0cc2fb4cd8
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/renderer/components/layout/sidebar-item.tsx
View File

@ -10,14 +10,23 @@ import { sidebarStorage } from "./sidebar-storage";
import { isActiveRoute } from "../../navigation";
interface SidebarItemProps {
id: string; // unique id, used in storage and integration tests
/**
* Unique id, used in storage and integration tests
*/
id: string;
url: string;
className?: string;
text: React.ReactNode;
icon?: React.ReactNode;
isHidden?: boolean;
isActive?: boolean; // marks a link, by default checks `props.url` to identify active state
subMenus?: React.ReactNode | React.ComponentType<SidebarItemProps>[]; // props.children could be used too
/**
* Forces this item to be also show as active or not.
*
* Default: dynamically checks the location against the `url` props to determine if
* this item should be shown as active
*/
isActive?: boolean;
subMenus?: React.ReactNode | React.ComponentType<SidebarItemProps>[];
}
@observer