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.

Component Visuals

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.


Props of Tutorial Component

The Tutorialcomponent accepts the following props

Prop NameTypeRequiredDetails

userId

string

required

The unique identifier of the user.

token

string

required

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

questId

string

required

The unique identifier for the tutorial or quest

heading

string

required

The title or heading of the tutorial

subheading

string

required

A brief description or subheading for the tutorial

onLinkTrigger

function

optional

Callback function for handling link triggers.

showFooter

string

optional

Helps remove or add footer in component.

iconColor

string

optional

Color for icons.

uniqueUserId

string

optional

Unique user identifier.

uniqueEmailId

string

optional

Unique email identifier.

styleConfig

object

optional

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

You can customize the UI with type of styleConfig would be

styleConfig?: {
    Form?: CSSProperties,
    Heading?: CSSProperties,
    Description?: CSSProperties,
    Footer?: CSSProperties,
    TopBar?: CSSProperties,
}

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, apiSecret, and entityId. and required props for the Tutorialcomponent are userId, questId, token, heading and subheading

<QuestProvider
  apiKey="your-api-key"
  entityId="your-entity-id"
  apiType = {'"STAGING" OR "PRODUCTION" '} 
>
  <Tutorial
    heading="your-heading"
    userId="userid"
    subheading="subheading"
    questId="your-questId"
    token="your-token"
  />
</QuestProvider>

Replace "your-api-key", "your-api-secret", and "your-entity-id" with your actual Quest API credentials

Replace "your-token", "userid", "your-questId","your-heading", "subheading" with your actual configuration details.


Example Usage

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

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

function App() {
  return (
    <div>
      <QuestProvider
        apiKey="k-xxxxxdc-ac8f-x1-xxx8b-a175xxxxx"
        entityId="e-xxxx-b75b-xxxx-be9a-ee11f0f0xxxx"
        apiType = {'"STAGING" OR "PRODUCTION" '} 
      >
       <TutorialScreen
          heading="Lxxxx xxxx xxx"
          userId="u-xxxxxxxxxx-7c454xxxxxxcxxx"
          subheading="compxxxxxx-xxxxxx"
          questId="q-xxxxxxxxxxxxxxxxxxx-xxxxx"
          token="xxxxxxxxxxxx1Ixxxxxxxxxxxxz"
          styleConfig= {{
              Form: {},
              Heading: {},
              Description: {},
              Footer: {},
              TopBar: {},
          }}
        />
      </QuestProvider>
    </div>
  );
}

export default App;

The above example uses all the props.


Demo

Last updated