At a bare minumim you'll want to include an "icon.icns" file, this icns file can be used for all views where your Element appears within the RapidWeaver Elements UI. Additional Palette and Banner icon styles are also available.

Standard Icon

All Elements require this icon.

  • icon.icns (Required)

  • icon-dark.icns (optional)

Supported image sizes in the icon.icns file.

  • 16x16.png / 16x16@2x.png

  • 32x32.png / 32x32@2x.png

  • 128x128.png / 128x128@2x.png

  • 256x256.png / 256x256@2x.png (optional)

  • 512x512.png / 512x512@2x.png (optional)

We recommend Icon Slate to compile .icns files.

Palette Icons

The Palette image should be named paletteIcon.png and paletteIcon-dark.png if you'd also like to display a different version in dark mode.

  • paletteIcon.png

  • paletteIcon-dark.png (optional)

Supported palette image sizes.

  • 512x256

If you're developing an Element that represents a layout we recommend using the Banner style icon.

  • bannerLayer1.png

  • bannerLayer1-Dark.png (optional)

Banner icons can be layered, and each layer can represent a different colour in the Theme Studio. For example this icon uses four layers and three of those layers will be tinted with the Theme colour.

  • bannerLayer1.png

  • bannerLayer2-primary-500.png

  • bannerLayer3-primary-200.png

  • bannerLayer4-secondary-500.png

Banner images should be 512px in width, but can be as short or tall as you need.

List View Icon (Standard Icon)

Grid View (Pallete Icon)

Grid and List View (Banner Icon)

Banner icons will appear the same in both grid and list.

Asset Placement

All Icon files should be placed at the root of the Element alongside the info.json file.

Last updated

We are Realmac Software. We make nice things.