Get Started Component
The GetStarted component is a part of the Quest Labs React SDK. It provides a quick start guide for users to explore and engage with Application.
Last updated
The GetStarted component is a part of the Quest Labs React SDK. It provides a quick start guide for users to explore and engage with Application.
Last updated
To unlock early access to the component Get Access
To use the GetStarted component, you need to install the Quest Labs React SDK:
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.
To integrate the GetStarted component into your React application, follow these steps
Import the CSS: In your JavaScript or TypeScript file where you're using the GetStarted, import the CSS styles for the component. This ensures that the component's styling is applied correctly.
Import the TutorialComponent: Import the GetStartedcomponent from the @questlabs/react-sdk package.
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 are apiKey, and entityId. and required props for the GetStartedcomponent are userId, questId, token
Replace "your-api-key" and "your-entity-id" with your actual Quest API credentials
Replace "your-token", "your-user-id", "your-questId" with your actual configuration details.
Example Usage
Here's an example of how to use the GetStartedcomponent within your React application
The above example uses all the props.
The GetStarted component accepts the following props:
Headers
You can customize the UI with type of styleConfig would be
You can customize the UI with the type of styleConfig would be
| Prop Name | Type | Required | Details |
|---|---|---|---|