Wiredash class

Capture in-app user feedback, wishes, ratings and much more

  1. Setup Wrap you Application in Wiredash and pass in the apps Navigator
  @override
  Widget build(BuildContext context) {
    return Wiredash(
      projectId: "YOUR-PROJECT-ID",
      secret: "YOUR-SECRET",
      child: MaterialApp(
        title: 'Wiredash Demo',
        home: DemoHomePage(),
      ),
    );
  }
}
  1. Start Wiredash
Wiredash.of(context).show();
Inheritance

Constructors

Wiredash({Key? key, required String projectId, required String secret, String? environment, WiredashOptionsData? options, WiredashThemeData? theme, WiredashFeedbackOptions? feedbackOptions, PsOptions? psOptions, EdgeInsets? padding, FutureOr<CustomizableWiredashMetaData> collectMetaData(CustomizableWiredashMetaData metaData)?, required Widget child})
Creates a new Wiredash Widget which allows users to send feedback, wishes, ratings and much more
const

Properties

child → Widget
Your application
final
collectMetaData → FutureOr<CustomizableWiredashMetaData> Function(CustomizableWiredashMetaData metaData)?
Adds additional metadata to feedback
final
environment → String?
The environment of your app, like 'prod', 'dev', 'staging'
final
feedbackOptions → WiredashFeedbackOptions?
Customize the feedback flow
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
options → WiredashOptionsData?
Customize Wiredash's behaviour and language
final
padding → EdgeInsets?
The padding inside wiredash, parts of the screen it should not draw into
final
projectId → String
Your Wiredash projectId
final
psOptions → PsOptions?
Customize when to show the promoter score flow
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secret → String
Your Wiredash project secret
final
theme → WiredashThemeData?
Default visual properties, like colors and fonts for the Wiredash bottom sheet and the screenshot capture UI.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → WiredashState
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

Static Methods

maybeOf(BuildContext context) → WiredashController?
The WiredashController from the closest Wiredash instance or null that encloses the given context.
of(BuildContext context) → WiredashController
The WiredashController from the closest Wiredash instance that encloses the given context.
trackEvent(String eventName, {Map<String, Object?>? data, String? projectId, String? environment}) → Future<void>
Tracks an event with Wiredash.