@patternfly/react-core/dist/js/components/Page/PageBreadcrumb.d.ts

This library provides a set of common React components for use with the PatternFly reference implementation.

/// <reference types="react" />
export interface PageBreadcrumbProps extends React.HTMLProps<HTMLElement> {
    /** Additional classes to apply to the PageBreadcrumb */
    className?: string;
    /** Content rendered inside of the PageBreadcrumb */
    children?: React.ReactNode;
    /** Limits the width of the breadcrumb */
    isWidthLimited?: boolean;
    /** Modifier indicating if the PageBreadcrumb is sticky to the top or bottom at various breakpoints */
    stickyOnBreakpoint?: {
        default?: 'top' | 'bottom';
        sm?: 'top' | 'bottom';
        md?: 'top' | 'bottom';
        lg?: 'top' | 'bottom';
        xl?: 'top' | 'bottom';
        '2xl'?: 'top' | 'bottom';
    };
    /** Flag indicating if PageBreadcrumb should have a shadow at the top */
    hasShadowTop?: boolean;
    /** Flag indicating if PageBreadcrumb should have a shadow at the bottom */
    hasShadowBottom?: boolean;
    /** Flag indicating if the PageBreadcrumb has a scrolling overflow */
    hasOverflowScroll?: boolean;
    /** @beta Flag indicating whether children passed to the component should be wrapped by a PageBody.
     * Set this to false in order to pass multiple, custom PageBody's as children.
     */
    hasBodyWrapper?: boolean;
    /** Adds an accessible name to the breadcrumb section. Required when the hasOverflowScroll prop is set to true. */
    'aria-label'?: string;
}
export declare const PageBreadcrumb: {
    ({ className, children, isWidthLimited, stickyOnBreakpoint, hasShadowTop, hasShadowBottom, hasOverflowScroll, "aria-label": ariaLabel, hasBodyWrapper, ...props }: PageBreadcrumbProps): import("react/jsx-runtime").JSX.Element;
    displayName: string;
};
//# sourceMappingURL=PageBreadcrumb.d.ts.map