Custom Content Icons

Defines icons that used for displaying the custom content.

1
2
3
4
5
6
7
8
{
  "item": {
    "width": 16,
    "height": 16,
    "url": "/item.png"
  }
}

Properties

item
Type
Required
Yes
Description

Defines an icon that used for displaying a single custom content item in:

  • View attachments screen when the custom content is contained in a page.
  • Result entry of site search.
  • Result entry of quick search.
The icon resource provided in this field must be larger or equals to 16x16 pixels.

Defines an icon to display.

Example

1
2
3
4
5
6
7
8
{
  "icon": {
    "width": 16,
    "height": 16,
    "url": "/my-icon.png"
  }
}

Properties

url
Type
Format
uri
Required
Yes
Description

The URL of the icon. Your icon needs to be hosted remotely at a web-accessible location. You can specify the URL as an absolute URL or relative to the add-on's base URL.

height
Type
Description

The height in pixels of the icon image.

width
Type
Description

The width in pixels of the icon image.

create
Type
Description

Defines an icon that is used for custom content items in the create dialog.
The icon resource provided in this field must be larger or equals to 48x48 pixels.
It will fallback to item icon if this field is not specified. In that case, please ensure the item icon is larger or equals to 48x48 pixels.

Defines an icon to display.

Example

1
2
3
4
5
6
7
8
{
  "icon": {
    "width": 16,
    "height": 16,
    "url": "/my-icon.png"
  }
}

Properties

url
Type
Format
uri
Required
Yes
Description

The URL of the icon. Your icon needs to be hosted remotely at a web-accessible location. You can specify the URL as an absolute URL or relative to the add-on's base URL.

height
Type
Description

The height in pixels of the icon image.

width
Type
Description

The width in pixels of the icon image.

list
Type
Description

Defines an icon that used for displaying list of custom content items in:

  • Space sidebar if this custom content is allowed to be contained in space.
The icon resource provided in this field must be larger or equals to 20x20 pixels.
It will fallback to item icon if this field is not specified. In that case, please ensure the item icon is larger or equals to 20x20 pixels.

Defines an icon to display.

Example

1
2
3
4
5
6
7
8
{
  "icon": {
    "width": 16,
    "height": 16,
    "url": "/my-icon.png"
  }
}

Properties

url
Type
Format
uri
Required
Yes
Description

The URL of the icon. Your icon needs to be hosted remotely at a web-accessible location. You can specify the URL as an absolute URL or relative to the add-on's base URL.

height
Type
Description

The height in pixels of the icon image.

width
Type
Description

The width in pixels of the icon image.

Rate this page: