@carbon/ibm-products
Version:
Carbon for IBM Products
49 lines • 1.73 kB
TypeScript
/**
* Copyright IBM Corp. 2026
*
* This source code is licensed under the Apache-2.0 license found in the
* LICENSE file in the root directory of this source tree.
*/
import React, { type ComponentType, type FunctionComponent } from 'react';
import { type PageHeaderObserverState } from './context';
/**
* -----------------------
* PageHeaderBreadcrumbBar
* -----------------------
*/
export interface PageHeaderBreadcrumbBarProps {
/**
* `true` by default to render BreadcrumbBar bottom border.
*/
border?: boolean;
children?: React.ReactNode;
className?: string;
/**
* Provide an optional icon to render in front of the PageHeaderContent's title.
*/
renderIcon?: ComponentType | FunctionComponent;
/**
* The PageHeaderBreadcrumbBar's content actions.
* Can be a ReactNode or a function that receives observer state.
*/
contentActions?: React.ReactNode | ((state: PageHeaderObserverState) => React.ReactNode);
/**
* `true` to set content actions flush against page actions
*/
contentActionsFlush?: boolean;
/**
* The PageHeaderContent's page actions.
* Can be a ReactNode or a function that receives observer state.
*/
pageActions?: React.ReactNode | ((state: PageHeaderObserverState) => React.ReactNode);
/**
* `true` to set page actions flush with page
*/
pageActionsFlush?: boolean;
/**
* Aria label for the page header actions navigation.
*/
actionsAriaLabel?: string;
}
export declare const PageHeaderBreadcrumbBar: React.ForwardRefExoticComponent<PageHeaderBreadcrumbBarProps & React.RefAttributes<HTMLDivElement>>;
//# sourceMappingURL=PageHeaderBreadcrumbBar.d.ts.map