baseui/card/types.d.ts

A React Component library implementing the Base design language

import type { ReactNode } from 'react';
import type { Override } from '../helpers/overrides';
export type CardOverrides = {
    Action?: Override;
    Body?: Override;
    Contents?: Override;
    HeaderImage?: Override;
    Root?: Override;
    Thumbnail?: Override;
    Title?: Override;
};
export type ImageProps = {
    alt?: string;
    complete?: boolean;
    crossOrigin?: string;
    currentSrc?: string;
    height?: number;
    decode?: Promise<void>;
    isMap?: boolean;
    naturalHeight?: number;
    naturalWidth?: number;
    sizes?: string;
    src?: string;
    srcSet?: string;
    useMap?: string;
    width?: number;
};
export type CardProps = {
    /** Contents to be rendered at the bottom of the Card. Used to organize UI which enables user action. */
    readonly action?: ReactNode;
    /** Content to be rendered within the Card body. */
    readonly children?: ReactNode;
    /** Function that takes Card props and returns a boolean that represents if a thumbnail will be rendered. */
    readonly hasThumbnail?: (a: {
        readonly thumbnail?: string;
    }) => boolean;
    /** Image to be positioned at the top of the Card. Can be a string representing the img src or an object with img attrs */
    readonly headerImage?: string | ImageProps;
    readonly overrides: CardOverrides;
    /** Image src that by default is rendered to the side of children content. */
    readonly thumbnail?: string;
    /** Content to render above the body content. */
    readonly title?: ReactNode;
};