Skip to main content

Introducing Workflow Engine, try for FREE workflowengine.io.

Breadcrumb

Introduction

The Breadcrumb component is a navigational element that is typically used as a hierarchical trail of links, representing the current page's location within your form. It provides users with a visual representation of their navigation path, allowing them to easily understand their current position and navigate back to previous pages or sections. This component is a part of @react-form-builder/components-rsuite.

This component typically consists of multiple clickable links, separated by a forward slash or any other delimiter of your choice. You can also set the number of items within the breadcrumb component and customize other properties that are described below.

Main properties

The following general properties are available within the Main tab:

NameTypeDescription
SeparatorstringCharacter used to separate the breadcrumb items
Max ItemsnumberThe maximum number of breadcrumb items to display. If there are more items than this limit, the excess items will be truncated or hidden
ItemsstringUsed to define values and labels for your items. If the active checkbox set to true, makes your item focused and removes the underline. Add more items by using the corresponding (+) button

At the bottom of the Main properties menu, you can find additional options:

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:

    • Justify: Sets the alignment of your component's items (i.e., Left, Center, or Right).
    • 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:

    NameTypeDescription
    WidthnumberSpecifies the width for your component
    HeightnumberSpecifies the height for your component
    Margin top/right/bottom/leftnumberMargin values for you component
    ColorstringAllows customizing the text color
    Background colorstringEnables customizing the background color