Storybook class

Inheritance

Constructors

Storybook({Key? key, required Iterable<Story> stories, Iterable<Plugin>? plugins, String? initialStory, TransitionBuilder wrapperBuilder = materialWrapper, RouteWrapperBuilder? routeWrapperBuilder, Color? canvasColor, bool showPanel = true, bool enableLayout = true, Widget? brandingWidget, Widget? logoWidget, Layout initialLayout = Layout.auto, double autoLayoutThreshold = 800})

Properties

brandingWidget → Widget?
Branding widget to use in the plugin panel.
final
canvasColor → Color?
Canvas color of the Storybook. Story color can be changed inside the wrapperBuilder and routeWrapperBuilder.
final
enableLayout → bool
Whether to enable the layout plugin in the plugin panel.
final
hashCode → int
The hash code for this object.
no setterinherited
initialStory → String?
Optional initial story.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
logoWidget → Widget?
Logo widget to use in the left side panel above search field.
final
plugins → List<Plugin>
All enabled plugins.
final
routeWrapperBuilder → RouteWrapperBuilder?
Each routed story will be wrapped into a widget returned by this builder.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showPanel → bool
Whether to show the plugin panel at the bottom.
final
stories → List<Story>
All available stories.
final
wrapperBuilder → Widget Function(BuildContext context, Widget? child)
Each story will be wrapped into a widget returned by this builder.
final

Methods

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

storyFocusNode ↔ FocusScopeNode?
For internal use to manage focus in Storybook.
getter/setter pair