@gigscom/embeds-react-native

Gigs Embeds for React Native

Gigs Embeds for React Native

[!NOTE] This library is currently under development.

Installation

npm install @gigscom/embeds-react-native

Usage

When a user visits the screen in your app containing the Embed, request a Connect Session from your server endpoint. Afterward, you can render the Embed component.

Porting Embed

1. Create a Gigs Connect Session on your own server.

2. Pass the session object from your server to your app.

3. Initialize the embed using the session object with an intent of type completePorting, your project ID and an onCompleted .

4. Navigate the user to the next screen once the number porting is completed.

5. You can also optionally pass what should happen when the component is loaded or if there is an error initializing it.

   const [isLoaded, setLoaded] = useState(false)
   \\ ...
   {Boolean(!isLoaded) &&  <YourLoadingSpinner />}
   <PortingEmbed
    connectSession={session}
    project="yourProject"
    onLoaded={() => setLoaded(true)}
    onError={(error) => setError(error)}
    onCompleted={() => navigate('SuccessScreen')}
    onSupportRequested={() => navigate('CustomerSupportScreen')}
   />
   

Porting Embed props

Prop	Type	Required	Description
connectSession	Connect Session object	✅	A Connect Session object with an intent of type completePorting.
project	string	✅	Your project ID.
onCompleted	function	✅	(porting: Porting) => unknown Callback triggered when the number porting is completed.
onInitialized	function	❌	() => unknown Callback triggered when the embed is initialized. Mostly useful for debugging purposes. In most cases you want to use onLoaded to know when the component is ready.
onLoaded	function	❌	() => unknown Callback triggered when the embed form is loaded with a subscription and the related porting.
onError	function	❌	(error: Error) => unknown Callback triggered when there is an error initializing the porting form. The error may stem from an invalid session, in which case recovery can be attempted by generating and passing a new Connect session to the embed. Alternatively, the error may derive from a failed attempt to retrieve a subscription, in which case it is advisable to inform the user to try again later or to contact customer support for assistance.
onSupportRequested	function	❌	() => unknown Callback triggered when the user has clicked the "Customer support" button. You can use it for example to open your own Customer support page.

Contributing

This project was bootstrapped with create-react-native-library.

See the contributing guide to learn how to contribute to the repository and the development workflow.