CustomDropdownTCB<T>.single constructor
CustomDropdownTCB<T>.single ({
- Key? key,
- List<
TCBDropdownMenuItem< ? items,T> > - Function? onChanged,
- T? value,
- TextStyle? style,
- dynamic searchHint,
- dynamic hint,
- dynamic disabledHint,
- dynamic icon = const Icon(Icons.arrow_drop_down),
- dynamic underline,
- dynamic doneButton,
- dynamic label,
- dynamic closeButton = "Close",
- bool displayClearIcon = true,
- Icon clearIcon = const Icon(Icons.clear),
- Color? iconEnabledColor,
- Color? iconDisabledColor,
- double iconSize = 24.0,
- bool isExpanded = false,
- bool isCaseSensitiveSearch = false,
- Function? searchFn,
- Function? onClear,
- Function? selectedValueWidgetFn,
- TextInputType keyboardType = TextInputType.text,
- Function? validator,
- bool assertUniqueValue = true,
- Function? displayItem,
- bool dialogBox = true,
- bool readOnly = false,
- bool rightToLeft = false,
- bool autofocus = true,
- Function? selectedAggregateWidgetFn,
- double padding = 10.0,
- Function? setOpenDialog,
- Widget buildDropDownDialog(
- Widget titleBar,
- Widget searchBar,
- Widget list,
- Widget closeButton,
- BuildContext dropDownContext,
- InputDecoration? searchInputDecoration,
- int? itemsPerPage,
- PointerThisPlease<
int> ? currentPage, - Widget customPaginationDisplay()?,
- Future<
Tuple2< futureSearchFn()?,List< >TCBDropdownMenuItem> , int> - Map<
String, Map< ? futureSearchOrderOptions,String, dynamic> > - Map<
String, Map< ? futureSearchFilterOptions,String, Object> > - dynamic emptyListWidget,
- Function? onTap,
Search choices Widget with a single choice that opens a dialog or a menu to let the user do the selection conveniently with a search.
items
with child: Widget displayed ; value: any object with .toString() used to match search keyword.onChanged
Function with parameter: value not returning executed after the selection is done.value
value to be preselected.style
used for the hint if it is given is String.searchHint
String|Widget|Function with no parameter returning String|Widget displayed at the top of the search dialog box.hint
String|Widget|Function with no parameter returning String|Widget displayed before any value is selected or after the selection is cleared.disabledHint
String|Widget|Function with no parameter returning String|Widget displayed instead of hint when the widget is displayed.icon
String|Widget|Function with parameter: value returning String|Widget displayed next to the selected item or the hint if none.underline
String|Widget|Function with parameter: value returning String|Widget displayed below the selected item or the hint if none.doneButton
String|Widget|Function with parameter: value returning String|Widget displayed at the top of the search dialog box.label
String|Widget|Function with parameter: value returning String|Widget displayed above the selected item or the hint if none.closeButton
String|Widget|Function with parameter: value returning String|Widget displayed at the bottom of the search dialog box.displayClearIcon
whether or not to display an icon to clear the selected value.clearIcon
Icon to be used for clearing the selected value.iconEnabledColor
Color to be used for enabled icons.iconDisabledColor
Color to be used for disabled icons.iconSize
for the icons next to the selected value (icon and clearIcon).isExpanded
can be necessary to avoid pixel overflows (zebra symptom).isCaseSensitiveSearch
only used when searchFn is not specified.searchFn
Function with parameters: keyword, items returning List<int> as the list of indexes for the items to be displayed.onClear
Function with no parameter not returning executed when the clear icon is tapped.selectedValueWidgetFn
Function with parameter: item returning Widget to be used to display the selected value.keyboardType
used for the search.validator
Function with parameter: value returning String displayed below selected value when not valid and null when valid.assertUniqueValue
whether to run a consistency check of the list of items.displayItem
Function with parameters: item, selected returning Widget to be displayed in the search list.dialogBox
whether the search should be displayed as a dialog box or as a menu below the selected value if any.menuConstraints
BoxConstraints used to define the zone where to display the search menu. Example: BoxConstraints.tight(Size.fromHeight(250)) . Not to be used for dialogBox = true.readOnly
bool whether to let the user choose the value to select or just present the selected value if any.menuBackgroundColor
Color background color of the menu whether in dialog box or menu mode.rightToLeft
bool mirrors the widgets display for right to left languages defaulted to false.autofocus
bool automatically focuses on the search field bringing up the keyboard defaulted to true.selectedAggregateWidgetFn
Function with parameter: list of widgets presenting selected values , returning Widget to be displayed to present the selected items.padding
double sets the padding around the DropdownButton, defaulted to 10.0.setOpenDialog
Function sets the function to call to set the function to call in order to open the dialog with the search terms string as a parameter, defaulted to null.buildDropDownDialog
Function controls the layout of the dropdown dialog.searchInputDecoration
InputDecoration sets the search bar decoration.itemsPerPage
int if set, organizes the search list per page with the given number of items displayed per page.currentPage
PointerThisPlease<int> ifitemsPerPage
is set, holds the page number for the search items to be displayed.customPaginationDisplay
Widget Function(Widget listWidget, int totalFilteredItemsNb, Function updateSearchPage) ifitemsPerPage
is set, customizes the display and the handling of the pagination on the search list.futureSearchFn
Future<int> Function(String keyword, List<TCBDropdownMenuItem> itemsListToClearAndFill, int pageNb)
used to search items from the network. Must return items(up toitemsPerPage
if set). Must return an int with the total number of results (allows the handling of pagination).futureSearchOrderOptions
Map<String, Map<String,dynamic>> whenfutureSearchFn
is set, can be used to display search order options specified in the form {"order1Name":{"icon":order1IconWidget,"asc":true},}. Please refer to the documentation example: https://github.com/lcuis/search_choices/blob/master/example/lib/main.dart.futureSearchFilterOptions
Map<String, Map<String, Object>> whenfutureSearchFn
is set, can be used to display search filters specified in the form {"filter1Name": {"icon":filter1IconWidget, "values":["value1",{"value2":filter1Value2Widget}}}. Please refer to the documentation example: https://github.com/lcuis/search_choices/blob/master/example/lib/main.dart.emptyListWidget
String|Widget|Function with parameter: keyword returning String|Widget displayed instead of the list of items in case it is empty.onTap
Function called when the user clicks on the Widget before it opens the dialog or the menu. Note that this is not called in case the Widget is disabled.
Implementation
factory CustomDropdownTCB.single({
Key? key,
List<TCBDropdownMenuItem<T>>? items,
Function? onChanged,
T? value,
TextStyle? style,
dynamic searchHint,
dynamic hint,
dynamic disabledHint,
dynamic icon = const Icon(Icons.arrow_drop_down),
dynamic underline,
dynamic doneButton,
dynamic label,
dynamic closeButton = "Close",
bool displayClearIcon = true,
Icon clearIcon = const Icon(Icons.clear),
Color? iconEnabledColor,
Color? iconDisabledColor,
double iconSize = 24.0,
bool isExpanded = false,
bool isCaseSensitiveSearch = false,
Function? searchFn,
Function? onClear,
Function? selectedValueWidgetFn,
TextInputType keyboardType = TextInputType.text,
Function? validator,
bool assertUniqueValue = true,
Function? displayItem,
bool dialogBox = true,
BoxConstraints? menuConstraints,
bool readOnly = false,
Color? menuBackgroundColor,
bool rightToLeft = false,
bool autofocus = true,
Function? selectedAggregateWidgetFn,
double padding = 10.0,
Function? setOpenDialog,
Widget Function(
Widget titleBar,
Widget searchBar,
Widget list,
Widget closeButton,
BuildContext dropDownContext,
)?
buildDropDownDialog,
InputDecoration? searchInputDecoration,
int? itemsPerPage,
PointerThisPlease<int>? currentPage,
Widget Function(Widget listWidget, int totalFilteredItemsNb,
Function updateSearchPage)?
customPaginationDisplay,
Future<Tuple2<List<TCBDropdownMenuItem>, int>> Function(
String? keyword,
String? orderBy,
bool? orderAsc,
List<Tuple2<String, String>>? filters,
int? pageNb)?
futureSearchFn,
Map<String, Map<String, dynamic>>? futureSearchOrderOptions,
Map<String, Map<String, Object>>? futureSearchFilterOptions,
dynamic emptyListWidget,
Function? onTap,
}) {
return (CustomDropdownTCB._(
key: key,
items: items,
onChanged: onChanged,
value: value,
style: style,
searchHint: searchHint,
hint: hint,
disabledHint: disabledHint,
icon: icon,
underline: underline,
iconEnabledColor: iconEnabledColor,
iconDisabledColor: iconDisabledColor,
iconSize: iconSize,
isExpanded: isExpanded,
isCaseSensitiveSearch: isCaseSensitiveSearch,
closeButton: closeButton,
displayClearIcon: displayClearIcon,
clearIcon: clearIcon,
onClear: onClear,
selectedValueWidgetFn: selectedValueWidgetFn,
keyboardType: keyboardType,
validator: validator,
label: label,
searchFn: searchFn,
multipleSelection: false,
doneButton: doneButton,
displayItem: displayItem,
dialogBox: dialogBox,
menuConstraints: menuConstraints,
readOnly: readOnly,
menuBackgroundColor: menuBackgroundColor,
rightToLeft: rightToLeft,
autofocus: autofocus,
selectedAggregateWidgetFn: selectedAggregateWidgetFn,
padding: padding,
setOpenDialog: setOpenDialog,
buildDropDownDialog: buildDropDownDialog,
searchInputDecoration: searchInputDecoration,
itemsPerPage: itemsPerPage,
currentPage: currentPage,
customPaginationDisplay: customPaginationDisplay,
futureSearchFn: futureSearchFn,
futureSearchOrderOptions: futureSearchOrderOptions,
futureSearchFilterOptions: futureSearchFilterOptions,
emptyListWidget: emptyListWidget,
onTap: onTap,
));
}