PopupProps<T> class

Implementers

Constructors

PopupProps.bottomSheet({FlexFit fit = FlexFit.tight, Widget? title, bool showSearchBox = false, BottomSheetProps bottomSheetProps = const BottomSheetProps(), TextFieldProps searchFieldProps = const TextFieldProps(), ScrollbarProps scrollbarProps = const ScrollbarProps(), ListViewProps listViewProps = const ListViewProps(), SuggestedItemProps<T> suggestedItemProps = const SuggestedItemProps(), Duration searchDelay = const Duration(seconds: 1), VoidCallback? onDismissed, EmptyBuilder? emptyBuilder, DropdownSearchPopupItemBuilder<T>? itemBuilder, ErrorBuilder? errorBuilder, LoadingBuilder? loadingBuilder, bool showSelectedItems = false, DropdownSearchPopupItemEnabled<T>? disabledItemFn, bool disableFilter = false, bool cacheItems = false, PopupBuilder? containerBuilder, BoxConstraints constraints = const BoxConstraints(maxHeight: 500), bool interceptCallBacks = false, InfiniteScrollProps? infiniteScrollProps, ValueChanged<List<T>>? onItemsLoaded, ClickProps itemClickProps = const ClickProps()})
const
PopupProps.dialog({FlexFit fit = FlexFit.tight, Widget? title, bool showSearchBox = false, DialogProps dialogProps = const DialogProps(), TextFieldProps searchFieldProps = const TextFieldProps(), ScrollbarProps scrollbarProps = const ScrollbarProps(), ListViewProps listViewProps = const ListViewProps(), SuggestedItemProps<T> suggestedItemProps = const SuggestedItemProps(), Duration searchDelay = const Duration(seconds: 1), VoidCallback? onDismissed, EmptyBuilder? emptyBuilder, DropdownSearchPopupItemBuilder<T>? itemBuilder, ErrorBuilder? errorBuilder, LoadingBuilder? loadingBuilder, bool showSelectedItems = false, DropdownSearchPopupItemEnabled<T>? disabledItemFn, bool disableFilter = false, bool cacheItems = false, PopupBuilder? containerBuilder, BoxConstraints constraints = const BoxConstraints(minWidth: 500, maxWidth: 500, maxHeight: 600), bool interceptCallBacks = false, InfiniteScrollProps? infiniteScrollProps, ValueChanged<List<T>>? onItemsLoaded, ClickProps itemClickProps = const ClickProps()})
const
PopupProps.menu({Widget? title, FlexFit fit = FlexFit.tight, bool showSearchBox = false, MenuProps menuProps = const MenuProps(), TextFieldProps searchFieldProps = const TextFieldProps(), ScrollbarProps scrollbarProps = const ScrollbarProps(), ListViewProps listViewProps = const ListViewProps(), SuggestedItemProps<T> suggestedItemProps = const SuggestedItemProps(), Duration searchDelay = const Duration(seconds: 1), VoidCallback? onDismissed, EmptyBuilder? emptyBuilder, DropdownSearchPopupItemBuilder<T>? itemBuilder, ErrorBuilder? errorBuilder, LoadingBuilder? loadingBuilder, bool showSelectedItems = false, DropdownSearchPopupItemEnabled<T>? disabledItemFn, bool disableFilter = false, bool cacheItems = false, PopupBuilder? containerBuilder, BoxConstraints constraints = const BoxConstraints(maxHeight: 350), bool interceptCallBacks = false, InfiniteScrollProps? infiniteScrollProps, ValueChanged<List<T>>? onItemsLoaded, ClickProps itemClickProps = const ClickProps()})
const
PopupProps.modalBottomSheet({Widget? title, FlexFit fit = FlexFit.tight, bool showSearchBox = false, ModalBottomSheetProps modalBottomSheetProps = const ModalBottomSheetProps(), TextFieldProps searchFieldProps = const TextFieldProps(), ScrollbarProps scrollbarProps = const ScrollbarProps(), ListViewProps listViewProps = const ListViewProps(), SuggestedItemProps<T> suggestedItemProps = const SuggestedItemProps(), Duration searchDelay = const Duration(seconds: 1), VoidCallback? onDismissed, EmptyBuilder? emptyBuilder, DropdownSearchPopupItemBuilder<T>? itemBuilder, ErrorBuilder? errorBuilder, LoadingBuilder? loadingBuilder, bool showSelectedItems = false, DropdownSearchPopupItemEnabled<T>? disabledItemFn, bool disableFilter = false, bool cacheItems = false, PopupBuilder? containerBuilder, BoxConstraints constraints = const BoxConstraints(maxHeight: 500), bool interceptCallBacks = false, InfiniteScrollProps? infiniteScrollProps, ValueChanged<List<T>>? onItemsLoaded, ClickProps itemClickProps = const ClickProps()})
const

Properties

bottomSheetProps BottomSheetProps
BottomSheet mode props
final
cacheItems bool
if true, once all items are loaded, filtering is applied on cached items (no need to re call the API to get items) cacheItems and disableFilter could not be both true
final
constraints BoxConstraints
popup constraints
final
containerBuilder PopupBuilder?
used as container to the popup widget this could be very useful if you want to add extra actions/widget to the popup the popup widget is considered as a child
final
dialogProps DialogProps
dialog mode props
final
disabledItemFn DropdownSearchPopupItemEnabled<T>?
defines if an item of the popup is enabled or not, if the item is disabled, it cannot be clicked
final
disableFilter bool
false if the filter on items is applied by the plugin true if you want to handle by yourself the filtering (data already filtered by DB, API, ....)
final
emptyBuilder EmptyBuilder?
custom layout for empty results
final
errorBuilder ErrorBuilder?
custom layout for error
final
fit FlexFit
fit height depending on nb of result or keep height fix.
final
hashCode int
The hash code for this object.
no setterinherited
infiniteScrollProps InfiniteScrollProps?
infinite scroll params like skip (offset), take,...
final
interceptCallBacks bool
if true , the callbacks (onTap, onLongClick...) will be handled by the user
final
itemBuilder DropdownSearchPopupItemBuilder<T>?
custom UI for the item
final
itemClickProps ClickProps
properties of click
final
listViewProps ListViewProps
props for selection list view
final
loadingBuilder LoadingBuilder?
custom layout for loading items
final
Menu mode props
final
modalBottomSheetProps ModalBottomSheetProps
ModalBottomSheet mode props
final
mode PopupMode
popup mode
final
onDismissed VoidCallback?
called when popup is dismissed
final
onItemsLoaded ValueChanged<List<T>>?
called when loading new items
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scrollbarProps ScrollbarProps
scrollbar properties
final
searchDelay Duration
callback executed before applying value change delay before searching, change it to Duration(milliseconds: 0) if you do not use online search
final
searchFieldProps TextFieldProps
object that passes all props to search field
final
showSearchBox bool
the search box will be shown if true, hidden otherwise
final
showSelectedItems bool
select the selected item in the menu/dialog/bottomSheet of items
final
suggestedItemProps SuggestedItemProps<T>
suggested items props
final
title Widget?
popup title
final

Methods

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