FeatureDiscovery class

Inheritance

Constructors

FeatureDiscovery({required Widget child, bool recordStepsInSharedPreferences = true, String? sharedPreferencesPrefix, Key? key})
Instantiates a new FeatureDiscovery.
factory
FeatureDiscovery.withProvider({required Widget child, required PersistenceProvider persistenceProvider, Key? key})
Instantiates a new FeatureDiscovery and stores completion of steps through the provided PersistenceProvider.
const

Properties

child → Widget
final
hashCode → int
The hash code for this object.
read-onlyinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
persistenceProvider → PersistenceProvider
The PersistenceProvider implementation to use for persisting steps that have been previously completed.
final
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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}) → 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

clearPreferences(BuildContext context, Iterable<String> steps) → Future<void>
completeCurrentStep(BuildContext context) → Future<void>
This will force the completion of the current step and continue onto the next step after the completion animation of the current overlay.
currentFeatureIdOf(BuildContext context) → String?
This returns the feature id of the current feature discovery step, i.e. of the DescribedFeatureOverlay that is currently supposed to be shown, or null.
discoverFeatures(BuildContext context, Iterable<String> steps) → void
Steps are the featureIds of the overlays. Though they can be placed in any Iterable, it is recommended to pass them as a Set because this ensures that every step is only shown once.
dismissAll(BuildContext context) → void
A method to dismiss all steps.
hasPreviouslyCompleted(BuildContext context, String featureId) → Future<bool>
This will return true iff this featureId has been recorded as completed in the Shared Preferences.