@nex-ui/react/dist/types/components/card/types.d.ts

🎉 A beautiful, modern, and reliable React component library.

import { ElementType, ReactNode } from 'react';
import { Interpolation } from '@nex-ui/system';
import { ClassValue } from 'clsx';
import { OverrideProps, ComponentSlotClasses, ComponentPropsWithCommonProps } from '../../types/utils.js';
import { CardVariants } from '../../theme/recipes/card.js';

interface CardPropsOverrides {
}
type CardOwnProps<RootComponent extends ElementType> = {
    /**
     * Usually, CardHeader, CardBody, CardFooter, and other custom content.
     */
    children?: ReactNode;
    /**
     * The component or element to render as the root.
     *
     * @default 'div'
     */
    as?: RootComponent;
    /**
     * Additional class names to apply to the root.
     */
    className?: ClassValue;
    /**
     * The system prop that allows defining system overrides as well as additional CSS styles.
     */
    sx?: Interpolation;
    /**
     * The shadow of the Card.
     *
     * @default 'md'
     */
    shadow?: CardVariants['shadow'];
    /**
     * The border radius of the Card.
     *
     * @default 'md'
     */
    radius?: CardVariants['radius'];
    /**
     * If true, applies a backdrop filter to the Card.
     */
    blurred?: boolean;
    /**
     * If true, the Card will have a hover effect.
     */
    hoverable?: boolean;
};
type CardProps<RootComponent extends ElementType = 'div'> = OverrideProps<RootComponent, CardOwnProps<RootComponent>, CardPropsOverrides>;
type CardHeaderSlotProps = {
    content?: ComponentPropsWithCommonProps<'div'>;
    title?: ComponentPropsWithCommonProps<'div'>;
    subtitle?: ComponentPropsWithCommonProps<'div'>;
};
type CardHeaderOwnProps<RootComponent extends ElementType> = {
    /**
     * The content of the CardHeader, which disables the avatar, action, title, and subtitle props.
     */
    children?: ReactNode;
    /**
     * The component or element to render as the root.
     * @default 'div'
     */
    as?: RootComponent;
    /**
     * The system prop that allows defining system overrides as well as additional CSS styles.
     */
    sx?: Interpolation;
    /**
     * The title of the CardHeader.
     */
    title?: ReactNode;
    /**
     * The subtitle of the CardHeader.
     */
    subtitle?: ReactNode;
    /**
     * The avatar of the CardHeader.
     */
    avatar?: ReactNode;
    /**
     * The action area of the CardHeader.
     */
    action?: ReactNode;
    /**
     * Additional class names to apply to the root.
     */
    className?: ClassValue;
    /**
     * The className used for each slot.
     */
    classNames?: ComponentSlotClasses<keyof CardHeaderSlotProps>;
    /**
     * The props used for each slot.
     */
    slotProps?: CardHeaderSlotProps;
};
interface CardHeaderPropsOverrides {
}
type CardHeaderProps<RootComponent extends ElementType = 'div'> = OverrideProps<RootComponent, CardHeaderOwnProps<RootComponent>, CardHeaderPropsOverrides>;
type CardBodyOwnProps<RootComponent extends ElementType> = {
    /**
     * The component or element to render as the root.
     * @default 'div'
     */
    as?: RootComponent;
    /**
     * The system prop that allows defining system overrides as well as additional CSS styles.
     */
    sx?: Interpolation;
    /**
     * Additional class names to apply to the root.
     */
    className?: ClassValue;
    /**
     * The content of the CardBody.
     */
    children?: ReactNode;
};
interface CardBodyPropsOverrides {
}
type CardBodyProps<RootComponent extends ElementType = 'div'> = OverrideProps<RootComponent, CardBodyOwnProps<RootComponent>, CardBodyPropsOverrides>;
type CardFooterOwnProps<RootComponent extends ElementType> = {
    /**
     * The component or element to render as the root.
     * @default 'div'
     */
    as?: RootComponent;
    /**
     * The system prop that allows defining system overrides as well as additional CSS styles.
     */
    sx?: Interpolation;
    /**
     * Additional class names to apply to the root.
     */
    className?: ClassValue;
    /**
     * The content of the CardFooter.
     */
    children?: ReactNode;
};
interface CardFooterPropsOverrides {
}
type CardFooterProps<RootComponent extends ElementType = 'div'> = OverrideProps<RootComponent, CardFooterOwnProps<RootComponent>, CardFooterPropsOverrides>;
interface CardActionAreaPropsOverrides {
}
type CardActionAreaOwnProps<RootComponent extends ElementType> = {
    /**
     * The component or element to render as the root.
     * @default 'button'
     */
    as?: RootComponent;
    /**
     * The system prop that allows defining system overrides as well as additional CSS styles.
     */
    sx?: Interpolation;
    /**
     * If `true`, the component is disabled.
     */
    disabled?: boolean;
    /**
     * Additional class names to apply to the root.
     */
    className?: ClassValue;
};
type CardActionAreaProps<RootComponent extends ElementType = 'button'> = OverrideProps<RootComponent, CardActionAreaOwnProps<RootComponent>, CardActionAreaPropsOverrides>;

export type { CardActionAreaProps, CardActionAreaPropsOverrides, CardBodyProps, CardBodyPropsOverrides, CardFooterProps, CardFooterPropsOverrides, CardHeaderProps, CardHeaderPropsOverrides, CardProps, CardPropsOverrides };