ChatHeadConfig class
Configuration for showing a floating chathead.
Encapsulates every option needed by FloatyChatheadsPlatform.showChatHead,
including the overlay entry point, content panel dimensions, native assets,
theming, size presets, and debug mode.
Grouped parameters
Related parameters are passed via config objects:
- assets / ChatHeadAssets — groups icon and close-button asset paths.
- notification / NotificationConfig — groups notification title, icon, and visibility.
- snap / SnapConfig — groups snap edge, margin, and position persistence.
- Annotations
Constructors
- ChatHeadConfig({String entryPoint = 'overlayMain', int? contentWidth, int? contentHeight, OverlayFlag flag = OverlayFlag.defaultFlag, bool enableDrag = true, EntranceAnimation entranceAnimation = EntranceAnimation.none, ChatHeadTheme? theme, ContentSizePreset? sizePreset, bool debugMode = false, bool autoLaunchOnBackground = false, bool persistOnAppClose = false, ChatHeadAssets? assets, NotificationConfig? notification, SnapConfig? snap})
-
Configuration for showing a floating chathead.
const
Properties
- assets → ChatHeadAssets?
-
Grouped asset paths for the chathead bubble, close icon, and
close background.
final
- autoLaunchOnBackground → bool
-
Whether the chathead automatically appears when the app goes to the
background.
final
- contentHeight → int?
-
Height of the content panel in logical pixels.
final
- contentWidth → int?
-
Width of the content panel in logical pixels.
final
- debugMode → bool
-
Whether to enable the debug overlay inspector.
final
- enableDrag → bool
-
Whether the chathead bubble can be dragged.
final
- entranceAnimation → EntranceAnimation
-
The entrance animation when the chathead first appears.
final
- entryPoint → String
-
Name of the Dart function annotated with
@pragma("vm:entry-point")that runs in the overlay isolate.final - flag → OverlayFlag
-
Window behavior flag.
final
- hashCode → int
-
The hash code for this object.
no setteroverride
- notification → NotificationConfig?
-
Grouped notification configuration (title, description, icon,
and lock-screen visibility).
final
- persistOnAppClose → bool
-
Whether the chathead overlay survives after the main app process is
killed.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sizePreset → ContentSizePreset?
-
Named size preset for the content panel.
final
- snap → SnapConfig?
-
Grouped snap-behavior configuration (edge, margin, and position
persistence).
final
- theme → ChatHeadTheme?
-
Optional theme configuration for badge colors, bubble border,
shadow color, close tint, and overlay palette.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override