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 = false, OnCustomCallback? onRichContentCallback, 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
hashCode → int
The hash code for this object.
no setterinherited
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