Tutorial/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.

To unlock early access to the component Get Access

Installation

To install the Quest react-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:

npm install @questlabs/react-sdk

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.

The Tutorialcomponent accepts the following props

Usage

To integrate the Tutorial component into your React application, follow these steps

Import the CSS: In your JavaScript or TypeScript file where you're using the Tutorial, import the CSS styles for the component. This ensures that the component's styling is applied correctly.

import '@questlabs/react-sdk/dist/style.css'

Import the TutorialComponent: Import the Tutorialcomponent from the @questlabs/react-sdk package.
Import the QuestProvider Component: Import the QuestProvider component from the @questlabs/react-sdk package.

import { QuestProvider, Tutorial }  from '@questlabs/react-sdk';

Pass the Required Props: Pass the required props to the QuestProvider. The required props are apiKey, and entityId. and required props for the Tutorialcomponent 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.

Code & Steps

import { QuestProvider, Tutorial } from '@questlabs/react-sdk';
import '@questlabs/react-sdk/dist/style.css'

function App() {
  return (
      <QuestProvider
        apiKey="your-apikey"
        entityId="your-entity-Id" 
        apiType= "PRODUCTION" // STAGING 
      >
      <Tutorial> </Tutorial>
      </QuestProvider>
  );
}

export default App;

  <Tutorial
          userId=""
          questId=""
          token=""
          uniqueUserId="your-unique-user-id"
        >
    // children
</Tutorial>

       <Tutorial.Header
          heading='your-heading' 
          subHeading='your-subHeading' 
          style= {{ backgroundcolor : 'white' }} 
          headingStyle= {{ fontSize : '20px }} 
          descriptionStyle= {{ fontSize : '14px' }}
        />

     
       <Tutorial.Footer
          text='your-company-name' 
          link='redirect-link'
          style={{ background : 'white' }}
        />

   <QuestProvider
        apiKey="your-apikey"
        entityId="your-entity-Id" 
        apiType= "PRODUCTION" // STAGING 
      >
       <Tutorial
          userId=""
          questId=""
          token=""
          uniqueUserId="your-unique-user-id"
        >
        <Tutorial.Header />
        <Tutorial.Content />
        <Tutorial.Footer />
        </Tutorial>
      </QuestProvider>

Example Usage

Here's an example of how to use the Tutorialcomponent within your React application

import { QuestProvider, Tutorial } from '@questlabs/react-sdk';
import '@questlabs/react-sdk/dist/style.css'

function App() {
  return (
    <div>
      <QuestProvider
        apiKey="your-apikey"
        entityId="your-entity-Id" 
        apiType= "PRODUCTION" // STAGING 
      >
       <Tutorial
          userId=""
          questId=""
          token=""
          uniqueUserId="your-unique-user-id"
        >
        <Tutorial.Header />
        <Tutorial.Content />
        <Tutorial.Footer />
        </Tutorial>
      </QuestProvider>
    </div>
  );
}

export default App;

import { QuestProvider, TutorialWrapper } from '@questlabs/react-sdk';
import '@questlabs/react-sdk/dist/style.css'

function App() {
  return (
    <div>
      <QuestProvider
        apiKey="your-apikey"
        entityId="your-entity-Id"
        apiType= "PRODUCTION" // STAGING 
      >
       <TutorialWrapper
          userId=""
          questId=""
          token=""
          uniqueUserId="your-unique-user-id"
          styleConfig= {{
              Form: {},
              Heading: {},
              Description: {},
              Footer: {},
              TopBar: {},
          }}
          showFooter={false}
        />
      </QuestProvider>
    </div>
  );
}

export default App;

Props of Tutorial Component

Prop Name

Type

Required

Details

questId

string

required

The unique identifier for the tutorial or quest

userId

string

optional

The unique identifier of the user.

token

string

optional

An authentication token or API key necessary for accessing tutorial or quest data

Headers

Array

optional

onLinkTrigger

function

optional

Callback function for handling link triggers.

showFooter

string

optional

Helps remove or add footer in component.

uniqueUserId

string

optional

Unique user identifier.

uniqueEmailId

string

optional

Unique email identifier.

variation

string

optional

create different variation

styleConfig

object

optional

An object containing CSS properties for styling various components within the tutorial process, including form, topbar, headings, descriptions, and buttons.

The above example uses all the props.

Headers

Headers= [{
  heading: 'Your Heading' 
  subHeading : 'Your SubHeading'
}]

You can customize the UI with type of styleConfig would be

styleConfig= {{
    Form: {},
    Heading : {},
    Description : {},
    Footer: {
    FooterStyle: {},
    FooterText: {},
    FooterIcon: {}
    },
    TopBar: {},
}}

Demo

https://drive.google.com/file/d/1shWHUtY9r3Zl4toUDYPeTHrMFcuNsim4/viewdrive.google.com

PreviousGet Started Component NextWalk Through Component

Last updated 1 year ago