https://github.com/surfstudio/flutter-datalist
https://github.com/surfstudio/flutter-datalist
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/surfstudio/flutter-datalist
- Owner: surfstudio
- License: apache-2.0
- Created: 2021-07-09T05:38:33.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-04-26T13:35:37.000Z (about 3 years ago)
- Last Synced: 2023-08-01T12:24:27.303Z (almost 3 years ago)
- Language: Dart
- Size: 28.3 KB
- Stars: 6
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Data list
[](https://github.com/surfstudio/SurfGear/tree/main/packages/datalist)
[](https://codecov.io/gh/surfstudio/SurfGear)
[](https://pub.dev/packages/datalist)
[](https://pub.dev/packages/datalist)
[](https://pub.dev/packages/datalist/score)
This package made by [Surf](https://surf.ru).
## Description
### Data list limit-offset
The main entity - [`OffsetDataList`][dl_offset] - a list for paginated data through the limit / offset mechanism
Has methods:
1. `merge (DataList data)`, which allows you to combine 2 data blocks. The input should be only OffsetDataList
2. `int nextOffset` - returns the offset for the trace of the data block
3. `bool canGetMore` - indicates whether more data can be loaded
1. `#transform ()` - to convert data in a list
It can combine two subsequent blocks, and in reverse order.
[dl_offset]: lib/src/impl/datalist_limit_offset.dart
### Data list page-count
The main entity - [`PageCountDataList`][dl_pagecount] - a list of paginated data through the page / count mechanism
Has methods:
1. `merge (DataList data)`, which allows you to combine 2 data blocks. Input should be only PageCount DataList
2. `int getNextPage ()` - returns the number of the trace of the data block
3. `bool canGetMore` - indicates whether more data can be loaded
1. `#transform ()` - to convert data in a list
It can combine two subsequent blocks, and in reverse order.
[dl_pagecount]: lib/src/impl/datalist_page_count.dart
## Installation
Add `datalist` to your `pubspec.yaml` file:
```yaml
dependencies:
datalist: ^1.0.0
```
You can use both `stable` and `dev` versions of the package listed above in the badges bar.
## Example
Example with OffsetDataList:
```dart
const element0 = Element(0);
const element1 = Element(1);
const element2 = Element(2);
const element3 = Element(3);
const element4 = Element(4);
const element5 = Element(5);
const element6 = Element(6);
const element7 = Element(7);
const element8 = Element(8);
const element9 = Element(9);
final list1 = OffsetDataList(
data: [element1, element2, element3, element4, element5],
limit: 5,
offset: 4,
totalCount: 30,
);
final list2 = OffsetDataList(
data: [element0, element1, element2, element3, element4],
limit: 5,
offset: 9,
totalCount: 30,
);
final list3 = OffsetDataList(
data: [element5, element6, element7, element8, element9],
limit: 5,
offset: 14,
totalCount: 30,
);
list1
..mergeWithPredicate(list2, (element) => element.id)
..mergeWithPredicate(list3, (element) => element.id);
final list4 = OffsetDataList(
data: [
element1,
element2,
element3,
element4,
element5,
element0,
element6,
element7,
element8,
element9,
],
limit: 15,
offset: 4,
totalCount: 30,
);
expect(list1, equals(list4)); // true
```
Example with PageCountDataList:
```dart
final list1 = PageCountDataList(
data: [1, 2, 3, 4, 5],
startPage: 0,
numPages: 5,
pageSize: 1,
);
final list2 = PageCountDataList(
data: [6, 7, 8, 9, 10],
startPage: 1,
numPages: 5,
pageSize: 1,
);
final list3 = PageCountDataList(
data: [1, 6, 7, 8, 9, 10],
startPage: 0,
pageSize: 1,
numPages: 6,
);
list1.merge(list2);
expect(list1, equals(list3)); // true
```
## Changelog
All notable changes to this project will be documented in [this file](./CHANGELOG.md).
## Issues
For issues, file directly in the Issues section.
## Contribute
If you would like to contribute to the package (e.g. by improving the documentation, solving a bug or adding a cool new feature), please review our [contribution guide](../../CONTRIBUTING.md) first and send us your pull request.
Your PRs are always welcome.
## How to reach us
Please feel free to ask any questions about this package. Join our community chat on Telegram. We speak English and Russian.
[](https://t.me/SurfGear)
## License
[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)