Interface ImageLoaderProps

Hierarchy

Properties

alt? backgroundColor? fallbackSrc? foregroundColor? height? imageClassName? imageTimeout? imgHeight? imgSrc? imgWidth? loadingSkeleton? onError? onImageClick? onLoad? speed? viewBox? width?

Properties

Optional alt

alt?: string

Image's alt attribute

Optional backgroundColor

backgroundColor?: string

Loader's background color (default: '#CCCCCC')

Optional fallbackSrc

fallbackSrc?: string

Fallback image url to load in case of load failure. If not set, a fallback background color will be used

Optional foregroundColor

foregroundColor?: string

Loader's foreground color (default: '#EEECEC')

Optional height

height?: number

Image loader height (default: 50)

Optional imageClassName

imageClassName?: string

CSS Class name for additional img element styles

Optional imageTimeout

imageTimeout?: number

Specify the amount of time the component should wait for the image source to arrive before rendering the fallback, in milliseconds (default: 2000). If the image manages to load at a later time, the image will be rendered

Optional imgHeight

imgHeight?: string | number

Image height (default: undefined)

Optional imgSrc

imgSrc?: string

Image's url

Optional imgWidth

imgWidth?: string | number

Image width (default: undefined)

Optional loadingSkeleton

loadingSkeleton?: ReactNode

SVGRectElement used as the loading animation. If set, will replace the default SVGRectElement

Optional onError

onError?: ((src?) => void)

Type declaration

    • (src?): void

    • Callback emitted after the image has failed to load. Img src is sent back

      Parameters

      • Optional src: string

      Returns void

Optional onImageClick

onImageClick?: ((event) => void)

Type declaration

    • (event): void

    • Callback emitted when the image element is clicked

      Parameters

      • event: MouseEvent<HTMLImageElement, MouseEvent>

      Returns void

Optional onLoad

onLoad?: ((src?) => void)

Type declaration

    • (src?): void

    • Callback emitted after the image has successfully loaded. Img src is sent back

      Parameters

      • Optional src: string

      Returns void

Optional speed

speed?: number

Animation speed (default: 2)

Optional viewBox

viewBox?: string

SVG's viewbox (defaults to a view box matching the given height and width), adjust this change the skeleton's rendering

Optional width

width?: number

Image loader width (default: 50)

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc