Image

An image.

Gif of homer simpson retreating into bushes

Import statement

1
2
import ForgeUI, { Image } from '@forge/ui';

Image permissions

Make sure that the image URL is added to the app's manifest file to load the image. For more information on how to declare image sources in an application's manifest file, see image permissions documentation.

Example to add an image URL in the manifest

1
2
permissions:
  external:
    images:
      - 'https://www.example-dev.com/image.png'

Props

Name	Type	Required	Description
`alt`	`string`	Yes	The alternative text displayed if the image is not loaded.
`src`	`string`	Yes	The URL of the image.
`size`	`'xsmall' \| 'small' \| 'medium' \| 'large' \| 'xlarge'`		The size of the image. Defaults to `xlarge`.

Example

1
2
<Image
  src="https://media.giphy.com/media/jUwpNzg9IcyrK/source.gif"
  alt="homer"
/>