Customize click behaviors (React Native)

The SDK provides behavior callbacks to customize click behaviors, including those for the video CTA button, product cards, and shopping CTA button.

Customize video overlay CTA button click behavior

Set FireworkSDK.getInstance().onCustomCTAClick to customize video overlay CTA button click behavior. The event type is CustomCTAClickEvent.

FireworkSDK.getInstance().onCustomCTAClick = async (event) => {
  // Here, you could write codes to navigate to the host app page.
  // For best practices on navigating to the host page,
  // please consult "Navigate to the host app page" below.
}

You could write codes to navigate to the host app page within the callback. For best practices on navigating to the host page, please consult Navigate to the host app page below.

Customize shopping click behaviors

Customize product card click behavior

Set FireworkSDK.getInstance().shopping.onCustomTapProductCard to customize product card click behavior. The event type is CustomTapProductCardEvent.

FireworkSDK.getInstance().shopping.onCustomTapProductCard = async (event) => {
  // Here, you could write codes to navigate to the host app page.
  // For best practices on navigating to the host page,
  // please consult "Navigate to the host app page" below.
};

You could write codes to navigate to the host app page within the callback. For best practices on navigating to the host page, please consult Navigate to the host app page below.

Customize shopping CTA click behavior

We support customizing the default shopping CTA button text to "Add to cart" or "Shop now". The usage codes are:

FireworkSDK.getInstance().shopping.productInfoViewConfiguration = {
  ctaButton: {
    text: 'shopNow', // 'addToCart' or 'shopNow'
  },
};

Set FireworkSDK.getInstance().shopping.onShoppingCTA to customize shopping CTA click behavior. And the host app can return a ShoppingCTAResult object to tell FireworkSDK the result. The event type is ShoppingCTAEvent.

FireworkSDK.getInstance().shopping.onShoppingCTA = async (event) => {
  // Here, you could write codes to navigate to the host app page.
  // For best practices on navigating to the host page,
  // please consult "Navigate to the host app page" below.
  
  return {
    res: 'success',
  };
};

You could write codes to navigate to the host app page within the callback. For best practices on navigating to the host page, please consult Navigate to the host app page below.

Customize product link button click behavior

Set FireworkSDK.getInstance().shopping.onCustomClickLinkButton to customize product card click behavior. The event type is CustomClickLinkButtonEvent.

FireworkSDK.getInstance().shopping.onCustomClickLinkButton = async (event) => {
  // Here, you could write codes to navigate to the host app page.
  // For best practices on navigating to the host page,
  // please consult "Navigate to the host app page" below.
};

You could write codes to navigate to the host app page within the callback. For best practices on navigating to the host page, please consult Navigate to the host app page below.

Customize product link button click behavior

The cart icon is hidden by default. You can show the cart icon by the following codes:

FireworkSDK.getInstance().shopping.cartIconVisible = true;

Set FireworkSDK.getInstance().shopping.onCustomClickCartIcon to customize product card click behavior.

FireworkSDK.getInstance().shopping.onCustomClickCartIcon = async (event) => {
  // Here, you could write codes to navigate to the host app page.
  // For best practices on navigating to the host page,
  // please consult "Navigate to the host app page" below.
};

You could write codes to navigate to the host app page within the callback. For best practices on navigating to the host page, please consult Navigate to the host app page below.

Customize livestream link interaction click behavior

Set FireworkSDK.getInstance().liveStream.onCustomLinkInteractionClick to customize livestream link interaction click behavior. The event type is CustomLinkInteractionClickEvent.

FireworkSDK.getInstance().liveStream.onCustomLinkInteractionClick = async (
  event
) => {
  // Here, you could write codes to navigate to the host app page.
  // For best practices on navigating to the host page,
  // please consult "Navigate to the host app page" below.
};

Navigate to the host app page

Typically, we need to navigate to the host app page when customizing click behaviors. However, the React Native navigation stack may be obscured by the Firework full-screen player. When the host app navigates to a new React Native page (for instance, using the navigate method of React Navigation) within the React Native navigation stack when customizing click behaviors, it will be obscured by the Firework full-screen player.

As illustrated in the following code snippets, you can invoke our API to convert the Firework full-screen player (if it exists) into a floating player or close it (if it exists) when customizing click behaviors. This approach ensures that the new React Native page will not be obscured by the Firework full-screen player.

FireworkSDK.getInstance().shopping.onCustomTapProductCard = async (event) => {
  // Wait for the fullscreen player is transitioned to floating player or closed
  await FireworkSDK.getInstance().navigator.tryStartFloatingOrCloseFullScreen();
  
  // Navigate to host app page within React Native navigation stack
  navigation.navigate('/host_app_page', { url: event.url });
};