@carbon/ibm-products
Version:
Carbon for IBM Products
50 lines • 1.68 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 from 'react';
import PropTypes from 'prop-types';
/**
* ----------------
* PageHeaderHeroImage
* ----------------
*/
export interface PageHeaderHeroImageProps {
/**
* Provide child elements to be rendered inside PageHeaderHeroImage.
*/
children?: React.ReactNode;
/**
* Specify an optional className to be added to your PageHeaderHeroImage
*/
className?: string;
/**
* Specify how the image should fit within the container.
* - 'cover': Image fills container, may crop edges (default for hero images)
* - 'contain': Image fits within container, may show empty space
* - 'fill': Image stretches to fill container
* - 'none': Image uses its natural size
*/
objectFit?: 'cover' | 'contain' | 'fill' | 'none';
}
export declare const PageHeaderHeroImage: {
({ className, children, objectFit, ...other }: PageHeaderHeroImageProps): React.JSX.Element;
displayName: string;
propTypes: {
/**
* Provide child elements to be rendered inside PageHeaderHeroImage.
*/
children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
/**
* Specify an optional className to be added to your PageHeaderHeroImage
*/
className: PropTypes.Requireable<string>;
/**
* Specify how the image should fit within the container.
*/
objectFit: PropTypes.Requireable<string>;
};
};
//# sourceMappingURL=PageHeaderHeroImage.d.ts.map