@danilandreev/material-docs/components/Image/Image.d.ts

material-docs - react framework for easy creating documentation site in material design style.

/*
 * Author: Andrieiev Danil |  danssg08@gmail.com | https://github.com/DanilAndreev
 * Copyright (C) 2020.
 */

/// <reference types="react" />
import Stylable from "../../interfaces/Stylable";
import Containerable from "../../interfaces/Containerable";

export const displayName: string;

export interface ImageProps
    extends Stylable, Containerable {
    /**
     * src - src param for inner <img /> component. Path to image or image url.
     * @type: string
     */
    src?: string;
    /**
     * alt - alt param for inner <img /> component. Alternative text to be displayed if the image fails to load.
     * @type: string
     */
    alt?: string;
    /**
     * fullWidth - if true, image will be 100% wide.
     * @type boolean
     * @default false
     */
    fullWidth?: boolean;
    /**
     * children - elements, which will appear in image caption.
     * @type any
     */
    children?: any;
}

/**
 * Image - an image component with lazy load mechanism.
 * @param {ImageProps} props
 * @constructor
 * @see http://material-docs.com/component-apis/image
 * @example
 * <Image src={image1} alt="This text will be displayed if the image is not loaded." fullWidth>
 *     Caption of image
 * </Image>
 */
export default function Image(props: ImageProps): JSX.Element;