nextjs-link-preview/dist/index.d.ts

A simple, lightweight Next.js component for displaying beautiful link preview cards with preset image support

import React from 'react';

/**
 * Simple Link Preview Component
 *
 * Usage with custom image:
 *   <LinkPreview
 *     url="https://example.com"
 *     title="Example"
 *     description="Example description"
 *     image="https://example.com/image.png"
 *   />
 *
 * Usage with preset:
 *   <LinkPreview
 *     url="https://github.com/user/repo"
 *     title="My Repo"
 *     description="A cool repository"
 *     preset="github"
 *   />
 */

type LinkPreviewSize = "small" | "medium" | "large";
type LinkPreviewLayout = "vertical" | "horizontal";
type LinkPreviewPreset = "github" | "npm";
interface LinkPreviewProps {
    url: string;
    title: string;
    description?: string;
    image?: string;
    preset?: LinkPreviewPreset;
    size?: LinkPreviewSize;
    layout?: LinkPreviewLayout;
    width?: string | number;
    height?: string | number;
    className?: string;
}
declare function LinkPreview({ url, title, description, image, preset, size, layout, width, height, className }: LinkPreviewProps): React.JSX.Element;

export { LinkPreview, LinkPreview as default };
export type { LinkPreviewLayout, LinkPreviewPreset, LinkPreviewProps, LinkPreviewSize };