GuidesAPI ReferenceRelease Notes
HomeLog InHome
Guides

Widget item status indicator

The status indicator shows read, unread, or live state on a widget item. Use it with Chips and badges when you need live or context labels beyond the default indicator.

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

When an item counts as read

Each indicator state renders text from its own text property. The default text is NEW for unread and READ for read, and you can set any string per state. The rules below determine which state an item is in, and therefore which text a viewer sees.

The SDK tracks read state per viewer in its local database. Read state does not expire: an item stays read once the viewer meets the condition for its content type, and no elapsed-time rule returns it to unread.

Content typeBecomes read when
StoriesThe viewer views the last page that doesn't set ignoreReadStatusForStory. See the story note below.
MomentsThe viewer opens the Moment.
VideosDepends on the platform. See the video note below.

Stories

A story is read when its last page that doesn't set ignoreReadStatusForStory is read. Pages that set the flag, such as outro pages, don't gate the story's read state on their own, with these exceptions:

  • When every page in the story sets ignoreReadStatusForStory, the story is read only after all of those pages are read.
  • When a story has no pages, the story is unread.

Videos

Video read state differs by platform:

  • iOS and Android: the video is read after playback reaches the end of the video. Partial playback stores a resume position, which doesn't mark the video read.
  • Web: the video is read when playback starts.

A viewer who abandons a video partway through leaves it unread on iOS and Android, and read on Web.

Read state is one-way

Read state never reverts to unread on its own. Once an item is read for a viewer, later syncs preserve that state.

To order items by read state in a widget, see Ordering and item limits. To hide read content, see Experiences FAQ.

WidgetItemStatusIndicator

The WidgetItemStatusIndicator class allows you to customize the following properties:

NameDescriptionTypeDefault value
positionStatus indicator positionBlazeObjectPositioningBottom trailing
insetsInsetsInsetsZero
statusTitlePaddingStatus title paddingInsetstop: 4, leading: 4, bottom: 4, trailing: 4
isVisibleVisibility of status indicatorBooltrue
liveUnreadIndicatorLive unread indicator styleWidgetItemIndicatorStyleDefault settings
liveReadIndicatorLive read indicator styleWidgetItemIndicatorStyleDefault settings
unreadIndicatorUnread indicator styleWidgetItemIndicatorStyleDefault settings
readIndicatorRead indicator styleWidgetItemIndicatorStyleDefault setting

WidgetItemIndicatorStyle

The WidgetItemIndicatorStyle class allows you to customize the following properties:

NameDescriptionTypeDefault value
isVisibleIndicator visibilityBoolVaries
backgroundColorBackground colorUIColorVaries
backgroundImageBackground imageUIImage (optional)null
textStyleText styleBlazeWidgetItemTitleStyleVaries
textText to display in indicatorStringVaries
cornerRadiusCorner radiusCGFloat0
cornerRadiusRatioCorner radius ratioCGFloat0.5

WidgetItemStatusIndicator default styles

StyleisVisiblebackgroundColortexttextStyle.fonttextStyle.textColortextStyle.numberOfLinestextStyle.alignment
liveUnreadtrueredLIVESystem, 12white1center
liveReadtruegrayLIVESystem, 12white1center
unreadtrueblueNEWSystem, 12white1center
readfalseblueREADSystem, 12white1center

Did this page help you?