Migration to SDK 2.0

The migration to JOIN Stories SDK 2.0 offers several enhancements and new features that improve the functionality and performance of the experience in your application.

This guide will help you smoothly migrate your existing implementation to JOIN Stories SDK 2.0.

Components props

Here is the list of changes on props for both components.

Bubble component

PropsChangesInformations
requestTimeoutIntervalremovedfetch timeout interval is not customizable anymore
containerDimensionremovedYou can apply an height with React native style instead.
thumbViewSpacing (new: spacing)renamedthumbViewSpacing is renamed to spacing.
loaderInnerViewWidthremovedAlways the same width to respect UI standards
loaderInnerViewColorremovedAlways transparent to respect UI standards
storyViewedIndicatorAlpharemovedyou can set alpha via storyViewedIndicatorColor.
thumbViewOverlayColorremovedWe now have animations to show clicks on bubbles, overlay is not needed anymore.
hasPlayButtonnewpossibility to show / hide play button.
labelSizenewFont size of labels can now be modified
bubbleSizenewBubble size can now be customized

For the changes on player related props, see Standalone Player.

Card component

PropsChangesInformations
requestTimeoutIntervalremovedfetch timeout interval is not customizable anymore
containerDimensionremovedYou can apply an height with React native style instead.
edgeremovedIt was redundant. Use horizontalMargin and horizontalPadding instead.

For the changes on player related props, see Standalone Player.

Standalone Player

Here is the list of changes for Standalone player parameters.

PropsChangesInformations
requestTimeoutIntervalremovedfetch timeout interval is not customizable anymore
playerVerticalAnchorvalues changedtopIgnoringSafeArea and topWithSafeArea are replaced by top.
playerShowShareButtonremovedThe sharing is now always disabled (may be updated in the future).
playerClosingButtonremovedThe closing button is now always displayed.

Component listener

New events are available to provide more details on the component lifecycle. The old events are renamed to have a clearer meaning. See below:

EventChangesInformations
onStoryLoaded (new: PlayerLoaded)renamedPlayer opened
onStoryFetchError (new: TriggerFetchError)renamedSomething went wrong while fetching stories
onStoryFetchEmpty (new: TriggerFetchEmpty)renamedStories successfully fetched but nothing was found
onStoryDismissed (new: PlayerDismissed)renamedPlayer closed
onStoryFetchSuccess (new: TriggerFetchSuccess)renamedStories successfully fetched
onStoryLinkClick (new: ContentLinkClick)renameda CTA was clicked
PlayerFetchErrornewSomething went wrong while displaying the video
PlayerFetchSuccessnewPlayer successfully launched the video

Analytics listeners

Analytics events are now split in two: Player Analytics and Trigger analytics. They provide more details on the components and player lifecycle. See Analytics on how to implement them and what kind of events are available. The old analytics listener is no longer available.