UNPKG

2.46 kBTypeScriptView Raw
1import * as React from 'react';
2import { OUIAProps } from '../../helpers';
3export interface CardProps extends React.HTMLProps<HTMLElement>, OUIAProps {
4 /** Content rendered inside the Card */
5 children?: React.ReactNode;
6 /** ID of the Card. Also passed back in the CardHeader onExpand callback. */
7 id?: string;
8 /** Additional classes added to the Card */
9 className?: string;
10 /** Sets the base component to render. defaults to article */
11 component?: keyof JSX.IntrinsicElements;
12 /** @deprecated to make a card hoverable, use isSelectable or isSelectableRaised. */
13 isHoverable?: boolean;
14 /** Modifies the card to include compact styling. Should not be used with isLarge. */
15 isCompact?: boolean;
16 /** Modifies the card to include selectable styling */
17 isSelectable?: boolean;
18 /** @beta Specifies the card is selectable, and applies the new raised styling on hover and select */
19 isSelectableRaised?: boolean;
20 /** Modifies the card to include selected styling */
21 isSelected?: boolean;
22 /** @beta Modifies a raised selectable card to have disabled styling */
23 isDisabledRaised?: boolean;
24 /** Modifies the card to include flat styling */
25 isFlat?: boolean;
26 /** Modifies the card to include rounded styling */
27 isRounded?: boolean;
28 /** Modifies the card to be large. Should not be used with isCompact. */
29 isLarge?: boolean;
30 /** Cause component to consume the available height of its container */
31 isFullHeight?: boolean;
32 /** Modifies the card to include plain styling; this removes border and background */
33 isPlain?: boolean;
34 /** Flag indicating if a card is expanded. Modifies the card to be expandable. */
35 isExpanded?: boolean;
36 /** Flag indicating that the card should render a hidden input to make it selectable */
37 hasSelectableInput?: boolean;
38 /** Aria label to apply to the selectable input if one is rendered */
39 selectableInputAriaLabel?: string;
40 /** Callback that executes when the selectable input is changed */
41 onSelectableInputChange?: (labelledBy: string, event: React.FormEvent<HTMLInputElement>) => void;
42}
43interface CardContextProps {
44 cardId: string;
45 registerTitleId: (id: string) => void;
46 isExpanded: boolean;
47}
48export declare const CardContext: React.Context<Partial<CardContextProps>>;
49export declare const Card: React.FunctionComponent<CardProps>;
50export {};
51//# sourceMappingURL=Card.d.ts.map
\No newline at end of file