BalanceReckon Design System

Sidebar Navigation

Use navigation to let users navigate to the major areas of your site.

VerticalNavigationProps

PropTypeRequiredDefaultDescription
children| ReactElement<SidebarNavigationItemProps>[] | ReactElement<SidebarNavigationGroupProps>[]Yes—SidebarNavigationItem and SidebarNavigationGroup rendered as children.
defaultExpandedGroupKeystring——Optional key that matches SidebarNavigationGroup.groupKey to set a group as expanded on load.
selectedNavigationKeystring——Optional key that matches SidebarNavigationItem.navigationKey to mark the selected route.

SidebarNavigationItemProps

PropTypeRequiredDefaultDescription
endElementReactNode——Optional custom element to the right of the label.
iconComponentType<IconProps>——Optional icon to the left of the label.
labelstringYes—Label for the route that user sees.
navigationKeystringYes—Unique key that represents a route. This will be used to select the current route.
Also accepts Omit< LinkComponentProps, 'children' >

SidebarNavigationItemButtonProps

PropTypeRequiredDefaultDescription
endElementReactNode——Optional custom element to the right of the label.
iconComponentType<IconProps>——Optional icon to the left of the label.
labelstringYes—Label for the button that the user sees.
onClickMouseEventHandler<HTMLButtonElement>Yes—Click handler for the entire component.

SidebarNavigationGroupProps

PropTypeRequiredDefaultDescription
children| Array<ReactElement<SidebarNavigationItemProps>> | ReactElement<SidebarNavigationItemProps>Yes—SidebarNavigationItem or SidebarNavigationGroup rendered as children.
groupKeystringYes—Unique key for the group inside a particular SidebarNavigation.
iconComponentType<IconProps>——Optional icon to the left of the label. Only renders icon if startElement is not provided.
labelstringYes—Label for the group that the user sees.
startElement| ReactElement<EntityAvatarProps> | ReactElement<UserAvatarProps>——Optional custom element to the left of the label.