Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

Hierarchy

Index

Properties

ErrorComponent

ErrorComponent: ErrorComponent

Provides the error state component

Optional IdleComponent

IdleComponent: IdleComponent

An idle component to render instead of the resource. This component can for example be used for lazy loading data.

LoadingComponent

LoadingComponent: LoadingComponent

Provides the loading indicator

Optional animate

animate: undefined | false | true

Should we fade into the image

error

error: Error | undefined

Any error that has occured during loading or rendering

Optional fadeDelay

fadeDelay: undefined | number

How long to delay the fade animation between the loading indicator and the image

Optional fadeDuration

fadeDuration: undefined | number

How long the fade should take

Optional fadeEasing

fadeEasing: EasingFunction

The easing to use for the fade

Optional localized

localized: undefined | false | true

node

node: INodeImmutable

Creates the node class for the onPress function

returns

the new derived node from the properties

Optional onDefaultAction

onDefaultAction: DefaultAction

Performs the default tap handling for the resource

progress

progress: number

The loading progress of the implementation

Optional reloadAttempts

reloadAttempts: undefined | number

The number of reloads that are allowed

Optional reloadParameter

reloadParameter: undefined | string

A parameter that is added to the URL when the image is reloaded

reloads

reloads: number

The number of reloads that have occured. Propagated from this component with onReload

showLoading

showLoading: boolean

Detemine if the resource should show the provided loading indicator

Optional theme

theme: ITheme

url

url: UrlAccepted

The location of the asset to load

Methods

onError

  • onError(error: Error): void

Optional onFadeBegin

  • onFadeBegin(): void

Optional onFadeEnd

  • onFadeEnd(): void

Optional onLoad

  • onLoad(resource: I): void
  • Invoked when the resource has completed loading

    Parameters

    • resource: I

      the loaded resource

    Returns void

Optional onProgress

  • onProgress(percentage: number): void
  • Provides progress updates on the loading resource.

    Parameters

    • percentage: number

      values in the range [0, 1]

    Returns void

onReload

  • onReload(attempts: number): void
  • Invoked when the component is reloaded. Should store the state of the attempts and set the reloads property with that value

    Parameters

    • attempts: number

      the number of reload attempts that have occurred

    Returns void

onUnload

  • onUnload(): Promise<void>