ShowcaseScope class

Gives the widgets of the kit, and your own, access to the ShowcaseState. Put it above the app.

Inheritance

Constructors

ShowcaseScope({required ShowcaseState state, required Widget child, ShowcaseStrings strings = const ShowcaseStrings(), Widget noticeBuilder(BuildContext context, String text)?, Key? key})
Creates a ShowcaseScope.
const

Properties

child → Widget
The widget below this widget in the tree.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
noticeBuilder → Widget Function(BuildContext context, String text)?
Builds the notice of ShowcaseState.showNotice, for when it has to look like the rest of the app.
final
notifier → ShowcaseState?
The Listenable object to which to listen.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state → ShowcaseState
final
strings → ShowcaseStrings
final

Methods

createElement() → InheritedElement
Inflates this configuration to a concrete instance.
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, 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
updateShouldNotify(covariant InheritedNotifier<ShowcaseState> oldWidget) → bool
Whether the framework should notify widgets that inherit from this widget.
inherited

Operators

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

Static Methods

noticeBuilderOf(BuildContext context) → Widget Function(BuildContext context, String text)?
The custom notice builder, if any.
of<T extends ShowcaseState>(BuildContext context, {bool listen = true}) → T
The state, as the type of your own demo state. Pass listen: false from callbacks.
stringsOf(BuildContext context) → ShowcaseStrings
The texts of the kit.