FormeSearchable<T extends Object> class

Inheritance

Constructors

FormeSearchable({required String name, required FormeQuery<T> query, WidgetBuilder? contentBuilder, double? heightProvider(BuildContext context)?, double? maxHeightProvider(BuildContext context)?, bool multiSelect = true, FormeSearchableSelectedItemsBuilder<T>? selectedItemsBuilder, Key? key, List<T>? initialValue, bool registrable = true, bool enabled = true, bool readOnly = false, int? order, bool quietlyValidate = false, Duration? asyncValidatorDebounce, AutovalidateMode? autovalidateMode, FormeValueChanged<List<T>>? onValueChanged, FormeFocusChanged<List<T>>? onFocusChanged, FormeFieldSetter<List<T>>? onSaved, FormeValidator<List<T>>? validator, FormeAsyncValidator<List<T>>? asyncValidator, FormeFieldValidationChanged<List<T>>? onValidationChanged, FormeFieldInitialed<List<T>>? onInitialed, InputDecoration? decoration, int? limit, FormeSearchableOnLimitExceeded<T>? onLimitExceeded, FormeFieldDecorator<List<T>>? decorator, Widget selectableItemBuilder(BuildContext context, int index, T data, bool isSelected)?, EdgeInsetsGeometry? contentPadding, bool open = false})
factory
FormeSearchable.bottomSheet({required String name, required FormeQuery<T> query, WidgetBuilder? contentBuilder, double? heightProvider(BuildContext context)?, double? maxHeightProvider(BuildContext context)?, FormeBottomSheetConfiguration? bottomSheetConfiguration, bool multiSelect = true, FormeSearchableSelectedItemsBuilder<T>? selectedItemsBuilder, Key? key, List<T>? initialValue, bool registrable = true, bool enabled = true, bool readOnly = false, int? order, bool quietlyValidate = false, Duration? asyncValidatorDebounce, AutovalidateMode? autovalidateMode, FormeValueChanged<List<T>>? onValueChanged, FormeFocusChanged<List<T>>? onFocusChanged, FormeFieldSetter<List<T>>? onSaved, FormeValidator<List<T>>? validator, FormeAsyncValidator<List<T>>? asyncValidator, FormeFieldValidationChanged<List<T>>? onValidationChanged, FormeFieldInitialed<List<T>>? onInitialed, InputDecoration? decoration, int? limit, FormeSearchableOnLimitExceeded<T>? onLimitExceeded, FormeFieldDecorator<List<T>>? decorator, Widget selectableItemBuilder(BuildContext context, int index, T data, bool isSelected)?, bool resizeToAvoidBottomInset = true, bool open = false})
factory
FormeSearchable.dialog({required String name, required FormeQuery<T> query, WidgetBuilder? contentBuilder, Size? sizeProvider(BuildContext context)?, FormeDialogConfiguration? dialogConfiguration, bool multiSelect = true, FormeSearchableSelectedItemsBuilder<T>? selectedItemsBuilder, Key? key, List<T>? initialValue, bool registrable = true, bool enabled = true, bool readOnly = false, int? order, bool quietlyValidate = false, Duration? asyncValidatorDebounce, AutovalidateMode? autovalidateMode, FormeValueChanged<List<T>>? onValueChanged, FormeFocusChanged<List<T>>? onFocusChanged, FormeFieldSetter<List<T>>? onSaved, FormeValidator<List<T>>? validator, FormeAsyncValidator<List<T>>? asyncValidator, FormeFieldValidationChanged<List<T>>? onValidationChanged, FormeFieldInitialed<List<T>>? onInitialed, InputDecoration? decoration, int? limit, FormeSearchableOnLimitExceeded<T>? onLimitExceeded, FormeFieldDecorator<List<T>>? decorator, Widget selectableItemBuilder(BuildContext context, int index, T data, bool isSelected)?, bool resizeToAvoidBottomInset = true, bool open = false})
factory
FormeSearchable.overlay({required String name, required FormeQuery<T> query, WidgetBuilder? contentBuilder, double maxHeightProvider(BuildContext context)?, bool multiSelect = true, FormeSearchableSelectedItemsBuilder<T>? selectedItemsBuilder, Key? key, List<T>? initialValue, bool registrable = true, bool enabled = true, bool readOnly = false, int? order, bool quietlyValidate = false, Duration? asyncValidatorDebounce, AutovalidateMode? autovalidateMode, FormeValueChanged<List<T>>? onValueChanged, FormeFocusChanged<List<T>>? onFocusChanged, FormeFieldSetter<List<T>>? onSaved, FormeValidator<List<T>>? validator, FormeAsyncValidator<List<T>>? asyncValidator, FormeFieldValidationChanged<List<T>>? onValidationChanged, FormeFieldInitialed<List<T>>? onInitialed, InputDecoration? decoration, int? limit, FormeSearchableOnLimitExceeded<T>? onLimitExceeded, FormeFieldDecorator<List<T>>? decorator, Widget selectableItemBuilder(BuildContext context, int index, T data, bool isSelected)?, bool open = false})
factory

Properties

asyncValidator → FormeAsyncValidator<List<T>>?
used to perform an async validate
finalinherited
asyncValidatorDebounce → Duration?
finalinherited
autovalidateMode → AutovalidateMode
finalinherited
builder → FormeFieldBuilder<List<T>>
finalinherited
contentBuilder → WidgetBuilder
used to build search fields & pagination & search result content widget
final
contentDecorator → (Widget Function(BuildContext context, Widget content)?)
final
decoration → InputDecoration?
final
decorator → FormeFieldDecorator<List<T>>?
used to decorate a field
finalinherited
enabled → bool
whether field is enabled,
finalinherited
fieldType → Type
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
initialValue → List<T>
finalinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
limit → int?
final
multiSelect → bool
whether support multi select
final
name → String
finalinherited
onEnableChanged → (void Function(FormeFieldController<List<T>> field, bool enable)?)
finalinherited
onFocusChanged → FormeFocusChanged<List<T>>?
finalinherited
onInitialed → FormeFieldInitialed<List<T>>?
called after FormeController or FormeFieldController initialed
finalinherited
onLimitExceeded → FormeSearchableOnLimitExceeded<T>?
callback when limit exceeded
final
onReadonlyChanged → (void Function(FormeFieldController<List<T>> field, bool readOnly)?)
finalinherited
onSaved → FormeFieldSetter<List<T>>?
finalinherited
onValidationChanged → FormeFieldValidationChanged<List<T>>?
used to listen field's validation changes
finalinherited
onValueChanged → FormeValueChanged<List<T>>?
finalinherited
open → bool
whether open search content when initialed
final
order → int?
used to support Forme.autovalidateByOrder
finalinherited
proxyBuilder → FormeSearchableProxyBuilder?
final
query → FormeQuery<T>
pagination query
final
quietlyValidate → bool
quietlyValidate
finalinherited
readOnly → bool
finalinherited
registrable → bool
whether this field can be registered to Forme
finalinherited
requestFocusOnUserInteraction → bool
whether request focus when field value changed
finalinherited
runtimeType → FormeFieldType
A representation of the runtime type of the object.
no setterinherited
selectedItemsBuilder → FormeSearchableSelectedItemsBuilder<T>?
used to build selected items widget
final
validator → FormeValidator<List<T>>?
finalinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → FormeFieldState<List<T>>
Creates the mutable state for this widget at a given location in the tree.
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