Story class
Single story (page) in storybook.
It's better to use it to demonstrate a single widget (e.g. Button).
- Inheritance
Constructors
- Story({Key? key, required String name, required StoryBuilder builder, String section = '', Color? background, EdgeInsets padding = const EdgeInsets.all(16), StoryWrapperBuilder? wrapperBuilder})
-
const
- Story.simple({Key? key, required String name, required Widget child, String section = '', Color? background, EdgeInsets padding = const EdgeInsets.all(16), StoryWrapperBuilder? wrapperBuilder})
Properties
- background → Color?
-
Background color of the story.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- name → String
-
A unique name to identify this story.
final
- padding → EdgeInsets
-
Padding of the story.
final
- path → String
-
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- section → String
-
Section title.
final
- wrapperBuilder → StoryWrapperBuilder?
-
Optional parameter to override story wrapper.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _StoryState -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of
DiagnosticsNodeobjects 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