Help Hub Component
The Help Hub component for Flutter seamlessly integrates a comprehensive help center and an AI chatbot into your app, offering users effortless access to support and information across mobile platform
Last updated
The Help Hub component for Flutter seamlessly integrates a comprehensive help center and an AI chatbot into your app, offering users effortless access to support and information across mobile platform
Last updated
To unlock early access to the component Get Access
To use the helphub 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
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 .
no
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
helpHubProps
HelpHubProps
Contains user ID, quest ID, token, and display options for the "Helphub Component"
Yes
userId
String
Unique user identifier.
Yes
token
String
Token for authenticating the user session.
Yes
campaignId
String
Unique campaign identifier.
Yes
You can customize the UI with the type of QuestThemeConfig would be
In your main()
function, ensure you initialize the app and dependencies as follows:
Add the following BlocProvider
setup to your providers
list to initialize the HelpHubCubit
for state management:
Ensure you provide your entity ID, API key, token, user ID, and campaign ID
Watch the video below for a step-by-step guide on testing the helphub component in your Flutter project.