PreviewShell class
A project's catalog shell: the chrome every demo is rendered inside, and the one place its top-bar switches are declared.
// demo/shell.dart
Widget wrapInApp(Widget child) => PreviewShell(
'app',
builder: (context, axes) => MyApp(
flavor: axes.picker('flavor', {
'Dev': Flavor.dev,
'Production': Flavor.prod,
}, Flavor.dev),
home: child,
),
);
A preview names it the way it always did, with @Preview(wrapper: wrapInApp).
Nothing about the shell is discovered: it is an ordinary
Widget Function(Widget), so Flutter's own previewer and the real app call
it unchanged and PreviewAxes answers them with the defaults.
id is what the host files selections under, so leaving a shell and coming back finds the flavour you had chosen. Write it once and leave it alone: it is a name rather than a path, so moving or renaming the file does not lose what was set.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- PreviewShell
Constructors
- PreviewShell(String id, {Key? key, required Widget builder(BuildContext context, PreviewAxes axes)})
-
const
Properties
- builder → Widget Function(BuildContext context, PreviewAxes axes)
-
Where the axes are declared. Called on every selection change.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
This shell's name, unique within the project.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
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, 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