office-ui-fabric-react
Version:
Reusable React components for building experiences for Office 365.
47 lines (46 loc) • 1.77 kB
TypeScript
import * as React from 'react';
export interface IImageProps extends React.HTMLProps<HTMLImageElement> {
/**
* If true, adds the css class 'is-fadeIn' to the image.
*/
shouldFadeIn?: boolean;
/**
* If provided, adds the indicated css class to the image.
*/
className?: string;
/**
* Used to determine how the image is scaled and cropped to fit the frame.
*
* @default If both dimensions are provided, then the image is fit using ImageFit.scale. Otherwise, the image won't be scaled or cropped.
*/
imageFit?: ImageFit;
/**
* Image source to display if an error occurs loading the image indicated by src.
*/
errorSrc?: string;
}
/**
* The possible methods that can be used to fit the image.
*/
export declare enum ImageFit {
/**
* The image is not scaled. The image is centered and cropped within the content box.
*/
center = 0,
/**
* The image is scaled to maintain its aspect ratio while being fully contained within the frame. The image will
* be centered horizontally and vertically within the frame. The space in the top and bottom or in the sides of
* the frame will be empty depending on the difference in aspect ratio between the image and the frame.
*/
contain = 1,
/**
* The image is scaled to maintain its aspect ratio while filling the frame. Portions of the image will be cropped from
* the top and bottom, or from the sides, depending on the difference in aspect ratio between the image and the frame.
*/
cover = 2,
/**
* Neither the image nor the frame are scaled. If their sizes do not match, the image will either be cropped or the
* frame will have empty space.
*/
none = 3,
}