Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 2.0.0 #27

Merged
merged 27 commits into from
Jul 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
b1b353e
added base render object with overlay
TatsuUkraine Jun 30, 2020
fc13402
added alignment resolution
TatsuUkraine Jun 30, 2020
c15b98b
added models folder with types definitions
TatsuUkraine Jun 30, 2020
f6fe78a
rename methods
TatsuUkraine Jun 30, 2020
06a58b9
fixed overlay calculation issues
TatsuUkraine Jun 30, 2020
a6263c0
added assert for alignment positioning
TatsuUkraine Jun 30, 2020
07e7acd
added padding to list item
TatsuUkraine Jun 30, 2020
922f91f
refactored content layout
TatsuUkraine Jul 1, 2020
61a3021
added documentation
TatsuUkraine Jul 1, 2020
7a773e6
rename render file
TatsuUkraine Jul 1, 2020
298dbd5
update readme, added documentation, make overlay flag public
TatsuUkraine Jul 1, 2020
9338a32
bump version
TatsuUkraine Jul 1, 2020
f18d27d
remove unused file, remove legacy params from readme
TatsuUkraine Jul 1, 2020
1f90fb0
fixed content offset calculation
TatsuUkraine Jul 1, 2020
8df27dc
rename min/max count props to pos/neg
TatsuUkraine Jul 1, 2020
2bac1cf
use static text direction
TatsuUkraine Jul 1, 2020
0c98b00
update class docs
TatsuUkraine Jul 1, 2020
0de45d8
added migration guide
TatsuUkraine Jul 1, 2020
dad452f
update base example link
TatsuUkraine Jul 1, 2020
6ed40af
update positioning examples
TatsuUkraine Jul 1, 2020
d8121b0
update examples
TatsuUkraine Jul 1, 2020
4d3d77d
update examples
TatsuUkraine Jul 1, 2020
4f0c02d
update single scroll examples
TatsuUkraine Jul 1, 2020
54d5b4d
added release description to changelog
TatsuUkraine Jul 1, 2020
335ad31
updated release description to changelog
TatsuUkraine Jul 1, 2020
340610a
remove author from pubspec
TatsuUkraine Jul 1, 2020
9dcdcd6
Merge pull request #26 from TatsuUkraine/2.0.0-dev
TatsuUkraine Jul 1, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
## [2.0.0] - 2020-07-02

**Features**
- refactor sticky item layout calculation
- split alignment param on main and cross axis alignment
- added padding property to `InfiniteListItem`
- added relative positioning for header
[#19](https://github.com/TatsuUkraine/flutter_sticky_infinite_list/issues/19)

**Release contains breaking changes, see MIGRATION.md for more details**

## [1.3.0] - 2020-04-28

**Features**
Expand Down
47 changes: 47 additions & 0 deletions MIGRATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Migration guide

## Migration From v1.x.x to v2.x.x

### Child count params

In `InfiniteList` next params for max child count was renamed:
- `minChildCount` was renamed to `negChildCount` and now it works with
positive numbers
- `maxChildCount` was renamed to `posChildCount` and, as before, it
works with positive numbers

### Header alignment

Param `headerAlignment` in `InfiniteListItem` was replaced with 2
params: `mainAxisAlignment` and `crossAxisAlignment`

Main axis is placed with scroll direction: vertical or horizontal.

With `mainAxisAlignment: HeaderMainAxisAlignment.start` and vertical
scroll header will stick to the top edge, with horizontal scroll - to
the left edge. Similar with `mainAxisAlignment:
HeaderMainAxisAlignment.end` - bottom and right side respectively.

`crossAxisAlignment` doesn't affect stick side. It just places header to
the left or right side for the vertical scroll, and top or bottom - for
horizontal scroll.

New parameter was added for relative positioning: `positionAxis` which
defines what direction should be used during layout - column or row.

### List item layout

Comparing to v1, v2 by default uses relative positioning.

To make header overlay content use constructor `overlay`. It's available
in both `InfiniteListItem` and `StickyListItem` widgets.

### Initial header render

In default constructor param `initialHeaderBuild` was removed.

Since default constructor uses relative positioning, header is required
to calculate appropriate item size.

`initialHeaderBuild` is still available in `overlay` constructors and
affects header render like it was before in v1.x.x
Loading