A package for easily creating multi-select widgets in a variety of ways

multi select flutter

multi select flutter is a package for easily creating multi-select widgets in a variety of ways.

features

• supports formfield features like validator.
• neutral default design that can be altered to your heart’s content.
• choose between a dialog or bottomsheet style widget.
• easily switch the listtype from list to chip.
• make your multi select searchable for larger lists.

install

add this to your pubspec.yaml file:

dependencies:
  multi_select_flutter: ^2.1.0

usage

multiselectdialog

can be used in the builder of showdialog() and triggered with your own button.

void _showmultiselectdialog(buildcontext context) async {
  await showdialog(
    context: context,
    builder: (ctx) {
      return  multiselectdialog(
        items: _animals.map((e) => multiselectitem(e, e)).tolist(),
        initialvalue: _selectedanimals,
        onconfirm: (values) {...},
      );
    },
  );
}

multiselectbottomsheet

can be used in the builder of showmodalbottomsheet() and triggered with your own button.

void _showmultiselect(buildcontext context) async {
  await showmodalbottomsheet(
    isscrollcontrolled: true, // required for min/max child size
    context: context,
    builder: (ctx) {
      return  multiselectbottomsheet(
        items: _animals.map((e) => multiselectitem(e, e)).tolist(),
        initialvalue: _selectedanimals,
        onconfirm: (values) {...},
        maxchildsize: 0.8,
      );
    },
  );
}

multiselectchipdisplay

this widget can be used alongside your own button, or it can be specified as a chipdisplay parameter of widgets like multiselectdialogfield.

to use this widget effectively, make sure to set the state any time the source list is changed.

you can also remove items from the source list in the ontap function.

multiselectchipdisplay(
  items: _selectedanimals.map((e) => multiselectitem(e, e)).tolist(),
  ontap: (value) {
    setstate(() {
      _selectedanimals.remove(value);
    });
  },
),

when using the chipdisplay parameter as part of a multiselectdialogfield for example, the multiselectchipdisplay still renders outside the boxdecoration of the field as seen here:

if you want to encapsulate the multiselectchipdisplay, wrap the multiselectdialogfield in a container and apply the decoration to that instead:

container(
  decoration: boxdecoration(...),
  child: multiselectdialogfield(
    items: _items,
    chipdisplay: multiselectchipdisplay(...),
  ),
),

multiselectdialogfield / multiselectbottomsheetfield

these widgets provide an inkwell button which open the dialog or bottom sheet.

multiselectbottomsheetfield(
  items: _animals.map((e) => multiselectitem(e, e.name)).tolist(),
  listtype: multiselectlisttype.chip,
  searchable: true,
  decoration: boxdecoration(...),
  onconfirm: (values) {
    setstate(() {
      _selectedanimals = values;
    });
  },
  chipdisplay: multiselectchipdisplay(),
),

multiselectdialogformfield / multiselectbottomsheetformfield

these widgets are the formfield versions of multiselectdialogfield and multiselectbottomsheetfield. you can make use of formfield parameters such as validator and onsaved.

it comes with a default bottom-border that can be overriden with the decoration parameter.

multiselectdialogformfield(
	items: _animals.map((e) => multiselectitem(e, e.name)).tolist(),
	key: _multiselectkey,
	validator: (value) {
	  if (value == null || value.isempty) {
	    return  "required";
	  }
	  return  null;
	},
	onconfirm: (values) {
	  setstate(() {
	    _selectedanimals = values;
	  });
	  _multiselectkey.currentstate.validate();
	},
),

constructors

multiselectdialog

multiselectdialogfield

multiselectdialogfield has all the parameters of multiselectdialog plus these extra parameters:

multiselectbottomsheet

multiselectbottomsheetfield

multiselectbottomsheetfield has all the parameters of multiselectbottomsheet plus these extra parameters:

multiselectdialogformfield / multiselectbottomsheetformfield

these widgets have all the parameters of their non-formfield counterparts, plus these extra parameters which come from the formfield class:

multiselectchipdisplay