ChatWidget class

A floating action button that opens a chat interface with smooth animations.

This widget provides the entry point for users to interact with the chatbot. It displays as a customizable FAB that, when tapped, transitions to a full chat screen using hero animations.

Features:

  • Customizable appearance through BotConfiguration
  • Smooth open/close animations
  • Programmatic opening support
  • Avatar or icon display options
  • Auto-close timer functionality

Example:

ChatWidget(
  configuration: BotConfiguration(
    userID: 'user123',
    projectSecretKey: 'your-key',
    fabConfiguration: FabConfiguration(
      icon: 'support_agent',
      backgroundColor: '#FF5733',
      buttonSize: 64.0,
    ),
  ),
  onOpen: (isOpen) {
    print('Chat is ${isOpen ? 'open' : 'closed'}');
  },
)
Inheritance

Constructors

ChatWidget({required BotConfiguration configuration, dynamic onOpen({required bool isOpen})?, Widget? fabWidget, bool mobile = true, OnCustomCallback? onRichContentCallback, bool fullPage = false, ChatImageUploader? imageUploader, HostSlotBuilder? hostSlotBuilder, Key? key})
Creates a new instance of the floating chat button.
const

Properties

configuration → BotConfiguration
The bot configuration containing theming and behavior settings.
final
fabWidget → Widget?
An optional custom widget to display as the floating action button.
final
fullPage → bool
When true the widget skips the FAB and the open/close animation entirely and mounts the chat directly so it reads as the page itself. The close button is hidden so the chat cannot be dismissed by the user.
final
hashCode → int
The hash code for this object.
no setterinherited
hostSlotBuilder → HostSlotBuilder?
Builder the host registers to render host_slot rich-content components with its own native widget. The bot reserves a spot (slot_id) and the SDK calls this with (slotId, payload); return the widget to inline in the bubble (or null for unrecognised slot ids → renders nothing).
final
imageUploader → ChatImageUploader?
Optional uploader for image attachments. When the host wires this, picked photos are routed through the uploader BEFORE the chat request: the uploader returns a HTTPS URL (e.g. Firebase Storage download URL) which is then sent to the chat backend instead of inline base64. Keeps the backend DB tiny and lets the client render images from CDN.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
mobile → bool
final
onOpen → dynamic Function({required bool isOpen})?
Callback function called when the chat opens or closes.
final
onRichContentCallback → OnCustomCallback?
Callback for custom actions from rich content components.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<ChatWidget>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited