werkbank library

Werkbank;

Classes

AcceptableReport

AccessibilityAddon

AccessibilityManager

AcknowledgedAddon

This addon just displays the acknowledged state of the app. The state itself is managed by the Werkbank.

AcknowledgedController

AcknowledgedControllerImpl

AcknowledgedDescriptorEntry

AcknowledgedDescriptors

AcknowledgedTracker

Addon

AddonAccessor

A class that provides access to data in the BuildContext that is available from every place where the Addon API gives access to a BuildContext.

AddonConfig

A class that defines which addons are used. This needs to be passed to a WerkbankApp or DisplayApp. If you are using both, make sure to pass the same AddonConfig in order to ensure consistent behavior.

AddonConfigProvider

AddonControlSection

AddonControlSectionAccessor

A class that provides access to data in the BuildContext that is available from within the widgets built by the AddonControlSection.children of any subclass of AddonControlSection.

AddonDescription

AddonDescriptionAccessor

AddonLayerAccessor

A class that provides access to data in the BuildContext that is available from within the widgets built by the AddonLayerEntry.builder of any layer.

AddonLayerBuilder

AddonLayerEntries

AddonLayerEntry

AddonSpecification

An AddonSpecification is a simplified representation of an Addon that is available to other addons. It can be used in an Addon to make conditional decisions based on the availability of other addons, but not on their actual implementation.

AddonSpecificationsProvider

AffiliationTransitionLayerEntry

AffiliationTransitionLayerEntryAccessor

AnimationControllerKnob

AnimationControllerKnobSnapshot

AppConfig

A class that defines how to build the app widget, which is typically one of MaterialApp, CupertinoApp, or WidgetsApp.

ApplicationOverlayLayerEntry

ApplicationOverlayLayerEntryAccessor

BackgroundAddon

BackgroundManager

BackgroundOption

A selectable background option for uses cases, which can be added to the BackgroundAddon.

BorderBehavior

BuildableKnob<T>

A knob that can build a widget to control its value.

BuildableWritableKnob<T>

A base implementation of BuildableKnob that implements WritableKnob and manages the value of the knob.

ChildDescriptor

ColorPickerAddon

ComponentDescriptor

ConfigureControlSection

ConfigureControlSectionAccessor

ConstraintsAddon

ControlSection

CustomBackgroundOption

DebuggingAddon

DebugWerkbankFilter

DebugWerkbankFilterDisabled

DebugWerkbankFilterDisplayAllResults

DebugWerkbankFilterDisplayMatches

DebugWerkbankFilterDisplayOnly

DefaultBackgroundOption

DefinedKnobPreset

DefinedViewConstraintsPreset

DescriptionAddon

This addon provides the ability to add a description, urls and tags to a node and displays them in the configuration panel.

DescriptionEntry<T extends WerkbankNode>

DescriptionPriority

Descriptions

Descriptor

DescriptorNavState

DisplayApp

A widget that sets up the app for displaying use cases without the UI of a WerkbankApp. Usually one or more UseCaseDisplay widgets as descendants to display the use cases. Alternatively, the convenience constructor DisplayApp.singleUseCase can be used to display a single use case.

DraggableBorders

FocusNodeKnob

FocusNodeKnobSnapshot

FolderDescriptor

FullAccessNotificationsController

FullLayerEntryId

FuzzySearchData

FuzzySearchEntry

GlobalCallbackShortcuts

Historiographer

HistoryController

HistoryControllerImpl

HomeNavState

HomePageComponent

HomePageComponentAccessor

HotReloadEffectAddon

HotReloadEffectManager

InitialKnobPreset

InitialViewConstraintsPreset

InputParseError<T>

A parsing error result containing an error message.

InputParseResult<T>

The result of parsing an input String using an InputParser.

InputParseSuccess<T>

A successful parsing result containing the parsed value of type T.

InspectControlSection

InspectControlSectionAccessor

KeyOrText

Knob<T>

A knob to control a value in a use case.

KnobPreset

KnobsAddon

KnobSnapshot

The base class for an immutable snapshot of the value of a Knob. Since knobs in a use case may completely change after a hot reload, all Knobs are recreated on every execution of the UseCaseBuilder. To keep the state of a knob, their value is saved to a KnobSnapshot with BuildableKnob.createSnapshot and an attempt is made to restore it using BuildableKnob.tryLoadSnapshot.

LayoutInfo

LayoutReferenceLink

LocalizationAddon

LocalizationManager

MainViewOverlayLayerEntry

MainViewOverlayLayerEntryAccessor

ManagementLayerEntry

ManagementLayerEntryAccessor

MappingValueListenableBuilder<T, R>

NamedBackgroundOption

NamedCurve

NamedDouble

NamedDuration

NamedInterval

NavState

NewContentReport

NoneDraggableBorders

NotificationController

NotificationsController

NotificationSubscription

NullableKnob<T extends Object>

NullableKnobSnapshot

OrderingAddon

An Addon that enables control over the ordering of the WerkbankNode tree structure in the navigation panel.

OverviewNavState

OverviewSettings

PageTransitionAddon

An Addon that enables control over page transitions

PageTransitionEnablerManager

PanelController

PanelControllerProvider

PanelLayoutHandler

Sizes the panels and decides, if the panels need to be shrunk. Tells the PanelController to do so.

PanelTabsController

PanelTabsPersistentData

ParentDescriptor<T extends ChildDescriptor>

ParentOverviewNavState

PermanentReport

PersistenceInitializing

PersistenceReady

PersistentController

RecentHistoryAddon

This addon just displays the history of the app. The state itself is managed by the Werkbank.

RegularKnob<T>

RegularKnobSnapshot

RenderLayoutReference

RenderSScaledBox

RenderTwoColsLayout

Report

ReportAddon

RetainedUseCaseStateEntry<T extends RetainedUseCaseStateEntry<T>>

A state entry keeps state for a use case for its whole lifetime. Unlike TransientUseCaseStateEntrys, RetainedUseCaseStateEntrys are not recreated when the use case is recomposed, for example due to a hot reload.

RootDescriptor

SearchCluster

SearchClusterFoundation

SearchEntry

SearchQueryController

SearchQueryPersistentData

SelectableViewConstraintsPreset

SettingsControlSection

SettingsControlSectionAccessor

ShortcutsSection

SortHint

StateKeepingAddon

TabSectionData

ThemeOption

ThemingAddon

ThemingManager

TickerProviderProvider

TransientUseCaseStateEntry<T extends TransientUseCaseStateEntry<T, S>, S extends TransientUseCaseStateSnapshot>

A class that contains state for the use case that is not retained between hot reloads.

TransientUseCaseStateSnapshot

TwoColsLayoutParentData

UseCase

UseCaseComposer

A class of which an instance is passed to a UseCaseBuilder, allowing use cases to do all kinds of useful things with it.

UseCaseComposition

A class that holds the result of composing a use cases using a UseCaseComposer. An instance can be use to control the state of the use case as well as get the metadata of the use case.

UseCaseDescriptor

UseCaseDisplay

UseCaseFittedLayerEntry

UseCaseFittedLayerEntryAccessor

UseCaseLayerEntry

UseCaseLayerEntryAccessor

UseCaseLayoutLayerEntry

UseCaseLayoutLayerEntryAccessor

UseCaseMetadata

The metadata of a use case.

UseCaseMetadataEntry<T extends UseCaseMetadataEntry<T>>

A superclass for all metadata entries that can be dynamically added to a use case. This can be used to store additional information which can be read by addons or other methods inside the use case builder.

UseCaseNavState

UseCaseOverlayLayerEntry

UseCaseOverlayLayerEntryAccessor

UseCaseOverviewConfig

UseCaseOverviewEntry

UseCaseOverviewNavState

UseCaseSnapshot

An immutable snapshot of the TransientUseCaseStateEntrys of a use case. This can be obtained using UseCaseComposition.saveSnapshot and restored using UseCaseComposition.loadSnapshot.

UseCaseViewportTransform

An inherited widget that allows to provide a transform which is applied to the viewport of a use case.

ValueContainer<T extends Object>

ViewConstraints

ViewConstraintsPreset

ViewerAddon

ViewUseCaseNavState

WAnimatedVisibility

WasAliveController

WasAlivePersistentData

WasAliveTracker

WAutoChangePageIndicator

WBorderedBox

WButtonBase

WCheckerboardBackground

WChip

WCollapsibleHeight

WControlItem

WControlSectionList

WDelayedReveal

WDivider

WDraggableConstrainedBox

WDropdown<T>

A dropdown button with a custom design.

WDropdownMenuItem<T>

A dropdown menu item for WDropdown. It is used to create a dropdown menu item with a custom design.

WerkbankApp

The main entry point for a Werkbank.

WerkbankAppInfo

WerkbankChildNode

A WerkbankNode which is a child of a WerkbankParentNode.

WerkbankColorScheme

WerkbankComponent

A WerkbankNode that defines a collection of WerkbankUseCases. This is typically used when there are multiple use cases for a single component, such as a button or a switch.

WerkbankFolder

A WerkbankNode that defines a collection of WerkbankNodes.

WerkbankHistory

WerkbankHistoryEntry

WerkbankIcons

Identifiers for the icons.

WerkbankLogo

The Werkbank logo as a widget.

WerkbankNode

A node in the Werkbank tree.

WerkbankNotification

WerkbankNotifications

WerkbankNotificationsDisplay

WerkbankPalette

WerkbankParentNode<T extends WerkbankChildNode>

A superclass for WerkbankNodes which can have children.

WerkbankPersistence

WerkbankPersistencePhase

WerkbankRoot

A WerkbankNode that defines a collection of WerkbankChildNodes.

WerkbankRouter

A Proxy Router for the WerkbankApp since we don't want to expose GoRouter

WerkbankSettings

WerkbankTextTheme

WerkbankTheme

WerkbankThemeAddon

WerkbankUseCase

A WerkbankNode that defines a single use case.

WExpandedIndicator

WFieldBox

WHotReloadEffect

WIconButton

WKeyboardButton

WLayoutChangedNotifier

A widget which notifies calls a given onLayoutChanged callback when its size or relative transform changes. The transform is relative to the linked WLayoutReference widget or the PipelineOwner.rootNode if link is null.

WLayoutReference

WMarkdown

WNotification

WNotificationInAndOut

WOutlineBox

WOverviewTile

WPathDisplay

WPathText

WProjectInfoArea

WrappingAddon

An addon that allows use cases to wrap widgets around the WidgetBuilder returned by a UseCaseBuilder.

WResizablePanels

WritableKnob<T>

WScaledBox

WShortcut

WSlider

WSwitch

WTab

WTabView

WTempDisabler

This is a temporary workaround for easily adding a disabled state to an input widget. This should be removed, once proper disabled states have been implemented.

WTextArea

WTextField

WTitled

WTrailingButton

WTreeItem

WTreeNode

WTreeView

WTwoColsLayout

This widget is comparable to flutter_staggered_grid_view -> sliver_masonry_grid but it is not lazy and not using slivers.

Enums

AddonLayer

The AddonLayer describes where in the widget tree the AddonLayerEntry.builder is inserted.

ControlItemLayout

DescriptionMergeStrategy

Defines how a new description should be merged with an existing one.

NotificationStatus

OrderOption

PanelTab

SemanticsInspectionScope

SemanticsMode

UseCaseEnvironment

An enum that describes in which environment the use case is displayed within a WerkbankApp.

WerkbankEnvironment

An enum that describes in which environment everything is built.

WrappingLayer

An enum that defines where in the use case the wrapping should be applied.

Mixins

MaybeWerkbankAppAccessor

A mixin that provides access to data in the BuildContext that is available if they are built inside a WerkbankApp. The methods in this mixin will return null if the widget is not built inside a WerkbankApp but for example in a UseCaseDisplay.

PanelCalcMixin

SingleAttachmentMixin<T extends Object>

A mixin that allows to attach a single entity of type T to the class.

UseCaseAccessor

A mixin that provides access to data in the BuildContext that is available from every place where there is a specific use case in the BuildContext.

ValueGuardingKnobMixin<T>

A mixin that guards the value of a knob to only be accessed after the use case has finished composing.

ValueGuardingWritableKnobMixin<T>

A mixin that guards the value of a writable knob to only be set after the use case has finished composing.

WerkbankAppOnlyAccessor

A mixin that provides access to data in the BuildContext that is available inside a WerkbankApp.

Extension Types

AccessibilityComposition

BackgroundComposer

A composer for setting the default background of a use case.

ConstraintsComposition

ImmutableStateId

KnobId

A unique identifier for a knob.

KnobsComposer

KnobsComposition

MutableStateId

NullableKnobsComposer

OverviewComposer

An extension type with methods to control the presentation of use cases when they are displayed as a thumbnail in the overview.

StatesComposer

StatesComposition

ViewConstraintsComposer

Extensions

AccessibilityCompositionExtension on UseCaseComposition

AnimationControllerKnobsExtension on KnobsComposer

BackgroundComposerExtension on UseCaseComposer

BackgroundMetadataExtension on UseCaseMetadata

BooleanKnobExtension on KnobsComposer

CommonStatesComposerExtension on StatesComposer

This extension provides some convenience methods for common state types.

ConstraintsCompositionExtension on UseCaseComposition

CurvedIntervalKnobExtension on KnobsComposer

CurveKnobExtension on KnobsComposer

CustomDropdownKnobExtension on KnobsComposer

CustomFieldKnobExtension on KnobsComposer

CustomSliderKnobExtension on KnobsComposer

CustomSwitchKnobExtension on KnobsComposer

DateKnobExtension on KnobsComposer

DescriptionComposerExtension on UseCaseComposer

DescriptionMetadataExtension on UseCaseMetadata

DevicePresetComposerExtension on ViewConstraintsComposer

DoubleKnobExtension on KnobsComposer

FocusNodeKnobsExtension on KnobsComposer

IntervalKnobExtension on KnobsComposer

IntKnobExtension on KnobsComposer

KnobExtension on Knob<T>

KnobPresetsMetadataExtension on UseCaseMetadata

KnobsComposerExtension on UseCaseComposer

KnobsCompositionExtension on UseCaseComposition

ListExtension on List<T>

MillisKnobExtension on KnobsComposer

NullableBooleanKnobExtension on NullableKnobsComposer

NullableCustomDropdownKnobExtension on NullableKnobsComposer

NullableCustomFieldKnobExtension on NullableKnobsComposer

NullableCustomSliderKnobExtension on NullableKnobsComposer

NullableCustomSwitchKnobExtension on NullableKnobsComposer

NullableDateKnobExtension on NullableKnobsComposer

NullableDoubleKnobExtension on NullableKnobsComposer

NullableIntKnobExtension on NullableKnobsComposer

NullableKnobsExtension on KnobsComposer

NullableMillisKnobExtension on NullableKnobsComposer

NullableStringKnobExtension on NullableKnobsComposer

OverviewComposerExtension on UseCaseComposer

An extension on the UseCaseComposer which provides an overview getter to access an OverviewComposer with several methods to control the presentation of use cases when they are displayed as a thumbnail in the overview.

OverviewSettingsMetadataExtension on UseCaseMetadata

PlatformContextExtension on BuildContext

RegularKnobsExtension on KnobsComposer

SearchMetadataExtension on UseCaseMetadata

StatesComposerExtension on UseCaseComposer

StatesCompositionExtension on UseCaseComposition

StringKnobExtension on KnobsComposer

SupportedSizesComposerExtension on ViewConstraintsComposer

SupportedSizesMetadataExtension on UseCaseMetadata

TagsComposerExtension on UseCaseComposer

TagsMetadataExtension on UseCaseMetadata

UrlsComposerExtension on UseCaseComposer

UrlsMetadataExtension on UseCaseMetadata

UseCaseComposerSearchExtension on UseCaseComposer

ValueNotifierExtension on ValueNotifier<T>

ViewConstraintsComposerExtension on UseCaseComposer

ViewConstraintsExtension on ViewConstraintsComposer

ViewConstraintsMetadataExtension on UseCaseMetadata

WerkbankThemeExtension on BuildContext

WrappingComposerExtension on UseCaseComposer

Properties

debugWerkbankFilter → ValueListenable<DebugWerkbankFilter>

no setter

Functions

colorsUseCaseBuilder({required void builder(UseCaseComposer c), required Map<String, Color> colors(BuildContext context), double initialSize = 100, bool addTagsAndDescription = true, Color? surfaceColor, Color? onSurfaceColor}) → UseCaseBuilder

getThemeData(BuildContext context, WerkbankTheme werkbankTheme) → ThemeData

iconsUseCaseBuilder({required void builder(UseCaseComposer c), required Map<String, IconData> icons(BuildContext context), double initialSize = 48, bool addTagsAndDescription = true, Color? surfaceColor, Color? onSurfaceColor}) → UseCaseBuilder

mergeOrderings<T>({required List<T> primary, required List<T> secondary}) → List<T>

Creates an ordering of the union of the elements in primary and secondary, such that the elements in primary are kept in the same order (possibly with elements from secondary interspersed) and such that the number of inversion with respect to secondary is minimized.

textStylesUseCaseBuilder({required void builder(UseCaseComposer c), required Map<String, TextStyle> styles(BuildContext context), String? initialText, bool textInitiallyNull = true, bool addTagsAndDescription = true, Color? surfaceColor, Color? onSurfaceColor}) → UseCaseBuilder

updateDebugWerkbankFilter(DebugWerkbankFilter value) → void

Typedefs

AddonLayerWidgetBuilder = Widget Function(BuildContext context, Widget child)

AddonShortcutsInfoMap = Map<Set<KeyOrText>, ShortcutInfo>

AnyRetainedUseCaseStateEntry = _Self<RetainedUseCaseStateEntry<Object?>>

A typedef for any RetainedUseCaseStateEntry regardless of its generic type.

AnyTransientUseCaseStateEntry = _Self<TransientUseCaseStateEntry<Object?, TransientUseCaseStateSnapshot>>

A typedef for any TransientUseCaseStateEntry regardless of its generic types.

AppBuilder = Widget Function(BuildContext context, TransitionBuilder builder, Widget home)

ControllerMapFactory = Map<Type, PersistentController> Function(SharedPreferencesWithCache prefsWithCache)

ControlSectionId = String

DoubleDecoder<T> = T Function(double d)

DoubleEncoder<T> = double Function(T value)

DoubleFormatter = ValueFormatter<double>

InputParser<T> = InputParseResult<T> Function(String input)

A function that parses a String into an InputParseResult. This is either a InputParseSuccess with a value of type T or an InputParseError with an error message.

IntFormatter = ValueFormatter<int>

NullableKnobBuilder<T extends Object> = Widget Function(BuildContext context, bool enabled, ValueNotifier<T> valueNotifier)

PersistencePhaseWidgetBuilder = Widget Function(BuildContext context, WerkbankPersistencePhase phase)

RegularKnobBuilder<T> = Widget Function(BuildContext context, ValueNotifier<T> valueNotifier)

ShortcutInfo = String

ThemeBrightnessBuilder = Brightness Function(BuildContext context)

ThemedWidgetBuilder = Widget Function(BuildContext context, ThemeData theme)

ToggleVisibilityCallback = void Function(int index)

UseCaseBuilder = WidgetBuilder Function(UseCaseComposer c)

A builder function for a use case.

UseCaseParentBuilder = void Function(UseCaseComposer c)

A function too manipulate the UseCaseComposer like it would be done at the beginning of a UseCaseBuilder definition.

UseCaseStateMutation = void Function(UseCaseComposition controller)

A function that mutates the state of a use case using the provided UseCaseComposition.

ValueFormatter<T> = String Function(T value)

WidgetLayoutBuilder = Widget Function(BuildContext context, double leftPanelWidth, double rightPanelWidth)

WrapperBuilder = Widget Function(BuildContext context, Widget child)

A builder function that wraps a child with another widget.

Exceptions / Errors

AddonLayerEntryCycleError

DuplicateDescriptorPathsException