Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

Hierarchy

  • object
    • IProps

Index

Properties

Optional animate

animate: undefined | false | true

Should the component animate the height when the size is known

Optional aspect

aspect: undefined | number

The aspect ratio to render the content at. The component will always fill the full width of the parent container. Without the aspect set the component will transition to the correct aspect ratio once the dimensions of the resource are loaded

dimensions

dimensions: IWidthHeight | undefined

The dimensions of the media. Should be populated once known via asynchronous loading

Optional scaleDelay

scaleDelay: undefined | number

Delays the scaling animation

Optional scaleDuration

scaleDuration: undefined | number

The length of the scaling animation

Optional scaleEasing

scaleEasing: EasingFunction

The easing to use for the scaling

Optional theme

theme: ITheme

The theme for the component, used for animation properties

Methods

Optional onScaleBegin

  • onScaleBegin(): void

Optional onScaleEnd

  • onScaleEnd(): void

onSize

  • onSize(dimensions: IWidthHeight): void
  • This will be invoked when the layout of the media in viewport pixels is known. This will always represent the correct aspect ratio and can be used to instruct the media to render at this layout

    Parameters

    • dimensions: IWidthHeight

    Returns void