@carbon/ibm-products
Version:
Carbon for IBM Products
101 lines • 6.19 kB
TypeScript
/**
* Copyright IBM Corp. 2025, 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 from 'react';
import { PageHeaderBreadcrumbBar, type PageHeaderBreadcrumbBarProps } from './PageHeaderBreadcrumbBar';
import { PageHeaderContent, type PageHeaderContentProps } from './PageHeaderContent';
import { PageHeaderContentPageActions, type PageHeaderContentPageActionsProps } from './PageHeaderContentPageActions';
import { PageHeaderContentText, type PageHeaderContentTextProps } from './PageHeaderContentText';
import { PageHeaderHeroImage, type PageHeaderHeroImageProps } from './PageHeaderHeroImage';
import { PageHeaderTabBar, type PageHeaderTabBarProps } from './PageHeaderTabBar';
import { PageHeaderTagOverflow, type PageHeaderTagOverflowProps } from './PageHeaderTagOverflow';
import { PageHeaderScrollButton, type PageHeaderScrollButtonProps } from './PageHeaderScrollButton';
import { PageHeaderTitleBreadcrumb } from './PageHeaderTitleBreadcrumb';
import { PageHeaderBreadcrumbOverflow, type PageHeaderBreadcrumbOverflowProps } from './PageHeaderBreadcrumbOverflow';
import { PageHeaderBreadcrumbPageActions, type PageHeaderBreadcrumbPageActionsProps, type PageHeaderBreadcrumbPageActionItem } from './PageHeaderBreadcrumbPageActions';
/**
* ----------
* PageHeader
* ----------
*/
export interface PageHeaderProps {
children?: React.ReactNode;
className?: string;
/**
* Callback fired when the content area becomes fully collapsed
*/
onContentFullyCollapsed?: (collapsed: boolean) => void;
/**
* Callback fired when the title becomes clipped
*/
onTitleClipped?: (clipped: boolean) => void;
/**
* Callback fired when the content actions become clipped
*/
onContentActionsClipped?: (clipped: boolean) => void;
}
declare const PageHeader: React.ForwardRefExoticComponent<PageHeaderProps & React.RefAttributes<HTMLDivElement>>;
/**
* -------
* Exports
* -------
*/
declare const Root: React.ForwardRefExoticComponent<PageHeaderProps & React.RefAttributes<HTMLDivElement>>;
declare const BreadcrumbBar: React.ForwardRefExoticComponent<PageHeaderBreadcrumbBarProps & React.RefAttributes<HTMLDivElement>>;
declare const Content: React.ForwardRefExoticComponent<PageHeaderContentProps & React.RefAttributes<HTMLDivElement>>;
declare const ContentPageActions: {
({ className, children, menuButtonLabel, actions, ...other }: PageHeaderContentPageActionsProps): React.JSX.Element;
displayName: string;
propTypes: {
actions: import("prop-types").Requireable<NonNullable<any[] | import("prop-types").ReactNodeLike>>;
children: import("prop-types").Requireable<import("prop-types").ReactNodeLike>;
className: import("prop-types").Requireable<string>;
menuButtonLabel: import("prop-types").Requireable<string>;
};
};
declare const ContentText: {
({ className, children, subtitle, subtitleAs, ...other }: PageHeaderContentTextProps): React.JSX.Element;
displayName: string;
propTypes: {
children: import("prop-types").Requireable<import("prop-types").ReactNodeLike>;
className: import("prop-types").Requireable<string>;
subtitle: import("prop-types").Requireable<string>;
subtitleAs: import("prop-types").Requireable<string>;
};
};
declare const HeroImage: {
({ className, children, objectFit, ...other }: PageHeaderHeroImageProps): React.JSX.Element;
displayName: string;
propTypes: {
children: import("prop-types").Requireable<import("prop-types").ReactNodeLike>;
className: import("prop-types").Requireable<string>;
objectFit: import("prop-types").Requireable<string>;
};
};
declare const TabBar: React.ForwardRefExoticComponent<PageHeaderTabBarProps & React.RefAttributes<HTMLDivElement>>;
declare const ScrollButton: React.ForwardRefExoticComponent<PageHeaderScrollButtonProps & React.RefAttributes<HTMLDivElement>>;
declare const TitleBreadcrumb: React.ForwardRefExoticComponent<import("@carbon/react").BreadcrumbItemProps & React.RefAttributes<HTMLLIElement>>;
declare const BreadcrumbOverflow: React.ForwardRefExoticComponent<PageHeaderBreadcrumbOverflowProps & React.RefAttributes<HTMLElement>>;
declare const TagOverflow: React.ForwardRefExoticComponent<PageHeaderTagOverflowProps & React.RefAttributes<HTMLDivElement>>;
declare const BreadcrumbPageActions: {
({ actions, className, overflowMenuLabel, buttonSize, buttonKind, ...other }: PageHeaderBreadcrumbPageActionsProps): React.JSX.Element;
displayName: string;
propTypes: {
actions: import("prop-types").Validator<NonNullable<import("prop-types").InferProps<{
id: import("prop-types").Validator<string>;
label: import("prop-types").Validator<string>;
renderIcon: import("prop-types").Validator<NonNullable<import("prop-types").ReactComponentLike>>;
onClick: import("prop-types").Requireable<(...args: any[]) => any>;
}>>[]>;
buttonKind: import("prop-types").Requireable<string>;
buttonSize: import("prop-types").Requireable<string>;
className: import("prop-types").Requireable<string>;
overflowMenuLabel: import("prop-types").Requireable<string>;
};
};
export { PageHeader, PageHeaderBreadcrumbBar, PageHeaderContent, PageHeaderContentPageActions, PageHeaderContentText, PageHeaderHeroImage, PageHeaderTabBar, PageHeaderScrollButton, PageHeaderTitleBreadcrumb, PageHeaderBreadcrumbOverflow, PageHeaderTagOverflow, PageHeaderBreadcrumbPageActions, Root, BreadcrumbBar, Content, ContentPageActions, ContentText, HeroImage, TabBar, ScrollButton, TitleBreadcrumb, BreadcrumbOverflow, TagOverflow, BreadcrumbPageActions, };
export type { PageHeaderBreadcrumbBarProps, PageHeaderContentProps, PageHeaderContentPageActionsProps, PageHeaderContentTextProps, PageHeaderHeroImageProps, PageHeaderTabBarProps, PageHeaderScrollButtonProps, PageHeaderTagOverflowProps, PageHeaderBreadcrumbOverflowProps, PageHeaderBreadcrumbPageActionsProps, PageHeaderBreadcrumbPageActionItem, };
//# sourceMappingURL=PageHeader.d.ts.map