catalog library

Classes

AbstractLineGuide
An interface for configuring how to paint line guides in the indentation of a tree node.
AndroidPhone
AnimatedTreeView<T extends Object>
A TreeView that animates the expansion state changes of tree nodes.
Catalog
CatalogRunner
ComponentNode
ConnectingLinesGuide
The IndentGuide configuration for painting vertical lines that have a horizontal connection to its tree node.
CustomTransitionPage<T>
Page with custom transition functionality.
DefaultIndentGuide
An InheritedTheme that provides a default IndentGuide to its widget tree.
Device
DeviceFrame
Simulate a physical device and embedding a virtual screen into it.
DeviceFrameStyle
The device frame style only allows to update the keyboardStyle for now.
DeviceFrameTheme
The theme gives a style to all its descentant device frames.
DeviceIdentifier
A unique identifier that represents a device.
DeviceInfo
Info about a device and its frame.
DeviceKeyboardStyle
The keyboard style allows to customize the virtual onscreen keyboard visuals.
Devices
A list of common device specifications sorted by target platform.
Dummy
  • IPAD_PRO_3GEN_129 -> 2048 x 2732
  • IPAD_PRO_129 -> 2048 x 2732
  • IPHONE_55 -> 1242 x 2208
  • IPHONE_65 -> 1284 x 2778
    • DummyText
    FolderButton
    A wrapper around IconButton and AnimatedSwitcher that animates between icon, openedIcon and closedIcon depending on the value of isOpen.
    GenericDesktopMonitorFramePainter
    GenericLaptopFramePainter
    GenericPhoneFramePainter
    GenericTabletFramePainter
    GoRoute Configuration Get started Named routes Redirection Transition animations
    A route that is displayed visually above the matching parent route using the Navigator.
    GoRouteData Type-safe routes
    A class to represent a GoRoute in Type-safe routing.
    GoRouteInformationParser
    Converts between incoming URLs and a RouteMatchList using RouteMatcher. Also performs redirection using RouteRedirector.
    GoRouteInformationProvider
    The RouteInformationProvider created by go_router.
    GoRouter Configuration Deep linking Error handling Get started Named routes Navigation Redirection Upgrading Web
    The route configuration for the app.
    GoRouterDelegate
    GoRouter implementation of RouterDelegate.
    GoRouterState
    The route state during routing.
    ImperativeRouteMatch
    The route match that represent route pushed through GoRouter.push.
    IndentGuide
    The configuration used to indent and paint optional guides for tree nodes.
    InheritedGoRouter
    GoRouter implementation of InheritedWidget.
    IPadPro
    IPadPro3Gen
    IPhone55
    IPhone65
    MacOS
    NoTransitionPage<T>
    Custom transition page with no transition.
    ParentPreviewWidget
    Preview
    PreviewBoundary
    PreviewBoundaryState
    PreviewDummy
    PreviewScaffold
    RouteBase
    The base class for GoRoute and ShellRoute.
    RouteBuilder
    Builds the top-level Navigator for GoRouter.
    RouteConfiguration
    The route configuration for GoRouter configured by the app.
    RouteData
    Baseclass for supporting Type-safe routing.
    RouteInformationState<T>
    The data class to be stored in RouteInformation.state to be used by GoRouteInformationParser.
    RouteMatch
    An matched result by matching a GoRoute against a location.
    RouteMatchBase
    The base class for various route matches.
    RouteMatchList
    The list of RouteMatchBase objects.
    RoutingConfig Configuration
    A set of parameters that defines routing in GoRouter.
    ScopingLinesGuide
    The IndentGuide configuration for painting vertical lines at every level of the tree.
    Screenshot
    ShellRoute Configuration
    A route that displays a UI shell around the matching child route.
    ShellRouteBase
    Base class for classes that act as shells for sub-routes, such as ShellRoute and StatefulShellRoute.
    ShellRouteContext
    Context object used when building the shell and Navigator for a shell route.
    ShellRouteData
    A class to represent a ShellRoute in Type-safe routing.
    ShellRouteMatch
    An matched result by matching a ShellRoute against a location.
    SliverAnimatedTree<T extends Object>
    A wrapper around SliverList that adds tree viewing capabilities with support for automatic expand and collapse animations.
    SliverTree<T extends Object>
    A wrapper around SliverList that adds basic tree viewing capabilities.
    StatefulNavigationShell
    Widget for managing the state of a StatefulShellRoute.
    StatefulNavigationShellState
    State for StatefulNavigationShell.
    StatefulShellBranch
    Representation of a separate branch in a stateful navigation tree, used to configure StatefulShellRoute.
    StatefulShellBranchData
    Base class for supporting StatefulShellRoute
    StatefulShellRoute
    A route that displays a UI shell with separate Navigators for its sub-routes.
    StatefulShellRouteData
    Base class for supporting StatefulShellRoute
    TreeController<T extends Object>
    A controller used to dynamically manage the state of a tree.
    TreeEntry<T extends Object>
    Used to store useful information about node in a tree.
    TreeIndentation
    Widget responsible for indenting tree nodes and painting lines (if enabled).
    TreeView<T extends Object>
    A widget used to visualize tree hierarchies.
    TypedGoRoute<T extends GoRouteData>
    A superclass for each typed go route descendant
    TypedRoute<T extends RouteData>
    A superclass for each typed route descendant
    TypedShellRoute<T extends ShellRouteData>
    A superclass for each typed shell route descendant
    TypedStatefulShellBranch<T extends StatefulShellBranchData>
    A superclass for each typed shell route descendant
    TypedStatefulShellRoute<T extends StatefulShellRouteData>
    A superclass for each typed shell route descendant
    VirtualKeyboard
    Display a simulated on screen keyboard at the bottom of a child widget.

    Enums

    Background
    DeviceType
    A device form factor.
    The type of the navigation.

    Extensions

    BackgroundExt on Background
    DeviceInfoExtension on DeviceInfo
    GoRouterHelper on BuildContext
    Dart extension to add navigation function to a BuildContext object, e.g. context.go('/');
    LocaleExt on Locale

    Constants

    appContent → const String
    bigText → const String
    defaultGroup → const String
    midText → const String
    smallText → const String
    svgPaper → const String
    todoDescription → const String
    treeRootLevel → const int
    The default level used for root nodes when flattening the tree.

    Functions

    alwaysReturnsFalse([Object? _]) → bool
    A function that can take a nullable Object and will always return false.
    alwaysReturnsTrue([Object? _]) → bool
    A function that can take a nullable Object and will always return true.
    buildGenericDesktopMonitorDevice({required TargetPlatform platform, required String id, required String name, required Size screenSize, required Rect windowPosition, EdgeInsets safeAreas = EdgeInsets.zero, double pixelRatio = 2.0, EdgeInsets? rotatedSafeAreas, GenericDesktopMonitorFramePainter? framePainter}) → DeviceInfo
    Creates a generic desktop monitor device definition for the given name, target platform and screenSize. The windowPosition defines the position of a virtual window with a window frame adapted for the given platform.
    buildGenericLaptopDevice({required TargetPlatform platform, required String id, required String name, required Size screenSize, required Rect windowPosition, EdgeInsets safeAreas = EdgeInsets.zero, double pixelRatio = 2.0, EdgeInsets? rotatedSafeAreas, GenericLaptopFramePainter? framePainter}) → DeviceInfo
    Creates a generic laptop device definition.
    buildGenericPhoneDevice({required TargetPlatform platform, required String id, required String name, required Size screenSize, EdgeInsets safeAreas = EdgeInsets.zero, EdgeInsets rotatedSafeAreas = EdgeInsets.zero, double pixelRatio = 2.0, GenericPhoneFramePainter framePainter = const GenericPhoneFramePainter()}) → DeviceInfo
    Creates a generic phone device definition.
    buildGenericTabletDevice({required TargetPlatform platform, required String id, required String name, required Size screenSize, EdgeInsets safeAreas = EdgeInsets.zero, EdgeInsets rotatedSafeAreas = EdgeInsets.zero, double pixelRatio = 2.0, GenericTabletFramePainter framePainter = const GenericTabletFramePainter()}) → DeviceInfo
    Creates a generic tablet device definition.
    captureScreenshot(GlobalKey<State<StatefulWidget>> widgetKey) → Future<String>
    defaultFolderButtonTransitionBuilder(Widget child, Animation<double> animation) → Widget
    The default transition builder used by FolderButton.
    defaultTreeTransitionBuilder(BuildContext context, Widget child, Animation<double> animation) → Widget
    The default transition builder used by SliverTree to animate the expansion state changes of a tree node.
    processBasicScreenshots() → void
    processDeviceScreenshots() → void
    startCapturing({required Dummy dummy, required Future<String> callback(), required dynamic refreshContent(), required dynamic onStartCapturing(), required dynamic onFinishCapturing()}) → Future<void>

    Typedefs

    ChildrenProvider<T> = Iterable<T> Function(T node)
    Signature of a function that takes a T node and returns an Iterable<T>.
    DescendCondition<T> = bool Function(T node)
    Signature of a function that takes a T node and returns a bool.
    ExitCallback = FutureOr<bool> Function(BuildContext context, GoRouterState state)
    Signature for function used in RouteBase.onExit.
    GoExceptionHandler = void Function(BuildContext context, GoRouterState state, GoRouter router)
    The function signature of GoRouter.onException.
    GoRouterBuilderWithNav = Widget Function(BuildContext context, Widget child)
    Signature of a go router builder function with navigator.
    GoRouterPageBuilder = Page Function(BuildContext context, GoRouterState state)
    The page builder for GoRoute.
    GoRouterRedirect = FutureOr<String?> Function(BuildContext context, GoRouterState state)
    The signature of the redirect callback.
    GoRouterWidgetBuilder = Widget Function(BuildContext context, GoRouterState state)
    The widget builder for GoRoute.
    Signature for functions used to build Navigators
    ParentProvider<T> = T? Function(T node)
    Signature of a function that takes a T node and returns a T? parent.
    ParserExceptionHandler = RouteMatchList Function(BuildContext context, RouteMatchList routeMatchList)
    The function signature of GoRouteInformationParser.onParserException.
    PopPageWithRouteMatchCallback = bool Function(Route route, dynamic result, RouteMatchBase match)
    Signature for a function that takes in a route to be popped with the result and returns a boolean decision on whether the pop is successful.
    ReturnCondition<T> = bool Function(T node)
    Signature of a function that takes a T node and returns a bool.
    RouteMatchVisitor = bool Function(RouteMatchBase)
    The function signature for RouteMatchList.visitRouteMatches
    ShellNavigationContainerBuilder = Widget Function(BuildContext context, StatefulNavigationShell navigationShell, List<Widget> children)
    Builder for a custom container for the branch Navigators of a StatefulShellRoute.
    ShellRouteBuilder = Widget Function(BuildContext context, GoRouterState state, Widget child)
    The widget builder for ShellRoute.
    ShellRoutePageBuilder = Page Function(BuildContext context, GoRouterState state, Widget child)
    The page builder for ShellRoute.
    StatefulShellRouteBuilder = Widget Function(BuildContext context, GoRouterState state, StatefulNavigationShell navigationShell)
    The widget builder for StatefulShellRoute.
    StatefulShellRoutePageBuilder = Page Function(BuildContext context, GoRouterState state, StatefulNavigationShell navigationShell)
    The page builder for StatefulShellRoute.
    TreeNodeBuilder<T extends Object> = Widget Function(BuildContext context, TreeEntry<T> entry)
    Signature of a widget builder function for tree views.
    TreeTransitionBuilder = Widget Function(BuildContext context, Widget child, Animation<double> animation)
    Signature for a function that takes a widget and an animation to apply transitions if needed.
    Visitor<T> = void Function(T node)
    Signature of a function used to visit nodes during tree traversal.

    Exceptions / Errors

    GoError
    Thrown when GoRouter is used incorrectly.
    GoException
    Thrown when GoRouter can not handle a user request.