BlazeWidgetItemBadgeStyle - iOS

The BlazeWidgetItemBadgeStyle struct represents the configuration for the badge of a widget item.

Content can also carry its own badge image, set per Story, Moment, or Video in the CMS. That image replaces the background image in every state and shows the badge even when it's hidden here, while the rest of this style still applies. The badge appears once the image has loaded. If the image fails to load, the badge stays hidden for that item.

Properties

position

var position: BlazeObjectPositioning

The position of the badge Relative To The Image within the widget item.

This setting enables the badge to be positioned in predefined places like the top-right corner, bottom-left corner, etc., ensuring optimal visibility and aesthetic alignment with the item's layout.

isVisible

var isVisible: Bool

A Boolean value that determines whether the badge is visible.

When set to true, the badge is shown; when false, it's hidden. This flexibility allows dynamic UI updates based on user interactions or specific conditions.

Setting it to false will hide the badge for all of the widget item states.

📘

Content with its own badge image from the CMS shows the badge regardless of this value.

insets

var insets: NSDirectionalEdgeInsets = .zero

An NSDirectionalEdgeInsets value that defines the insets for the badge related to the widget item container.

Specifies the padding around the badge within its container, providing control over its placement. Insets can be used to adjust the badge's position relative to the widget item's edges, offering finer layout control.

📘

The NSDirectionalEdgeInsets property insets set to .zero means that the padding around the content or element within its container is zero on all sides (top, leading, bottom, and trailing). This effectively means there will be no additional space between the content or element and its container's edges.

liveUnreadState

var liveUnreadState: BlazeWidgetItemBadgeStateStyle

The style configuration for the live unread badge.

liveReadState

var liveReadState: BlazeWidgetItemBadgeStateStyle

The style configuration for the live read badge.

unreadState

var unreadState: BlazeWidgetItemBadgeStateStyle

The style configuration for the unread badge.

readState

var readState: BlazeWidgetItemBadgeStateStyle

The style configuration for the read badge.