Skip to content

Commit

Permalink
docs: enforce keep-a-changelog format
Browse files Browse the repository at this point in the history
  • Loading branch information
clragon committed Nov 9, 2024
1 parent 946fdc6 commit 0a94e9b
Showing 1 changed file with 133 additions and 54 deletions.
187 changes: 133 additions & 54 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,110 +1,189 @@
## 4.1.0
## [4.1.0] - 2024-11-09

- Updates example
- Introduces [PagedSliverMasonryGrid](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagedSliverMasonryGrid-class.html).
- Removes pubspec.lock from version control.
### Added

## 4.0.0
- [PagedSliverMasonryGrid](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagedSliverMasonryGrid-class.html).

- Renames `PagedSliverBuilder` to [PagedLayoutBuilder](https://pub.dev/documentation/infinite_scroll_pagination/4.0.0/infinite_scroll_pagination/PagedLayoutBuilder-class.html) and adds support for creating layouts using the box protocol.
- Introduces [PagedMasonryGridView](https://pub.dev/documentation/infinite_scroll_pagination/4.0.0/infinite_scroll_pagination/PagedMasonryGridView-class.html).
- Introduces [PagedPageView](https://pub.dev/documentation/infinite_scroll_pagination/4.0.0/infinite_scroll_pagination/PagedPageView-class.html).
### Changed

## 3.2.0
- Updates example.

### Removed

- `pubspec.lock` from version control.

## [4.0.0] - 2023-08-17

### Added

- [PagedMasonryGridView](https://pub.dev/documentation/infinite_scroll_pagination/4.0.0/infinite_scroll_pagination/PagedMasonryGridView-class.html).
- [PagedPageView](https://pub.dev/documentation/infinite_scroll_pagination/4.0.0/infinite_scroll_pagination/PagedPageView-class.html).
- Support for the box protocol in [PagedLayoutBuilder](https://pub.dev/documentation/infinite_scroll_pagination/4.0.0/infinite_scroll_pagination/PagedLayoutBuilder-class.html).

### Changed

- Renames `PagedSliverBuilder` to [PagedLayoutBuilder](https://pub.dev/documentation/infinite_scroll_pagination/4.0.0/infinite_scroll_pagination/PagedLayoutBuilder-class.html).

## [3.2.0] - 2022-05-23

### Changed

- Migrates to Flutter 3.

## 3.1.0
## [3.1.0] - 2021-07-04

### Added

- [animated status transitions](https://pub.dev/packages/infinite_scroll_pagination/example#animating-status-transitions).

- Adds [animated status transitions](https://pub.dev/packages/infinite_scroll_pagination/example#animating-status-transitions).
## [3.0.1+1] - 2021-05-23

## 3.0.1+1
### Added

- Adds [Flutter Favorite](https://flutter.dev/docs/development/packages-and-plugins/favorites) status to the README.
- [Flutter Favorite](https://flutter.dev/docs/development/packages-and-plugins/favorites) status to the README.

## 3.0.1
## [3.0.1] - 2021-03-08

### Added

- New unit tests.

### Changed

- Fixes code formatting in ListenableListener.
- Updates [sliver_tools](https://pub.dev/packages/sliver_tools) dependency.
- Adds new unit tests.

## 3.0.0
### Fixed

- Code formatting in `ListenableListener`.

## [3.0.0] - 2021-03-04

### Changed

- Promotes null safety to stable release.
- Migrates example project to null safety.
- Migrates code samples to null safety.

## 3.0.0-nullsafety.0
## [3.0.0-nullsafety.0] - 2021-02-06

### Changed

- Migrates to null safety.

## 2.3.0
## [2.3.0] - 2021-01-15

### Added

- [alternative constructor](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagingController/PagingController.fromValue.html) to [PagingController](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagingController-class.html) receiving an initial [PagingState](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagingState-class.html).

### Changed

- Cookbook file name.
- LICENSE file.

- Adds an [alternative constructor](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagingController/PagingController.fromValue.html) to [PagingController](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagingController-class.html) receiving an initial [PagingState](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagingState-class.html).
- Changes Cookbook file name.
- Updates LICENSE file.
## [2.2.4] - 2021-01-08

## 2.2.4
### Fixed

- Fixes new page requests happening before the end of the current frame.
- New page requests happening before the end of the current frame.

## 2.2.3
## [2.2.3] - 2020-12-14

- Fixes a bug in which manually resetting to a previous page would stop requesting subsequent pages.
### Fixed

## 2.2.2
- Bug in which manually resetting to a previous page would stop requesting subsequent pages.

- Adds a condition to avoid requesting the first page when there are preloaded items.
## [2.2.2] - 2020-11-04

## 2.2.1
### Added

- Improves the error message displayed when calling a disposed [PagingController](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagingController-class.html).
- Adds `shrinkWrapFirstPageIndicators` property to [PagedSliverList](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagedSliverList-class.html), [PagedSliverGrid](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagedSliverGrid-class.html) and [PagedSliverBuilder](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagedSliverBuilder-class.html).
- Fixes separator being displayed on completed lists.
- Condition to avoid requesting the first page when there are preloaded items.

## 2.2.0+1
## [2.2.1] - 2020-10-21

### Added

- `shrinkWrapFirstPageIndicators` property to [PagedSliverList](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagedSliverList-class.html), [PagedSliverGrid](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagedSliverGrid-class.html), and [PagedSliverBuilder](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagedSliverBuilder-class.html).

### Improved

- Error message displayed when calling a disposed [PagingController](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagingController-class.html).

### Fixed

- Separator being displayed on completed lists.

## [2.2.0+1] - 2020-10-19

### Changed

- Constraints the Flutter SDK dependency to a minimum version of 1.22.0.

## 2.2.0
## [2.2.0] - 2020-10-18

### Added

- New constructor parameters from [ScrollView](https://api.flutter.dev/flutter/widgets/ScrollView-class.html) to [PagedListView](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagedListView-class.html) and [PagedGridView](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagedGridView-class.html).

## [2.1.0+1] - 2020-10-13

- Adds new constructor parameters from [ScrollView](https://api.flutter.dev/flutter/widgets/ScrollView-class.html) to [PagedListView](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagedListView-class.html) and [PagedGridView](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagedGridView-class.html).
### Added

## 2.1.0+1
- Link to [raywenderlich.com tutorial](https://www.raywenderlich.com/265121/infinite-scrolling-pagination-in-flutter).

- Adds link to [raywenderlich.com tutorial](https://www.raywenderlich.com/265121/infinite-scrolling-pagination-in-flutter).
- Changes examples to async/await.
### Changed

## 2.1.0
- Examples to async/await.

- Adds [noMoreItemsIndicatorBuilder](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagedChildBuilderDelegate/noMoreItemsIndicatorBuilder.html) to [PagedChildBuilderDelegate](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagedChildBuilderDelegate-class.html).
- Adds properties to both grid widgets to let you choose whether you want to display the progress, error and completed listing indicators as grid items or if you want to put them below the grid, as is in the list widgets.
## [2.1.0] - 2020-10-10

## 2.0.1
### Added

- Fixes [PagingController](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagingController-class.html) not calling its status listeners.
- [noMoreItemsIndicatorBuilder](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagedChildBuilderDelegate/noMoreItemsIndicatorBuilder.html) to [PagedChildBuilderDelegate](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagedChildBuilderDelegate-class.html).
- Properties to both grid widgets to let you choose whether to display the progress, error, and completed listing indicators as grid items or below the grid, as in the list widgets.

## 2.0.0
## [2.0.1] - 2020-10-03

### Fixed

- [PagingController](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagingController-class.html) not calling its status listeners.

## [2.0.0] - 2020-10-02

### Changed

- **BREAKING CHANGE**: Replaces [PagedDataSource](https://pub.dev/documentation/infinite_scroll_pagination/1.1.1/infinite_scroll_pagination/PagedDataSource-class.html) and [PagedStateChangeListener](https://pub.dev/documentation/infinite_scroll_pagination/1.1.1/infinite_scroll_pagination/PagedStateChangeListener-class.html) with [PagingController](https://pub.dev/documentation/infinite_scroll_pagination/latest/infinite_scroll_pagination/PagingController-class.html), favoring composition over inheritance.

## 1.1.1
## [1.1.1] - 2020-09-23

### Removed

- Scroll from first page progress indicator, first page error indicator, and no items found indicator.

## [1.1.0] - 2020-09-18

### Added

- [PagedStateChangeListener](https://pub.dev/documentation/infinite_scroll_pagination/1.1.0/infinite_scroll_pagination/PagedStateChangeListener-class.html).

## [1.0.0+2] - 2020-08-22

### Changed

- Removes scroll from first page progress indicator, first page error indicator and no items found indicator.
- README images reference URL.

## 1.1.0
### Added

- Adds [PagedStateChangeListener](https://pub.dev/documentation/infinite_scroll_pagination/1.1.0/infinite_scroll_pagination/PagedStateChangeListener-class.html).
- Documentation to `PagedDataSource` properties.

## 1.0.0+2
## [1.0.0+1] - 2020-08-22

- Changes README images reference URL.
- Adds documentation to PagedDataSource properties.
### Added

## 1.0.0+1
- Images to README.md.

- Adds images to README.md.
## [1.0.0] - 2020-08-22

## 1.0.0
### Added

- Initial release.

0 comments on commit 0a94e9b

Please sign in to comment.