DashboardSidebarPageItem API

API reference docs for the React DashboardSidebarPageItem component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

import { DashboardSidebarPageItem } from '@toolpad/core/DashboardLayout';

Name	Type	Default	Description
href*	string	-	Link `href` for when the item is rendered as a link.
id*	string	-	A string that uniquely identifies the item.
item*	{ action?: node, children?: Array<object \| { kind: 'header', title: string } \| { kind: 'divider' }>, icon?: node, kind?: 'page', pattern?: string, segment?: string, title?: string }	-	Navigation item definition.
onClick*	func	-	Callback fired when the item is clicked.
renderNestedNavigation*	func	-	Override the component rendered as nested navigation for this item.
title*	string	-	Item title.
disabled	bool	false	If `true`, the item is disabled.
expanded	bool	false	If `true`, expands any nested navigation in the item, otherwise collapse it.
isSidebarFullyCollapsed	bool	false	If `true`, the containing sidebar is fully collapsed.
isSidebarFullyExpanded	bool	true	If `true`, the containing sidebar is fully expanded.
Link	elementType	-	The component used to render the item as a link.
mini	bool	false	If `true`, the containing sidebar is in mini mode.
selected	bool	false	Use to apply selected styling.

The component cannot hold a ref.

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.