carbon-react
Version:
A library of reusable React components for easily building user interfaces.
30 lines (29 loc) • 1.13 kB
TypeScript
import React from "react";
import { TagProps } from "../../__internal__/utils/helpers/tags";
interface ImageShape {
/** The url string to be passed to image src */
url: string;
/** The string to be passed to image alt */
alt?: string;
}
export interface LinkPreviewProps extends TagProps {
/** Used to set the root element to either an anchor link or div container */
as?: "a" | "div";
/** The description to be displayed */
description?: string;
/** The config for the image to be displayed */
image?: ImageShape;
/** Flag to trigger the loading animation */
isLoading?: boolean;
/** The callback to handle the deleting of a Preview, to hide the close button do not set this prop */
onClose?: (url?: string) => void;
/** The title to be displayed */
title?: string;
/** The url string to be displayed and to serve as the link's src */
url?: string;
}
export declare const LinkPreview: {
({ as, description, image, isLoading, onClose, title, url, ...rest }: LinkPreviewProps): React.JSX.Element;
displayName: string;
};
export default LinkPreview;