Story<TWidget extends Widget, TArgs extends StoryArgs<TWidget>> class abstract

Inheritance

• Object
• WidgetbookNode
• WidgetbookUseCase
• Story

Annotations

• @optionalTypeArgs

Constructors

Story({required String name, String? designLink, SetupBuilder<TArgs> setup = defaultSetup, required TArgs args, required ArgsBuilder<TWidget, TArgs> argsBuilder, String? fileType})

Properties

args → TArgs

final

argsBuilder → ArgsBuilder<TWidget, TArgs>

final

builder → WidgetBuilder

final, inherited

children → List<WidgetbookNode>?

final, inherited

count → int

Gets the number of nodes in the sub-tree of this node.

no setter, inherited

depth → int

Gets the depth of the node within the tree.

no setter, inherited

designLink → String?

final, inherited

fileType → String?

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

isInitiallyExpanded → bool

final, inherited

isLeaf → bool

no setter, inherited

isRoot → bool

no setter, inherited

leaves → List<WidgetbookNode>

Gets all leaf nodes of this node.

no setter, inherited

name → String

final, inherited

nodesPath → List<WidgetbookNode>

Gets the nodes path from root to this node.

no setter, inherited

parent ↔ WidgetbookNode?

getter/setter pair, inherited

path → String

Gets the path from root to this node without leading slash Example: root/child/grandchild

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

setup → SetupBuilder<TArgs>

final

Methods

build(BuildContext context) → Widget

override

buildWithArgs(BuildContext context, TArgs args) → Widget

Same as build, but uses external args instead of Story.args.

copyWith({String? name, List<WidgetbookNode>? children, String? fileType}) → Story<TWidget, TArgs>

Creates a copy of this node with the given properties. Used in filter to create a copy of the sub-tree.

override

filter(bool predicate(WidgetbookNode node)) → WidgetbookNode?

Filters the sub-tree of this node for any node that matches predicate. If a node matches the predicate, it will be included, along with all its descendants, in the result.

inherited

find(bool predicate(WidgetbookNode node)) → WidgetbookNode?

Searches for a node that matches predicate in the sub-tree of this node.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

defaultSetup(BuildContext context, Widget story, dynamic args) → Widget