Image

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

Note

The auto option under asset_type allows for automatic determination of the image format based on the file’s content itself.

Reference

Type definition

type Image = {
  asset_type: "jpeg" | "png" | "gif" | "svg" | "auto";
  url?: string;
  path?: string;
};

Properties

asset_type

Format of an image.

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

---

url

Url to download an image. This field is mutually exclusive with the path field.

• Type: string

---

path

Path to an image. This field is mutually exclusive with the url field.

• Type: string