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
Props | Changes | Informations |
---|---|---|
requestTimeoutInterval | removed | fetch timeout interval is not customizable anymore |
containerDimension | removed | You can apply an height with React native style instead. |
thumbViewSpacing (new: spacing) | renamed | thumbViewSpacing is renamed to spacing. |
loaderInnerViewWidth | removed | Always the same width to respect UI standards |
loaderInnerViewColor | removed | Always transparent to respect UI standards |
storyViewedIndicatorAlpha | removed | you can set alpha via storyViewedIndicatorColor. |
thumbViewOverlayColor | removed | We now have animations to show clicks on bubbles, overlay is not needed anymore. |
hasPlayButton | new | possibility to show / hide play button. |
labelSize | new | Font size of labels can now be modified |
bubbleSize | new | Bubble size can now be customized |
For the changes on player related props, see Standalone Player.
Card component
Props | Changes | Informations |
---|---|---|
requestTimeoutInterval | removed | fetch timeout interval is not customizable anymore |
containerDimension | removed | You can apply an height with React native style instead. |
edge | removed | It 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.
Props | Changes | Informations |
---|---|---|
requestTimeoutInterval | removed | fetch timeout interval is not customizable anymore |
playerVerticalAnchor | values changed | topIgnoringSafeArea and topWithSafeArea are replaced by top . |
playerShowShareButton | removed | The sharing is now always disabled (may be updated in the future). |
playerClosingButton | removed | The 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:
Event | Changes | Informations |
---|---|---|
onStoryLoaded (new: PlayerLoaded) | renamed | Player opened |
onStoryFetchError (new: TriggerFetchError) | renamed | Something went wrong while fetching stories |
onStoryFetchEmpty (new: TriggerFetchEmpty) | renamed | Stories successfully fetched but nothing was found |
onStoryDismissed (new: PlayerDismissed) | renamed | Player closed |
onStoryFetchSuccess (new: TriggerFetchSuccess) | renamed | Stories successfully fetched |
onStoryLinkClick (new: ContentLinkClick) | renamed | a CTA was clicked |
PlayerFetchError | new | Something went wrong while displaying the video |
PlayerFetchSuccess | new | Player 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.
Updated 7 months ago