papercups_flutter 2.0.3

Native Flutter implementation of the papercups.io chat widget.

Installing

To get started simply add papercups_flutter: and the latest version to your pubspec.yaml. Then run flutter pub get

🎉 Done, It's that simple.

Using the widget

Integration with your app requires just a few lines of code, add the following widget wherever you want your papercups chat window to be:

import 'package:papercups_flutter/papercups_flutter.dart';

PaperCupsWidget(
    props: Props(
    accountId: "xxxxxxxx-xxxxxxx-xxxx-xxxxxx", //Your account id goes here.
    ),
),
    

That should get you up and running in just a few seconds ⚡️.

Configuration

Available PaperCupsWidget arguments

Parameter	Type	Value	Default
props	Props	Required, here is where all of the config for the chat is contained.	N/A
dateLocale	String	Locale for the date, use the locales from the intl package.	"en-US"
timeagoLocale	dynamic	Check https://github.com/andresaraujo/timeago.dart/tree/master/timeago/lib/src/messages for the available classes.	N/A
sendingText	String	Text to show while message is sending.	Sending...
sentText	String	Text to show when the messgae is sent.	Sent
floatingSendMessage	bool	Wether to have the message box floating.	false

Available Props paramaters

Prop	Type	Value	Default
accountId	string	Required, your Papercups account token	N/A
title	string	The title in the header of your chat widget	Welcome!
subtitle	string	The subtitle in the header of your chat widget	How can we help you?
newMessagePlaceholder	string	The placeholder text in the new message input	Start typing...
primaryColor	Color	The theme color of your chat widget	Theme.of(context).primaryColor without alpha
primaryGradient	Gradient	Gradient to specify, should be used instead of primaryColor, DO NOT USE BOTH.	N/A
greeting	string	An optional initial message to greet your customers with	N/A
customer	CustomerMetadata	Identifying information for the customer, including name, email, external_id, and metadata (for any custom fields)	N/A
baseUrl	string	The base URL of your API if you're self-hosting Papercups. Ensure you do not include the protocol (https) of a trailing dash (/)	app.papercups.io
requireEmailUpfront	boolean	If you want to require unidentified customers to provide their email before they can message you	false
companyName	String	Company name to show on greeting	"Bot"
enterEmailPlaceholer	String	This is the placeholder text in the email input section	"Enter your email"

Available CustomerMetaData paramaters

Parameters	Type	Value	Default
email	string	The customer's email	N/A
externalId	string	The customer's external ID	N/A
name	string	The customer's name	N/A
otherMetadata	Map<String, String>	Extra metadata to pass such as OS info.	N/A

Developing

You will need flutter beta and flutter web support enabled.

flutter channel beta
flutter upgrade
flutter config --enable-web