Breadcrumb
A breadcrumb displays the current location within a hierarchy. It allows going back to states higher up in the hierarchy.
When To Use
- When the system has more than two layers in a hierarchy.
- When you need to inform the user of where they are.
- When the user may need to navigate back to a higher level.
Examples
Breadcrumb API#
| Property | Description | Type | Default Value |
|---|---|---|---|
| ChildContent | ParameterContent of the Breadcrumb. Should contain BreadcrumbItem elements | RenderFragment | -- |
| AutoGenerate | ParameterNot currently used. Planned for future development. | Boolean | false |
| Separator | ParameterSeparator between items | String | / |
| Id | ParameterID for the component's HTML | String | Uniquely Generated ID |
| Class | ParameterSpecifies one or more class names for an DOM element. | String | -- |
| Style | ParameterSpecifies an inline style for a DOM element. | String | -- |
| RefBack | ParameterA ForwardRef instance. You can get a reference to the internal DOM by using AntDesign.ForwardRef.Current. |
ForwardRef | -- |
BreadcrumbItem API#
| Property | Description | Type | Default Value |
|---|---|---|---|
| ChildContent | ParameterInner content of item | RenderFragment | -- |
| Overlay | ParameterOverlay for a dropdown menu | RenderFragment | -- |
| Href | ParameterLink for the item. Providing this wraps the ChildContent in an anchor tag for this link. | String | -- |
| OnClick | ParameterClick callback | EventCallback<MouseEventArgs> | -- |
| Id | ParameterID for the component's HTML | String | Uniquely Generated ID |
| Class | ParameterSpecifies one or more class names for an DOM element. | String | -- |
| Style | ParameterSpecifies an inline style for a DOM element. | String | -- |
| RefBack | ParameterA ForwardRef instance. You can get a reference to the internal DOM by using AntDesign.ForwardRef.Current. |
ForwardRef | -- |