ℹī¸Info Onboarding

Screens with information that help the user know the functionalities found in the application.

Integrations

In order to obtain the information that is going to be displayed on the screens, an integration with the API is needed, for which the following environment variable is required:

API_INFO_ONBOARDING_SLIDE='/contents/onboardings/types/$APP_ONBOARDING?includeSlides=true'

How to use it?

  • Import the INFO_ONBOARDING_SCREENS constant where you have the Stack.Navigator you want to display the screens:

import {INFO_ONBOARDING_SCREENS} from 'LinkerStudio/modules/infoOnboarding/constants';
  • Add this code block to the Stack.Navigator you want to display the screens

<Stack.Navigator>
  {INFO_ONBOARDING_SCREENS.map(screen => (
    <Stack.Screen
       key={screen.name}
       name={screen.name}
       component={screen.component}
       options={{headerShown: false}}
     />
   ))}
</Stack.Navigator>
  • Import InfoOnboardingStackParams type where you have the stack params list type of the Stack.Navigator you want to display the Info onboarding screens. It is usually the types.ts file:

import {InfoOnboardingStackParams} from 'LinkerStudio/modules/infoOnboarding/navigation/types';
  • Add the InfoOnboardingStackParams type to your stack params list type, so your stack navigator can recognize the info onboarding screens:

export type RootStackParamsList = {MY SCREENS TYPES} & InfoOnboardingStackParams;

Last updated