Get Started Component

The Get Started component is a highly customizable Flutter widget that provides a quick and easy onboarding guide for your Flutter application, helping users navigate and interact with your app

Components Visuals

To unlock early access to the component Get Access

Installation

To use the get started component , you need to install questlabs_flutter_sdk package into your project

  • First, navigate to the root directory of your Flutter project. Open the pubspec.yaml file using your preferred code editor.

  • Under the dependencies section in your pubspec.yaml file, add the following line to include the questlabs_flutter_sdk package

  • After saving your changes, open your terminal or command prompt and run the following command to fetch the new dependency

dependencies:
  questlabs_flutter_sdk:
    git:
      url: "Replace with your github URL"
      ref: master  
  flutter_bloc: ^8.1.6

Props of Get Started Component

Prop NameTypeDescriptionRequired

questProvider

QuestProvider

Provides necessary configuration such as API key, entity ID, and optional theme settings

Yes

apiKey

String

API key to authenticate requests.

Yes

entityId

String

Entity ID associated with the quest.

Yes

themeConfig

QuestThemeConfig

Customizes theme settings like background color, font style, border color, button color, etc.

No

primaryColor

Color

Sets the primary color of the component .

np

secondaryColor

Color

Sets the secondary color of the component .

no

buttonColor

Color

Defines the color of buttons within the component .

no

backgroundColor

Color

Specifies the background color of the component .

no

borderColor

Color

Defines the color of the component's border.

no

fontStyle

String

Sets the font style for text within the component (e.g., "poppins")

no

getStarted

GetStarted

Contains user ID, quest ID, token, and display options for the "Get Started" component.

Yes

userId

String

Unique user identifier.

Yes

token

String

Token for authenticating the user session.

Yes

questId

String

Unique quest identifier.

Yes

template

String

Specifies the template type

no

showFooter

bool

Whether or not to display the footer in the "Get Started" component.

no

showProgressBar

bool

Whether or not to display the progress bar.

no

You can customize the UI with the type of QuestThemeConfig would be


          themeConfig: QuestThemeConfig(
              secondaryColor: Colors.red,
              primaryColor: Colors.blue,
              buttonColor: Colors.yellow,
              backgroundColor: Colors.yellow,
              fontStyle: "libre baskerville",
              borderColor: Colors.red
          )

Basic Usage:

  • In your main() function, ensure you initialize the app and dependencies as follows:

void main() {
  runApp(const MyApp());
  getItInit();
  getIt<SharedPref>().init();
}
  • Add the following BlocProvider setup to your providers list to initialize the GetStartedCubit for state management:

providers: [
  BlocProvider(
    create: (context) => getIt<GetStartedCubit>(),
  ),
],

Ensure you provide your entity ID, API key, token, user ID, and quest ID

import 'package:flutter/material.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:questlabs_flutter_sdk/questlabs_flutter_sdk.dart';

void main() {
  runApp(const MyApp());
  getItInit();
  getIt<SharedPref>().init();
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});
  @override
  Widget build(BuildContext context) {
    return MultiBlocProvider(
      providers: [
        BlocProvider(
          create: (context) => getIt<GetStartedCubit>(),
        ),
      ],
      child: MaterialApp(
        title: 'Flutter Demo',
        home: GetStartedComponent(
          questProvider: QuestProvider(
              apiKey: 'apiKey',
              entityId: 'entityId',
              // themeConfig: QuestThemeConfig(
              //   backgroundColor: Colors.white,
              //   fontStyle: "figtree",
              //   borderColor: Colors.grey,
              //   buttonColor: Colors.purple,
              //   primaryColor: Colors.blue,
              //   secondaryColor: Colors.pink,
              // )
          ),
          getStarted: GetStarted(
            userId: "entityId",
            token: "token",
            questId: "questId",
            template: "template1",
            showFooter: true,
            showProgressBar: true,
          ),
        )
      ),
    );
  }
}

Watch the video below for a step-by-step guide on testing the Get Started component in your Flutter project.

Last updated