Skip to content

SiteBreadcrumb control

This control returns a breadcrumb based on the current location.

SiteBreadcrumb control output Hover over an item

How to use this control in your solutions

  • Check that you installed the @pnp/spfx-controls-react dependency. Check out the getting started page for more information about installing the dependency.
  • Import the following modules to your component:
import { SiteBreadcrumb } from "@pnp/spfx-controls-react/lib/SiteBreadcrumb";
  • Use the SiteBreadcrumb control in your code as follows:
<SiteBreadcrumb context={this.props.context} />

Implementation

The SiteBreadcrumb control can be configured with the following properties:

Property Type Required Description
context WebPartContext OR ApplicationCustomizerContext yes Pass the context of your web part or application customizer extension.