Skip to content

Image

This content is for SDK (TypeScript) 0.3.x. Switch to the latest version for up-to-date documentation.

Represents an image asset. It can be used via an Image component.

Reference

Type definitions

type RegisterImage = {
assetType: "jpeg" | "png" | "gif" | "svg" | "auto";
url?: string;
serverPath?: string;
};

Properties

assetType

Image format.

  • Type: "jpeg" | "png" | "gif" | "svg" | "auto"

url

URL for downloading an image. This field cannot be used together with the path field.

  • Type: string

serverPath

Path to an image, specifying its location on the server where Smelter is deployed.

  • Type: string