Breadcrumbs
Introduction
The Breadcrumbs component displays a navigation trail for users to track their location within an application. It is commonly used in multi-level navigation structures, file systems, e-commerce categories, or any hierarchical content where users need to understand their current position and navigate back to parent levels. The component follows Material Design guidelines for breadcrumb navigation with clear separators and interactive links.
The Breadcrumbs component is based on Material UI Breadcrumbs. It is included within the following NPM package: @react-form-builder/components-material-ui.
The Breadcrumbs component can be styled and configured to fit specific design and functionality requirements by using various properties that are presented and described below.
Main properties
The following general properties are available within the Main tab:
| Name | Type | Description |
|---|---|---|
| Separator | ReactNode | Custom separator node (default: '/') |
| Items | array | Breadcrumb items to display |
| Max items | number | Maximum number of breadcrumbs to display. When there are more than this number, only the first and last items will be shown, with an ellipsis in between |
| Items after collapse | number | If maxItems is exceeded, the number of items to show after the ellipsis |
| Items before collapse | number | If maxItems is exceeded, the number of items to show before the ellipsis |
At the bottom of the Main properties menu, you can find additional options:
- Render When: Provides conditional rendering for your component as described in the corresponding chapter.
- HTML attributes: Allows you to provide custom HTML attributes for your form.
Style properties
These are properties that allow to customize the size, color and other style properties of your component:
- For Device: You can provide component's style customization for all devices or specific devices by using this dropdown list. Refer to Adaptive Layout for more details.
- Component > Class Name: Add a class name for your component for the subsequent styling if necessary.
-
Wrapper: The options below enable you to tailor the appearance of your component and customize it for a specific device type, as selected in the For Device property:
Name Type Description Width numberSpecifies the width for your component Height numberSpecifies the height for your component Margin top/right/bottom/left numberMargin values for you component Color stringAllows customizing the text color Background color stringEnables customizing the background color