GuidesAPI ReferenceRelease Notes
HomeLog InHome
Guides

Widget item image

Widget item image settings control position, size, and related image presentation on each widget item.

API reference: iOS | Android | React Native. For the widget appearance set, see Widget appearance.

WidgetItemImage properties

NameDescriptionTypeDefault value
positionImage positionWidgetItemImage.Position.center
insetsInsetsInsets.zero
widthWidth of the imageFloat?null
heightHeight of the imageFloat?null
ratioAspect ratio of the imageFloat?null
borderImage container border settingsWidgetItemImageContainerBorderDefault settings
cornerRadiusCorner radiusFloat0
cornerRadiusRatioCorner radius ratioFloat?null
thumbnailTypeEnum describing thumbnail typeThumbnailTypeSquare icon

WidgetItemImageContainerBorder

NameDescriptionTypeDefault value
isVisibleBorder visibilityBooltrue
liveUnreadBorderLive unread border styleWidgetItemImageContainerBorderStyleDefault settings
liveReadBorderLive read border styleWidgetItemImageContainerBorderStyleDefault settings
unreadBorderUnread border styleWidgetItemImageContainerBorderStyleDefault settings
readBorderRead border styleWidgetItemImageContainerBorderStyleDefault settings

WidgetItemImageContainerBorderStyle

NameDescriptionTypeDefault value
isVisibleBorder style visibilityBooltrue
colorBorder colorUIColorVaries (see below)
insetsBorder insetsCGFloat5
widthBorder widthCGFloat3

Default Border Colors

Border styleDefault color
liveUnreadBorder.red
liveReadBorder.gray
unreadBorder.blue
readBorder.gray

Did this page help you?