Interface ImageURISource

Copyright (c) Meta Platforms, Inc. and affiliates.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree.

Format

interface ImageURISource {
    body?: string;
    bundle?: string;
    cache?: "default" | "reload" | "force-cache" | "only-if-cached";
    headers?: {
        [key: string]: string;
    };
    height?: number;
    method?: string;
    scale?: number;
    uri?: string;
    width?: number;
}

Properties

body? bundle? cache? headers? height? method? scale? uri? width?

Properties

Optional body

body?: string

body is the HTTP body to send with the request. This must be a valid UTF-8 string, and will be sent exactly as specified, with no additional encoding (e.g. URL-escaping or base64) applied.

Optional bundle

bundle?: string

bundle is the iOS asset bundle which the image is included in. This will default to [NSBundle mainBundle] if not set.

Platform

ios

Optional cache

cache?: "default" | "reload" | "force-cache" | "only-if-cached"

cache determines how the requests handles potentially cached responses.

  • default: Use the native platforms default strategy. useProtocolCachePolicy on iOS.

  • reload: The data for the URL will be loaded from the originating source. No existing cache data should be used to satisfy a URL load request.

  • force-cache: The existing cached data will be used to satisfy the request, regardless of its age or expiration date. If there is no existing data in the cache corresponding the request, the data is loaded from the originating source.

  • only-if-cached: The existing cache data will be used to satisfy a request, regardless of its age or expiration date. If there is no existing data in the cache corresponding to a URL load request, no attempt is made to load the data from the originating source, and the load is considered to have failed.

Platform

ios

Optional headers

headers?: {
    [key: string]: string;
}

headers is an object representing the HTTP headers to send along with the request for a remote image.

Type declaration

  • [key: string]: string

Optional height

height?: number

Optional method

method?: string

method is the HTTP Method to use. Defaults to GET if not specified.

Optional scale

scale?: number

scale is used to indicate the scale factor of the image. Defaults to 1.0 if unspecified, meaning that one image pixel equates to one display point / DIP.

Optional uri

uri?: string

uri is a string representing the resource identifier for the image, which could be an http address, a local file path, or the name of a static image resource (which should be wrapped in the require('./path/to/image.png') function).

Optional width

width?: number

width and height can be specified if known at build time, in which case these will be used to set the default <Image/> component dimensions.

On This Page