SearchChoices<T>.multiple constructor Null safety
- {Key? key,
- required List<
DropdownMenuItem< items,T> > - Function? onChanged,
- List<
int> selectedItems = const [], - TextStyle? style,
- dynamic searchHint,
- dynamic hint,
- dynamic disabledHint,
- dynamic icon = const Icon(Icons.arrow_drop_down),
- dynamic underline,
- dynamic doneButton = "Done",
- 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,
- Function? displayItem,
- bool dialogBox = true,
- bool readOnly = false,
- bool rightToLeft = false,
- bool autofocus = true,
- Function? selectedAggregateWidgetFn,
- double padding = 10.0,
- Function? setOpenDialog}
Search choices Widget with a multiple 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: selectedItems not returning executed after the selection is done.selectedItems
indexes of items 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: selectedItems returning String|Widget displayed next to the selected items or the hint if none.underline
String|Widget|Function with parameter: selectedItems returning String|Widget displayed below the selected items or the hint if none.doneButton
String|Widget|Function with parameter: selectedItems returning String|Widget displayed at the top of the search dialog box. Cannot be null in multiple selection mode.label
String|Widget|Function with parameter: selectedItems returning String|Widget displayed above the selected items or the hint if none.closeButton
String|Widget|Function with parameter: selectedItems returning String|Widget displayed at the bottom of the search dialog box.displayClearIcon
whether or not to display an icon to clear the selected values.clearIcon
Icon to be used for clearing the selected values.iconEnabledColor
Color to be used for enabled icons.iconDisabledColor
Color to be used for disabled icons.iconSize
for the icons next to the selected values (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 values.keyboardType
used for the search.validator
Function with parameter: selectedItems returning String displayed below selected values when not valid and null when valid.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 values 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.
Implementation
factory SearchChoices.multiple({
Key? key,
required List<DropdownMenuItem<T>> items,
Function? onChanged,
List<int> selectedItems = const [],
TextStyle? style,
dynamic searchHint,
dynamic hint,
dynamic disabledHint,
dynamic icon = const Icon(Icons.arrow_drop_down),
dynamic underline,
dynamic doneButton = "Done",
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,
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,
}) {
return (SearchChoices._(
key: key,
items: items,
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: true,
selectedItems: selectedItems,
doneButton: doneButton,
onChanged: onChanged,
displayItem: displayItem,
dialogBox: dialogBox,
menuConstraints: menuConstraints,
readOnly: readOnly,
menuBackgroundColor: menuBackgroundColor,
rightToLeft: rightToLeft,
autofocus: autofocus,
selectedAggregateWidgetFn: selectedAggregateWidgetFn,
padding: padding,
setOpenDialog: setOpenDialog,
));
}