CustomDropdown<T> class
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- CustomDropdown
Constructors
-
CustomDropdown({Key? key, required List<
T> ? items, required dynamic onChanged(T)?, T? initialItem, String? hintText, CustomDropdownDecoration? decoration, String? validator(T?)?, bool validateOnChange = true, _ListItemBuilder<T> ? listItemBuilder, _HeaderBuilder<T> ? headerBuilder, _HintBuilder? hintBuilder, int maxlines = 1, double? overlayHeight, EdgeInsets? closedHeaderPadding, EdgeInsets? expandedHeaderPadding, EdgeInsets? itemsListPadding, EdgeInsets? listItemPadding, bool canCloseOutsideBounds = true, bool hideSelectedFieldWhenExpanded = false, bool excludeSelected = true}) -
CustomDropdown.multiSelect({Key? key, required List<
T> ? items, required dynamic onListChanged(List<T> )?, List<T> ? initialItems, String? listValidator(List<T> )?, _HeaderListBuilder<T> ? headerListBuilder, String? hintText, CustomDropdownDecoration? decoration, bool validateOnChange = true, _ListItemBuilder<T> ? listItemBuilder, _HintBuilder? hintBuilder, bool canCloseOutsideBounds = true, bool hideSelectedFieldWhenExpanded = false, int maxlines = 1, double? overlayHeight, EdgeInsets? closedHeaderPadding, EdgeInsets? expandedHeaderPadding, EdgeInsets? itemsListPadding, EdgeInsets? listItemPadding}) -
CustomDropdown.multiSelectSearch({Key? key, required List<
T> ? items, required dynamic onListChanged(List<T> )?, List<T> ? initialItems, String? listValidator(List<T> )?, _ListItemBuilder<T> ? listItemBuilder, _HintBuilder? hintBuilder, CustomDropdownDecoration? decoration, _HeaderListBuilder<T> ? headerListBuilder, String? noResultFoundText, _NoResultFoundBuilder? noResultFoundBuilder, String? hintText, String? searchHintText, bool validateOnChange = true, bool canCloseOutsideBounds = true, bool hideSelectedFieldWhenExpanded = false, int maxlines = 1, double? overlayHeight, EdgeInsets? closedHeaderPadding, EdgeInsets? expandedHeaderPadding, EdgeInsets? itemsListPadding, EdgeInsets? listItemPadding}) -
CustomDropdown.multiSelectSearchRequest({Key? key, required Future<
List< futureRequest(String)?, required dynamic onListChanged(List<T> >T> )?, Duration? futureRequestDelay, List<T> ? initialItems, List<T> ? items, String? hintText, CustomDropdownDecoration? decoration, String? searchHintText, String? noResultFoundText, _HeaderListBuilder<T> ? headerListBuilder, _ListItemBuilder<T> ? listItemBuilder, _HintBuilder? hintBuilder, _NoResultFoundBuilder? noResultFoundBuilder, String? listValidator(List<T> )?, bool validateOnChange = true, int maxlines = 1, double? overlayHeight, Widget? searchRequestLoadingIndicator, EdgeInsets? closedHeaderPadding, EdgeInsets? expandedHeaderPadding, EdgeInsets? itemsListPadding, EdgeInsets? listItemPadding, bool canCloseOutsideBounds = true, bool hideSelectedFieldWhenExpanded = false}) -
const
-
CustomDropdown.search({Key? key, required List<
T> ? items, required dynamic onChanged(T)?, T? initialItem, String? hintText, CustomDropdownDecoration? decoration, String? searchHintText, String? noResultFoundText, _ListItemBuilder<T> ? listItemBuilder, _HeaderBuilder<T> ? headerBuilder, _HintBuilder? hintBuilder, _NoResultFoundBuilder? noResultFoundBuilder, String? validator(T?)?, bool validateOnChange = true, int maxlines = 1, double? overlayHeight, EdgeInsets? closedHeaderPadding, EdgeInsets? expandedHeaderPadding, EdgeInsets? itemsListPadding, EdgeInsets? listItemPadding, bool excludeSelected = true, bool canCloseOutsideBounds = true, bool hideSelectedFieldWhenExpanded = false}) -
CustomDropdown.searchRequest({Key? key, required Future<
List< futureRequest(String)?, required dynamic onChanged(T)?, Duration? futureRequestDelay, T? initialItem, List<T> >T> ? items, String? hintText, CustomDropdownDecoration? decoration, String? searchHintText, String? noResultFoundText, _ListItemBuilder<T> ? listItemBuilder, _HeaderBuilder<T> ? headerBuilder, _HintBuilder? hintBuilder, _NoResultFoundBuilder? noResultFoundBuilder, String? validator(T?)?, bool validateOnChange = true, int maxlines = 1, double? overlayHeight, EdgeInsets? closedHeaderPadding, EdgeInsets? expandedHeaderPadding, EdgeInsets? itemsListPadding, EdgeInsets? listItemPadding, Widget? searchRequestLoadingIndicator, bool excludeSelected = true, bool canCloseOutsideBounds = true, bool hideSelectedFieldWhenExpanded = false}) -
const
Properties
- canCloseOutsideBounds → bool
-
Can close CustomDropdown overlay by tapping outside.
Here "outside" covers the entire screen.
final
- closedHeaderPadding → EdgeInsets?
-
Padding for CustomDropdown header (closed state).
final
- decoration → CustomDropdownDecoration?
-
CustomDropdown decoration.
Contain sub-decorations SearchFieldDecoration, ListItemDecoration and ScrollbarThemeData.
final
- excludeSelected → bool
-
Hide the selected item from the items list.
final
- expandedHeaderPadding → EdgeInsets?
-
Padding for CustomDropdown header (opened/expanded state).
final
-
futureRequest
→ (Future<
List< Function(String)?)T> > -
The asynchronous computation from which the items list returns.
final
- futureRequestDelay → Duration?
-
Duration after which the futureRequest is to be executed.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
headerBuilder
→ _HeaderBuilder<
T> ? -
The headerBuilder that will be used to build CustomDropdown header field.
final
-
headerListBuilder
→ _HeaderListBuilder<
T> ? -
The headerListBuilder that will be used to build CustomDropdown header field.
final
- hideSelectedFieldWhenExpanded → bool
-
Hide the header field when CustomDropdown overlay opened/expanded.
final
- hintBuilder → _HintBuilder?
-
The hintBuilder that will be used to build CustomDropdown hint of header field.
final
- hintText → String?
-
Text that suggests what sort of data the dropdown represents.
final
- initialItem → T?
-
Initial selected item from the list of items.
final
-
initialItems
→ List<
T> ? -
Initial selected items from the list of items.
final
-
items
→ List<
T> ? -
The list of items user can select.
final
- itemsListPadding → EdgeInsets?
-
Padding for CustomDropdown items list.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
listItemBuilder
→ _ListItemBuilder<
T> ? -
The listItemBuilder that will be used to build item on demand.
final
- listItemPadding → EdgeInsets?
-
Padding for CustomDropdown each list item.
final
-
listValidator
→ (String? Function(List<
T> )?) -
A method that validates the selected items.
Returns an error string to display as per the validation, or null otherwise.
final
- maxlines → int
-
Text maxlines for header and list item text.
final
- noResultFoundBuilder → _NoResultFoundBuilder?
-
The noResultFoundBuilder that will be used to build area when there's no search results match.
final
- noResultFoundText → String?
-
Text that notify there's no search results match.
final
- onChanged → (dynamic Function(T)?)
-
Called when the item of the CustomDropdown should change.
final
-
onListChanged
→ (dynamic Function(List<
T> )?) -
Called when the list of items of the CustomDropdown should change.
final
- overlayHeight → double?
-
CustomDropdown opened/expanded area height.
Only applicable if items are greater than 4 otherwise adjust automatically.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- searchHintText → String?
-
Text that suggests what to search in the search field.
final
- searchRequestLoadingIndicator → Widget?
-
Widget to display while search request loading.
final
- validateOnChange → bool
-
Enable the validation listener on item change.
This implies to validator everytime when the item change.
final
- validator → (String? Function(T?)?)
-
A method that validates the selected item.
Returns an error string to display as per the validation, or null otherwise.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< CustomDropdown< T> > -
Creates the mutable state for this widget at a given location in the tree.
override
-
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}) → 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