) : (
{ content }
);
}
const BreadcrumbsNav = forwardRef<
HTMLElement,
BreadcrumbProps & {
isOffscreen?: boolean;
}
>( function BreadcrumbsNav(
{
isOffscreen,
items,
showCurrentItem = false,
variant = 'default',
renderItemLink = defaultRenderItemLink,
...props
},
ref
) {
// Always show the first item. The last item (current page) is rendered
// conditionally based on the `showCurrentItem` prop.
const hasMiddleItems = items.length > 3;
const firstItem = items[ 0 ];
const middleItems = hasMiddleItems ? items.slice( 1, -2 ) : [];
// Always show the parent item if there are more than 2 items. If there
// are only 2 items, the parent item is the first item and is already shown.
const parentItem = items.length > 2 && items[ items.length - 2 ];
/**
* As the container shrinks, multiple breadcrumb items between the first and
* last visible item should collapse into a dropdown menu to avoid wrapping.
* The current approach is to keep a ref of the `offScreen (full-width)`
* container and observe for `inlineSize` changes. If the `offScreen` container
* would overflow, we should render the compact variant.
* Noting that we prioritize the `isCompact` prop over the `width` checks.
*/
const isCompact = ! isOffscreen && hasMiddleItems && variant === 'compact';
return (
);
} );
function UnforwardedBreadcrumbs(
{ items, renderItemLink, 'aria-label': ariaLabel, ...props }: BreadcrumbProps,
ref: React.ForwardedRef< HTMLElement >
) {
const { __ } = useI18n();
const computedAriaLabel = ariaLabel ?? __( 'Breadcrumbs' );
const offScreenWidth = useRef( 0 );
const containerWidth = useRef( 0 );
const [ shouldRenderCompact, setShouldRenderCompact ] = useState( false );
const computeShouldRenderCompact = () => {
setShouldRenderCompact( offScreenWidth.current > containerWidth.current );
};
const offScreenRef = useResizeObserver( ( resizeObserverEntries ) => {
offScreenWidth.current = resizeObserverEntries[ 0 ].borderBoxSize[ 0 ].inlineSize;
computeShouldRenderCompact();
} );
const containerRef = useResizeObserver( ( resizeObserverEntries ) => {
containerWidth.current = resizeObserverEntries[ 0 ].borderBoxSize[ 0 ].inlineSize;
computeShouldRenderCompact();
} );
const mergedRefs = useMergeRefs( [ ref, containerRef ] );
if ( ! items.length || items.length === 1 ) {
return null;
}
const computedVariant = shouldRenderCompact ? 'compact' : props.variant;
return (
<>
>
);
}
/**
* The `Breadcrumbs` component provides a secondary navigation aid that shows
* users their current location within a site's or application's hierarchy.
* It helps users understand the structure of the site, retrace their steps,
* and easily navigate to higher-level pages.
*
* For accessibility, **it is important that the current page is included as the
* final item in the breadcrumb trail**. This ensures screen reader users
* receive the full navigational context.
*
* Note: for the Breadcrumbs component to work properly in compact mode, make
* sure that the implicit component's width is not affected by changes in the
* document's body padding.
*/
export const Breadcrumbs = forwardRef( UnforwardedBreadcrumbs );