@metamask/snaps-sdk
Version:
A library containing the core functionality for building MetaMask Snaps
38 lines • 1.43 kB
text/typescript
import type { AddressElement } from "./Address.mjs";
/**
* The props of the {@link Card} component.
*
* @property image - The image to show as part of the card, must be an SVG string.
* @property title - The title.
* @property description - The description, shown below the title.
* @property value - The value, shown on the right side.
* @property extra - An additional optional value shown below the value.
*/
export type CardProps = {
image?: string | undefined;
title: string | AddressElement;
description?: string | undefined;
value: string;
extra?: string | undefined;
};
/**
* A card component which can be used to display values within a card structure.
*
* @param props - The props of the component.
* @param props.image - The image to show as part of the card, must be an SVG string.
* @param props.title - The title.
* @param props.description - The description, shown below the title.
* @param props.value - The value, shown on the right side.
* @param props.extra - An additional optional value shown below the value.
* @returns A card element.
* @example
* <Card image="<svg />" title="Title" description="Description" value="$1200" extra="0.12 ETH" />
*/
export declare const Card: import("../component.mjs").SnapComponent<CardProps, "Card">;
/**
* A card element.
*
* @see Card
*/
export type CardElement = ReturnType<typeof Card>;
//# sourceMappingURL=Card.d.mts.map