Skip to main content

IResource

A file-based item, such as an icon or an image.
Every resource type implements this interface.

Properties

PropertyTypeDescription
IdstringThe unique identifier of the resource.
AltstringOptional alternative text displayed if the resource fails to load.

Specific Types

Icon

A small graphic image.
An icon may consist of multiple image files (e.g., PNG, JPEG) to support different sizes.

tip

Best Practice: For the best visual result, always provide a single SVG file whenever possible.

Properties

PropertyTypeDescription
IdstringThe unique identifier of the icon.
Altstring?Optional alternative text displayed if the icon fails to load.
RelativeFilePathsIDictionary<IconSize, string>The relative paths to image files for all supported icon sizes.

Icon Sizes

The available sizes for an icon:

  • Small
  • Default
  • Large

Image

A larger image or picture.
Unlike an Icon, an image consists of a single file and does not support multiple sizes.

Properties

PropertyTypeDescription
IdstringThe unique identifier of the image.
Altstring?Optional alternative text displayed if the image fails to load.
RelativeFilePathstringThe relative path to the image file.