Package selection guidance compiled from public package information, community data, and project usage.
A Flutter package that enables users to search and select values from a simple list using a TextField. It provides an intuitive autocomplete experience, allowing real-time filtering of options as the user types. The package is lightweight and easy to integrate, making it ideal for forms or input fields requiring quick selection from predefined data. It supports multiple platforms including Android, iOS, Web, macOS, Windows, and Linux.
Use cases
Form inputs with searchable options
Quick selection from large lists
User-friendly dropdown alternatives
Dynamic filtering in mobile and web apps
Simplified data entry workflows
Key features
Real-time search filtering
Simple integration with TextField
Supports multiple platforms
Lightweight and minimal dependencies
Customizable UI and styling
Suitable for
Developers building forms with searchable inputs
Apps needing fast data selection
Cross-platform applications
Projects prioritizing simplicity and performance
Considerations
Limited to basic list-based searches
No support for remote data sources
Requires manual handling of selected values
Not suitable for complex autocomplete scenarios
Original README
Original README snapshot from the linked source repository. Visit the repository for the latest content.
flutter_textfield_search
FTFS is a Flutter package which uses a TextField Widget to search and select a value from a list.
It's a simple, lightweight, and fully tested package unlike other "autocomplete" or textfield search
packages. View complete code coverage results in JSON
format here.
Usage
To use this package, add flutter_textfield_search as a dependency in your pubsec.yaml file.
Then include the widget anywhere you would normally use a TextField widget with a String for label,
a List for initialList, and a TextEditingController for controller.
Example MaterialApp using TextFieldSearch Widget
To get the value of the selected option, use addListener on the controller to listen for changes:
@override
void dispose() {
// Clean up the controller when the widget is removed from the
// widget tree.
myController.dispose();
super.dispose();
}
@override
void initState() {
super.initState();
// Start listening to changes.
myController.addListener(_printLatestValue);
}
_printLatestValue() {
print("Textfield value: ${myController.text}");
}
Selecting a List item from a Future List:
TextEditingController myController = TextEditingController();
// create a Future that returns List
Future<List> fetchData() async {
await Future.delayed(Duration(milliseconds: 5000));
List list = [];
String _inputText = myController.text;
// create a list from the text input of three items
// to mock a list of items from an http call
list.add(_inputText + ' Item 1');
list.add(_inputText + ' Item 2');
list.add(_inputText + ' Item 3');
return list;
}
@override
void dispose() {
// Clean up the controller when the widget is removed from the
// widget tree.
myController.dispose();
super.dispose();
}
// used within a MaterialApp (code shortened)
MaterialApp(
home: Scaffold(
body: TextFieldSearch(
label: 'My Label',
controller: myController
future: () {
return fetchData();
}
)
),
)
Selecting an object from a Future List:
TextEditingController myController = TextEditingController();
// create a Future that returns List
// IMPORTANT: The list that gets returned from fetchData must have objects that have a label property.
// The label property is what is used to populate the TextField while getSelectedValue returns the actual object selected
Future<List> fetchData() async {
await Future.delayed(Duration(milliseconds: 3000));
List list = [];
String _inputText = myController.text;
List jsonList = [
{
'label': _inputText + ' Item 1',
'value': 30
},
{
'label': _inputText + ' Item 2',
'value': 31
},
{
'label': _inputText + ' Item 3',
'value': 32
},
];
// create a list of 3 objects from a fake json response
list.add(TestItem.fromJson(jsonList[0]));
list.add(TestItem.fromJson(jsonList[1]));
list.add(TestItem.fromJson(jsonList[2]));
return list;
}
@override
void dispose() {
// Clean up the controller when the widget is removed from the
// widget tree.
myController.dispose();
super.dispose();
}
// used within a MaterialApp (code shortened)
MaterialApp(
home: Scaffold(
body: TextFieldSearch(
label: 'My Label',
controller: myController
future: () {
return fetchData();
},
getSelectedValue: (value) {
print(value); // this prints the selected option which could be an object
}
)
),
)
// Mock Test Item Class
class TestItem {
final String label;
dynamic value;
TestItem({ required this.label, this.value });
factory TestItem.fromJson(Map<String, dynamic> json) {
return TestItem(
label: json['label'],
value: json['value']
);
}
}
Issues
Please email any issues, bugs, or additional features you would like to see built to
arindone@nubeer.io.
Contributing
If you wish to contribute to this package you may fork the repository and make a pull request to
this repository.
Note: Testing by running flutter test --coverage will generate coverage/lcov.info.
Running bash test-coverage.sh will parse the lcov.info file into JSON format. This happens
automatically within the CI/CD pipeline on a pull request to main but it is always good to test
locally.