@carbon/ibm-products/lib/components/GetStartedCard/GetStartedCard.d.ts

Carbon for IBM Products

/**
 * Copyright IBM Corp. 2024, 2024
 *
 * 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, { PropsWithChildren, ReactNode } from 'react';
type MetaData = {
    id?: string;
    icon?: () => ReactNode;
    iconDescription?: string;
};
export interface GetStartedCardProps extends PropsWithChildren {
    /**
     * Provide an optional class to be applied to the containing node.
     */
    className?: string;
    /**
     * Optional if the card should be disabled
     */
    disabled?: boolean;
    /**
     * Provides the action icon that's displayed at the footer of the card
     */
    footerActionIcon: React.ElementType;
    /**
     * Optional label for the top of the card
     */
    label?: ReactNode;
    /**
     * Optional media content like an image to be placed in the card
     */
    media?: ReactNode;
    /**
     * Icons that are displayed on the card showing the time and skill needed
     */
    metadata: readonly MetaData[];
    /**
     * Provides the callback for a clickable card
     */
    onClick?: () => void;
    /**
     * Provides the icon that's displayed at the top of the card
     */
    pictogram?: () => ReactNode;
    /**
     * Provides number for card for tasks in a sequential order
     */
    sequence?: number;
    /**
     * Provides the status that's displayed at the top of the card
     */
    status?: 'complete' | 'incomplete';
    /**
     * Title that's displayed at the top of the card
     */
    title?: ReactNode;
}
/**
 * GetStartedCard a card with icon, number, and media variants
 */
export declare let GetStartedCard: React.ForwardRefExoticComponent<GetStartedCardProps & React.RefAttributes<HTMLDivElement>>;
export {};