@carbon/ibm-products
Version:
Carbon for IBM Products
47 lines • 1.58 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 { Heading } from '@carbon/react';
import { type PageHeaderObserverState } from './context';
/**
* -----------------
* PageHeaderContent
* -----------------
*/
export interface PageHeaderContentProps {
/**
* Provide child elements to be rendered inside PageHeaderContent.
*/
children?: React.ReactNode;
/**
* Specify an optional className to be added to your PageHeaderContent
*/
className?: string;
/**
* Provide an optional icon to render in front of the PageHeaderContent's title.
*/
renderIcon?: ComponentType | FunctionComponent;
/**
* The PageHeaderContent's title
*/
title: string;
/**
* Specify the element or component used to render the title.
*/
titleAs?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | typeof Heading;
/**
* The PageHeaderContent's contextual actions
*/
contextualActions?: React.ReactNode;
/**
* The PageHeaderContent's page actions.
* Can be a ReactNode or a function that receives observer state.
*/
pageActions?: React.ReactNode | ((state: PageHeaderObserverState) => React.ReactNode);
}
export declare const PageHeaderContent: React.ForwardRefExoticComponent<PageHeaderContentProps & React.RefAttributes<HTMLDivElement>>;
//# sourceMappingURL=PageHeaderContent.d.ts.map