FlutterBook class
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- FlutterBook
Constructors
-
FlutterBook({Key? key, required List<
Category> categories, ThemeData? theme, ThemeData? darkTheme, CodeSampleThemeData? codeSampleTheme, Widget? header, EdgeInsetsGeometry headerPadding = const EdgeInsets.fromLTRB(20, 16, 20, 8), List<FlutterBookTheme> ? themes, Locale? locale, Iterable<LocalizationsDelegate> ? localizationsDelegates, LocaleListResolutionCallback? localeListResolutionCallback, LocaleResolutionCallback? localeResolutionCallback, Iterable<Locale> ? supportedLocales}) -
const
Properties
-
categories
→ List<
Category> -
Categories that can contain folders or components that can display states.
States will have widgets which you may click on and display the widget in
the editor.
final
- codeSampleTheme → CodeSampleThemeData?
-
Custom theme for the code sample shown on component state documentation.
final
- darkTheme → ThemeData?
-
The
ThemeDataused when the dark theme is enabled.final - hashCode → int
-
The hash code for this object.
no setterinherited
- header → Widget?
-
The branding/header of the project. This is displayed on the top left of the
flutterbook.
final
- headerPadding → EdgeInsetsGeometry
-
The padding for the branding/header of the project.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- locale → Locale?
-
final
- localeListResolutionCallback → LocaleListResolutionCallback?
-
final
- localeResolutionCallback → LocaleResolutionCallback?
-
final
-
localizationsDelegates
→ Iterable<
LocalizationsDelegate> ? -
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
supportedLocales
→ Iterable<
Locale> ? -
final
- theme → ThemeData?
-
The
ThemeDatathat is defaulted when the project is opened. This should be considered as the light theme.final -
themes
→ List<
FlutterBookTheme> ? -
This is used for projects that have more than two themes, if it is defined
and not empty, then the
themeanddarkThemewill be ignored and a dropdown will appear in the editor tabs.final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _FlutterBookState -
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