summit-kit
Version:
A React component library for building modern web applications with with an earthy and outdoorsy flair.
25 lines (24 loc) • 1.15 kB
TypeScript
type ImageProps = {
src: string;
alt: string;
width: number | string;
} & React.ImgHTMLAttributes<HTMLImageElement>;
/**
* Renders an image element with the provided source, alternative text, width, and additional props.
*
* @param props - The properties for the image component.
* @param props.src - The source URL of the image.
* @param props.alt - The alternative text for the image. Defaults to "This is not the image you're looking for...".
* @param props.width - The width of the image (optional).
* @param props.rest - Additional props to be spread onto the image element.
* @returns A React `<img>` element with the specified attributes.
*/
export declare const Image: (props: ImageProps) => import("react/jsx-runtime").JSX.Element;
/**
* Renders an image wrapped in a <figure> element with a <figcaption> displaying the image's alt text.
*
* @param props - The properties for the image, including `src`, `alt`, `width`, and any additional props.
* @returns A React element containing the image and its caption.
*/
export declare const Figure: (props: ImageProps) => import("react/jsx-runtime").JSX.Element;
export {};