@carbon/ibm-products
Version:
Carbon for IBM Products
80 lines • 3.66 kB
TypeScript
import React, { ReactNode } from 'react';
import PropTypes from 'prop-types';
interface CardHeaderProps {
actions?: ReactNode;
/**
* Optional prop that allows you to pass any component.
*/
decorator?: ReactNode | boolean;
description?: ReactNode;
hasActions?: boolean;
/**
* is the host card clickable
*/
inClickableCard?: boolean;
label?: ReactNode;
noActionIcons?: boolean;
onPrimaryButtonClick?: () => void;
onSecondaryButtonClick?: () => void;
primaryButtonDisabled?: boolean;
primaryButtonIcon?: React.ElementType;
primaryButtonPlacement?: 'top' | 'bottom';
primaryButtonText?: string;
secondaryButtonDisabled?: boolean;
secondaryButtonHref?: string;
secondaryButtonIcon?: React.ElementType;
secondaryButtonKind?: 'secondary' | 'ghost';
secondaryButtonPlacement?: 'top' | 'bottom';
secondaryButtonText?: string;
/**
* **Experimental:** For all cases a `Slug` component can be provided.
* Clickable tiles only accept a boolean value of true and display a hollow slug.
* @deprecated please use the `decorator` prop
*/
slug?: ReactNode;
title?: ReactNode;
titleSize?: 'default' | 'large';
}
export declare const CardHeader: {
({ actions, decorator, noActionIcons, onPrimaryButtonClick, onSecondaryButtonClick, primaryButtonIcon, primaryButtonPlacement, primaryButtonText, primaryButtonDisabled, description, hasActions, inClickableCard, label, secondaryButtonDisabled, secondaryButtonHref, secondaryButtonIcon, secondaryButtonPlacement, secondaryButtonText, slug, title, titleSize, }: CardHeaderProps): React.JSX.Element;
/**@ts-ignore */
propTypes: {
actions: PropTypes.Requireable<NonNullable<any[] | PropTypes.ReactNodeLike>>;
/**
* Optional prop that allows you to pass any component.
*/
decorator: PropTypes.Requireable<NonNullable<PropTypes.ReactNodeLike>>;
description: PropTypes.Requireable<NonNullable<object | PropTypes.ReactNodeLike>>;
hasActions: PropTypes.Requireable<boolean>;
/**
* is the host card clickable
*/
inClickableCard: PropTypes.Requireable<boolean>;
label: PropTypes.Requireable<string>;
noActionIcons: PropTypes.Requireable<boolean>;
onPrimaryButtonClick: PropTypes.Requireable<(...args: any[]) => any>;
onSecondaryButtonClick: PropTypes.Requireable<(...args: any[]) => any>;
primaryButtonDisabled: PropTypes.Requireable<boolean>;
primaryButtonIcon: PropTypes.Requireable<object>;
primaryButtonPlacement: PropTypes.Requireable<string>;
primaryButtonText: PropTypes.Requireable<string>;
secondaryButtonDisabled: PropTypes.Requireable<boolean>;
secondaryButtonHref: PropTypes.Requireable<string>;
secondaryButtonIcon: PropTypes.Requireable<object>;
secondaryButtonKind: PropTypes.Requireable<string>;
secondaryButtonPlacement: PropTypes.Requireable<string>;
secondaryButtonText: PropTypes.Requireable<string>;
/**
* **Experimental:** For all cases a `Slug` component can be provided.
* Clickable tiles only accept a boolean value of true and display a hollow slug.
* @deprecated please use the `decorator` prop
*/
slug: PropTypes.Requireable<NonNullable<PropTypes.ReactNodeLike>>;
title: PropTypes.Requireable<NonNullable<object | PropTypes.ReactNodeLike>>;
titleSize: PropTypes.Requireable<string>;
};
/**@ts-ignore */
displayName: string;
};
export {};
//# sourceMappingURL=CardHeader.d.ts.map