filter_list Plugin

FilterList is a flutter plugin which is designed to provide ease in flutter filter data from list of strings.

Download App

Data flow

Pass list of strings to FilterList.showFilterList().
Pass list of selected strings to show pre-selected text otherwise ignore it.
Invoke method FilterList.showFilterList() to display filter dialog.
Make selection from list.
Click All button to select all text from list.
Click Reset button to make all text unselected.
Click Apply buton to return selected list of strings.
On close icon clicked it close dialog and return null value.
Without making any selection Apply button is pressed it will return empty list of string.

Getting Started

1. Add library to your pubspec.yaml


dependencies:
  filter_list: ^0.0.1

2. Import library in dart file

import package:filter_list/filter_list.dart';

3. How to use FilterList

Create a list of Strings

  List<String> countList = [
    "One",
    "Two",
    "Three",
    "Four",
    "Five",
    "Six",
    "Seven",
    "Eight",
    "Nine",
    "Ten",
    "Eleven",
    "Tweleve",
    "Thirteen",
    "Fourteen",
    "Fifteen",
    "Sixteen",
    "Seventeen",
    "Eighteen",
    "Nineteen",
    "Twenty"
  ];
  List<String> selectedCountList = [];

Create a function and call `FilterList.showFilterList()` dialog on button clicked

  void _openFilterList() async {
    var list = await FilterList.showFilterList(
      context,
      allTextList: countList,
      height: 450,
      borderRadius: 20,
      headlineText: "Select Count",
      searchFieldHintText: "Search Here",
      selectedTextList: selectedCountList,
    );

    if (list != null) {
      setState(() {
        selectedCountList = List.from(list);
      });
    }
  }

Call `_openFilterList` function on `floatingActionButton` pressed

  @override
  Widget build(BuildContext context) {
    return Scaffold(
        appBar: AppBar(
          title: Text(widget.title),
        ),
        floatingActionButton: FloatingActionButton(
          onPressed: _openFilterList,
          tooltip: 'Increment',
          child: Icon(Icons.add),
        ),
        /// check for empty or null value selctedCountList
        body: selectedCountList == null || selectedCountList.length == 0
            ? Center(
                child: Text('No text selected'),
              )
            : ListView.separated(
                itemBuilder: (context, index) {
                  return ListTile(
                    title: Text(selectedCountList[index]),
                  );
                },
                separatorBuilder: (context, index) => Divider(),
                itemCount: selectedCountList.length));
  }