ComponentsConfiguration<T> class
A base class that define the appearance of SelectionMenu and ListViewMenu.
It is simply a collection of components
and configurations.
A Component is a class with a builder method that returns a Widget, or Position and Size information, or simply a class that contains data related to layout.
This class can be subclassed. The subclass would assign values to the instance variables of ComponentsConfiguration. The subclasses can then be passed to SelectionMenu.componentsConfiguration or ListViewMenu.componentsConfiguration.
Two predefined subclasses are:
- DialogComponentsConfiguration a dialog or popup style appearance.
- DropdownComponentsConfiguration a dropdown style appearance.
Related examples can be found here.
Constructors
-
ComponentsConfiguration({required SearchFieldComponent searchFieldComponent, required TriggerComponent triggerComponent, TriggerFromItemComponent<
T> ? triggerFromItemComponent, required SearchingIndicatorComponent searchingIndicatorComponent, required AnimationComponent animationComponent, required ListViewComponent listViewComponent, required SearchBarComponent searchBarComponent, })
Properties
- animationComponent → AnimationComponent
-
Returns a container Widget that supports animation.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- listViewComponent → ListViewComponent
-
Returns a Widget which acts as a scrollable list.
final
-
final
-
final
-
Returns a Widget that wraps SearchBarComponent and ListViewMenu.
final
-
Defines flex values for some components.
final
-
Returns a
MenuSizeAndPosition
after performing some calculation.final -
Defines the size and behaviour of menu in various conditions.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- searchBarComponent → SearchBarComponent
-
Returns a Widget that wraps SearchingIndicatorComponent and
SearchFieldComponent.
final
- searchFieldComponent → SearchFieldComponent
-
Defines a builder that returns a Widget where a user can input text.
final
- searchingIndicatorComponent → SearchingIndicatorComponent
-
Returns a Widget that acts as an Indicator for when search is in progress.
final
- triggerComponent → TriggerComponent
-
Returns a Widget that acts as a button(trigger) to open/close menu.
final
-
triggerFromItemComponent
→ TriggerFromItemComponent<
T> ? -
Returns a Widget that acts as a trigger(like a button for example) to
open/close menu, where the trigger reflects the currently selected item.
final
Methods
-
copyWith(
{SearchFieldComponent? searchFieldComponent, TriggerComponent? triggerComponent, TriggerFromItemComponent< T> ? triggerFromItemComponent, SearchingIndicatorComponent? searchingIndicatorComponent, AnimationComponent? animationComponent, ListViewComponent? listViewComponent, SearchBarComponent? searchBarComponent, }) → ComponentsConfiguration<T> - Returns a ComponentsConfiguration constructed from the values of this, overwritten by the non-null arguments passed to the method.
-
disposeListViewMenuComponents(
) → void - Dispose Components used by ListViewMenu.
-
disposeSelectionMenuComponents(
) → void - Dispose Components used by SelectionMenu.
-
initListViewMenuComponents(
) → void - Initialize Components used by ListViewMenu.
-
initSelectionMenuComponents(
) → void - Initialize Components used by SelectionMenu.
-
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