grouped_list 3.4.0

A Flutter ListView where the list items can be grouped into sections.

Grouped list package for Flutter.

A flutter ListView in which list items can be grouped to sections.

Features

• List Items can be separated in groups.
• For the groups an individual header can be set.
• Almost all fields from ListView.builder available.

Getting Started

Add the package to your pubspec.yaml:

 grouped_list: ^3.4.0

In your dart file, import the library:

import 'package:grouped_list/grouped_list.dart';

Instead of using a ListView create a GroupedListView Widget:

  GroupedListView<dynamic, String>(
    elements: _elements,
    groupBy: (element) => element['group'],
    groupSeparatorBuilder: (String groupByValue) => Text(groupByValue),
    itemBuilder: (context, dynamic element) => Text(element['name']),
    order: GroupedListOrder.ASC,
  ),

Parameters:

Name	Description	Required	Default value
elements	A list of the data you want to display in the list	required	-
groupBy	Function which maps an element to its grouped value	required	-
itemBuilder / indexedItemBuilder	Function which returns an Widget which defines the item. indexedItemBuilder provides the current index as well. If both are defined indexedItemBuilder is preferred	yes, either of them	-
groupSeparatorBuilder / groupHeaderBuilder	Function which returns an Widget which defines the group headers. While groupSeparatorBuilder gets the groupBy-value as parameter groupHeaderBuilder gets the whole element. If both are defined groupHeaderBuilder is preferred	yes, either of them	-
useStickyGroupSeparators	When set to true the group header of the current visible group will stick on top	no	false
floatingHeader	Whether the sticky group header float over the list or occupy it's own space	no	false
stickyHeaderBackgroundColor	Defines the background color of the sticky header. Will only be used if useStickyGroupSeparators is used	no	Color(0xffF7F7F7)
separator	A Widget which defines a separator between items inside a group	no	no separator
order	Change to GroupedListOrder.DESC to reverse the group sorting	no	GroupedListOrder.ASC

Also the fields from ListView.builder can be used.

Other packages :

Check out my other package StickyGroupedList, which is based on the scrollable_positioned_list and comes with sticky headers!