Orientação gerada a partir de informações públicas. Apenas para referência.
Um pacote Flutter que permite aos usuários pesquisar e selecionar valores de uma lista simples usando um TextField. Ele oferece uma experiência de autocompletar intuitiva, permitindo a filtragem em tempo real das opções enquanto o usuário digita. O pacote é leve e fácil de integrar, sendo ideal para formulários ou campos de entrada que exigem seleção rápida de dados pré-definidos. Suporta múltiplas plataformas, incluindo Android, iOS, Web, macOS, Windows e Linux.
Casos de uso
Entradas de formulário com opções pesquisáveis
Seleção rápida em grandes listas
Alternativas amigáveis ao menu suspenso
Filtragem dinâmica em aplicativos móveis e web
Fluxos de trabalho de entrada de dados simplificados
Principais recursos
Filtragem de busca em tempo real
Integração simples com TextField
Suporta múltiplas plataformas
Leve e dependências mínimas
UI e estilização personalizáveis
Indicado para
Desenvolvedores criando formulários com entradas pesquisáveis
Aplicativos que precisam de seleção rápida de dados
Aplicações multiplataforma
Projetos que priorizam simplicidade e desempenho
Considerações
Limitado a pesquisas básicas baseadas em listas
Sem suporte para fontes de dados remotas
Requer manipulação manual dos valores selecionados
Não adequado para cenários complexos de autocomplete
README original
Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.
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.