@foxsenseinnovations/notiflow-in-app-sdk-react
v1.1.4
Published
React SDK for Notiflow
Downloads
71
Keywords
Readme
Notiflow In-App SDK for React
The Notiflow In-App SDK allows seamless integration of notifications within your web application. Easily display notifications using our React-based SDK.
Installation
Using NPM:
$ npm i @foxsenseinnovations/notiflow-in-app-sdk-react
Using Yarn:
$ yarn i @foxsenseinnovations/notiflow-in-app-sdk-react
Usage
Here is a quick example of how to use the NotiflowInAppNotifications
component in your React application:
import React from 'react';
import { NotiflowInAppNotifications } from '@foxsenseinnovations/notiflow-in-app-sdk-react';
function App() {
return (
<div>
<h1>Notiflow In-App Notifications Example</h1>
<NotiflowInAppNotifications
clientId="<YOUR-CLIENT-ID>"
email="[email protected]"
phoneNumber="+1234567890"
/>
</div>
);
}
export default App;
Parameters
The NotiflowInAppNotifications
component takes the following props:
| Parameter | Type | Required | Description |
| --------|---------|-------|-------|
| clientId
| string
| Yes |The unique identifier for your notiflow account.This is mandatory to authenticate your app. |
| email
| string
| No | (Optional) The email address of the user for whom the notifications are to be fetched. Either email or phoneNumber must be provided. |
| phoneNumber
| string
| No | (Optional) The phone number of the user for whom the notifications are to be fetched. Either phoneNumber or email must be provided. |