Skip to content

Commit

Permalink
Release 3.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Dimibe committed Sep 6, 2020
1 parent 6eb0934 commit aff16ea
Show file tree
Hide file tree
Showing 5 changed files with 107 additions and 169 deletions.
103 changes: 54 additions & 49 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,93 +1,98 @@
## [1.0.0] - 13.08.2019
## [3.4.0] - 06.09.2020

* Initial release
* New option `groupHeaderBuilder`: Same as `groupSeparatorBuilder` but will get the whole element instead of just the groupBy value.
* New option `stickyHeaderBackgroundColor`: If `useStickyGroupSeparators` used a custom background color can be set.

## [1.1.0] - 14.08.2019
## [3.3.0] - 24.07.2020

* Added example
* Edited readme and package description
* Fix performance issue: Don't rebuild widget when sticky header changes.

## [1.2.0] - 15.08.2019
## [3.2.3] - 04.07.2020

* Widget sort the list elements now according the `groupBy`value. Can be switched off through the parameter `sort`
* Add code documentation

## [1.2.1] - 18.08.2019
## [3.2.2] - 26.06.2020

* Improved documentary
* Fixed readme

## [1.3.0] - 10.03.2020
## [3.2.1] - 26.06.2020

* Add `order` option to the widget. With this the sorting of the groups can be reversed.
* Improved documentation
* Improved example

## [1.3.1] - 12.03.2020
## [3.2.0] - 23.06.2020

* Bugfix: The `order` option also works for groups which aren't comparable.
* Fixed performance issue when sticky group headers are actived. Widget now rebuilds only when necessary

## [2.0.0] - 18.03.2020
## [3.1.0] - 21.05.2020

* New Feature: Sticky Headers!
** To use the sticky header set `useStickyGroupSeparators` to `true`.
** The parameter `elements` is now required.
* Due to potential beaking changes the feature comes with a new major release.
* Sticky Headers now by default disabled.

## [2.0.1] - 28.03.2020
## [3.0.1] - 18.05.2020

* Bugfix: If no `separator` was specified a divider was rendered.
* Bugfix: Adding items dynamically to an existing group led to a new group to be created.
* Bugfix: error when groupby value not comparable.
* Bugfix: only set state when needed.

## [2.0.2] - 28.03.2020
## [3.0.0] - 05.05.2020

* Documentation
* New Feature: Floating Header - Sticky Headers can now float over the list. Set `floatingHeader` to `true`.
* Sticky Headers now by default active. Can be disabled by setting `useStickyGroupSeparators` to `false`.
* Bugfix: The Widget can now be used in `SliverChildListDelegate`.

## [2.1.0] - 02.04.2020
## [2.3.1] - 04.05.2020

* Fixed bug where wrong headers are displayed while using sticky headers.
* Bugfix: dispose controller only if not set throgh the widet.

## [2.3.0] - 06.04.2020

* New Feature: Indexed item builder. You can now define `indexedItemBuilder` instead of `itemBuilder`. The new method additionally provides the the current index as attribute.

## [2.2.0] - 04.04.2020

* Sorting items inside groups according to its comparable implmentation or alphabetical order.
* Fixed bug where items rendered wrong

## [2.3.0] - 06.04.2020
## [2.1.0] - 02.04.2020

* New Feature: Indexed item builder. You can now define `indexedItemBuilder` instead of `itemBuilder`. The new method additionally provides the the current index as attribute.
* Fixed bug where wrong headers are displayed while using sticky headers.

## [2.3.1] - 04.05.2020
## [2.0.2] - 28.03.2020

* Bugfix: dispose controller only if not set throgh the widet.
* Documentation

## [3.0.0] - 05.05.2020
## [2.0.1] - 28.03.2020

* New Feature: Floating Header - Sticky Headers can now float over the list. Set `floatingHeader` to `true`.
* Sticky Headers now by default active. Can be disabled by setting `useStickyGroupSeparators` to `false`.
* Bugfix: The Widget can now be used in `SliverChildListDelegate`.
* Bugfix: If no `separator` was specified a divider was rendered.
* Bugfix: Adding items dynamically to an existing group led to a new group to be created.

## [3.0.1] - 18.05.2020
## [2.0.0] - 18.03.2020

* Bugfix: error when groupby value not comparable.
* Bugfix: only set state when needed.
* New Feature: Sticky Headers!
** To use the sticky header set `useStickyGroupSeparators` to `true`.
** The parameter `elements` is now required.
* Due to potential beaking changes the feature comes with a new major release.

## [3.1.0] - 21.05.2020
## [1.3.1] - 12.03.2020

* Sticky Headers now by default disabled.
* Bugfix: The `order` option also works for groups which aren't comparable.

## [3.2.0] - 23.06.2020
## [1.3.0] - 10.03.2020

* Fixed performance issue when sticky group headers are actived. Widget now rebuilds only when necessary
* Add `order` option to the widget. With this the sorting of the groups can be reversed.

## [3.2.1] - 26.06.2020
## [1.2.1] - 18.08.2019

* Improved documentation
* Improved example
* Improved documentary

## [3.2.2] - 26.06.2020
## [1.2.0] - 15.08.2019

* Fixed readme
* Widget sort the list elements now according the `groupBy`value. Can be switched off through the parameter `sort`

## [3.2.3] - 04.07.2020
## [1.1.0] - 14.08.2019

* Add code documentation
* Added example
* Edited readme and package description

## [3.3.0] - 24.07.2020
## [1.0.0] - 13.08.2019

* Fix performance issue: Don't rebuild widget when sticky header changes.
* Initial release
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ A flutter `ListView` in which list items can be grouped to sections.
Add the package to your pubspec.yaml:

```yaml
grouped_list: ^3.3.0
grouped_list: ^3.4.0
```
In your dart file, import the library:
Expand All @@ -43,7 +43,10 @@ import 'package:grouped_list/grouped_list.dart';
|`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`| Function which gets the `groupBy`-value and returns an Widget which defines the group header separator | required | - |
|`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` |

Expand Down
83 changes: 24 additions & 59 deletions example/pubspec.lock
Original file line number Diff line number Diff line change
@@ -1,62 +1,55 @@
# Generated by pub
# See https://dart.dev/tools/pub/glossary#lockfile
packages:
archive:
dependency: transitive
description:
name: archive
url: "https://pub.dartlang.org"
source: hosted
version: "2.0.13"
args:
dependency: transitive
description:
name: args
url: "https://pub.dartlang.org"
source: hosted
version: "1.6.0"
async:
dependency: transitive
description:
name: async
url: "https://pub.dartlang.org"
source: hosted
version: "2.4.1"
version: "2.4.2"
boolean_selector:
dependency: transitive
description:
name: boolean_selector
url: "https://pub.dartlang.org"
source: hosted
version: "2.0.0"
characters:
dependency: transitive
description:
name: characters
url: "https://pub.dartlang.org"
source: hosted
version: "1.0.0"
charcode:
dependency: transitive
description:
name: charcode
url: "https://pub.dartlang.org"
source: hosted
version: "1.1.3"
collection:
clock:
dependency: transitive
description:
name: collection
name: clock
url: "https://pub.dartlang.org"
source: hosted
version: "1.14.12"
convert:
version: "1.0.1"
collection:
dependency: transitive
description:
name: convert
name: collection
url: "https://pub.dartlang.org"
source: hosted
version: "2.1.1"
crypto:
version: "1.14.13"
fake_async:
dependency: transitive
description:
name: crypto
name: fake_async
url: "https://pub.dartlang.org"
source: hosted
version: "2.1.4"
version: "1.1.0"
flutter:
dependency: "direct main"
description: flutter
Expand All @@ -73,21 +66,14 @@ packages:
path: ".."
relative: true
source: path
version: "3.3.0"
image:
dependency: transitive
description:
name: image
url: "https://pub.dartlang.org"
source: hosted
version: "2.1.12"
version: "3.4.0"
matcher:
dependency: transitive
description:
name: matcher
url: "https://pub.dartlang.org"
source: hosted
version: "0.12.6"
version: "0.12.8"
meta:
dependency: transitive
description:
Expand All @@ -101,21 +87,7 @@ packages:
name: path
url: "https://pub.dartlang.org"
source: hosted
version: "1.6.4"
petitparser:
dependency: transitive
description:
name: petitparser
url: "https://pub.dartlang.org"
source: hosted
version: "2.4.0"
quiver:
dependency: transitive
description:
name: quiver
url: "https://pub.dartlang.org"
source: hosted
version: "2.1.3"
version: "1.7.0"
sky_engine:
dependency: transitive
description: flutter
Expand All @@ -134,7 +106,7 @@ packages:
name: stack_trace
url: "https://pub.dartlang.org"
source: hosted
version: "1.9.3"
version: "1.9.5"
stream_channel:
dependency: transitive
description:
Expand Down Expand Up @@ -162,27 +134,20 @@ packages:
name: test_api
url: "https://pub.dartlang.org"
source: hosted
version: "0.2.15"
version: "0.2.17"
typed_data:
dependency: transitive
description:
name: typed_data
url: "https://pub.dartlang.org"
source: hosted
version: "1.1.6"
version: "1.2.0"
vector_math:
dependency: transitive
description:
name: vector_math
url: "https://pub.dartlang.org"
source: hosted
version: "2.0.8"
xml:
dependency: transitive
description:
name: xml
url: "https://pub.dartlang.org"
source: hosted
version: "3.6.1"
sdks:
dart: ">=2.7.0 <3.0.0"
dart: ">=2.9.0-14.0.dev <3.0.0"
Loading

0 comments on commit aff16ea

Please sign in to comment.