Quest List Component
A versatile UI element for managing and tracking task completion. Displays tasks, tracks progress with a progress bar, and shows checkmarks for completed tasks.
Components Visuals
To unlock early access to the component Get Access
Installation
To install the Quest react-native-sdk
into your project, follow these steps:
Open your terminal/command prompt.
Navigate to your project's root directory using the
cd
command if you're not already there.Run the following command to install the
quest-sdk
package using npm:
This command will download and install the package and its dependencies into your project.
Make sure your project has npm and Node.js installed, and that you have the necessary permissions to install packages in your project directory.
Usage
Root Component
Import the QuestProvider Component: Import the
QuestProvider
component from the@questlabs/react-sdk
package.
Pass the Required Props: Pass the required props to the
QuestProvider
. The required props areapiKey
,entityId,
authenticationToken
andfontFamily.
To load external fonts, please refer this doc to setup expo-font on your expo app.
Component Usage
To integrate the QuestList
component into your React native application, follow these steps.
Import useQuestList Hook: Import the
useQuestList
component from the@questlabs/react-sdk
package.Import the QuestList Component: Import the
QuestList
component from the@questlabs/react-sdk
package.Pass the Required Props: Pass the required props to the
useQuestList
. The required props arequestId
,questUserId
, anduserToken
or if user don't have quest User id then they can pass own userId to get questUserId and Token.
Don't not use QuestProvider and useQuestList Hook in same file
Props of QuestList Component
The QuestList component accepts the following props
Props Name | Type | Require | Details |
---|---|---|---|
questId | string | optional | The unique identifier for the tutorial or quest. |
questUserId | string | optional | The unique identifier of the user. |
userToken | string | optional | An authentication token or API key necessary for accessing tutorial or quest data. |
onClose | Function | optional | Create the function for onClose. |
isModal | boolean | optional | Open as Modal. |
actions | ICriteria[] | Require | In offline user need to provide the require filed data. |
loading | boolean | optional | don't use in offline mode. |
title | string | Require | Component title. |
description | string | Require | Component Descroption. |
onClick | Funtion | optional | when it offline the create own Funtion. |
isOffline | boolean | optional | for verification. |
campaignVariationId | string | optional | Id For verification. |
onError | Function | optional | For Showing the Error. |
showFooter | boolean | optional | user Want to show the footer or not |
styleConfig | object | optional | An object containing Styling properties for styling various components within the get started process, including form, topbar, headings, descriptions, and buttons. |
Style Props
Example Usage
App.js
DemoComponent.tsx
Demo
Last updated