Skip to content

Commit 563820c

Browse files
dangngocducdangngocduc
committed
docs: update example
1 parent 208432b commit 563820c

12 files changed

+92
-105
lines changed

‎CHANGELOG.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1-
## [0.0.1] - TODO: Add release date.
1+
# 1.0.0
22

3-
* TODO: Describe initial release.
3+
- feat: `ListView`, 'GridView' with `PageKeyedDataSource`
4+
# 1.0.1
5+
6+
-docs: Update example

‎LICENSE

+21-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,21 @@
1-
TODO: Add your license here.
1+
MIT License
2+
3+
Copyright (c) 2020 Dang Ngoc Duc
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎example/lib/main.dart

+44-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
1-
import 'package:example/pages/grid_view_page.dart';
1+
import 'dart:developer' as developer;
2+
23
import 'package:example/pages/list_view_page.dart';
3-
import 'package:example/pages/sliver_app_bar_list_view_page.dart';
4+
import 'package:example/widgets/note_widget.dart';
45
import 'package:flutter/material.dart';
6+
import 'package:paging/paging.dart' as paging;
7+
8+
import 'data/models/note.dart';
9+
import 'data/note_repository.dart';
510

611
void main() {
712
runApp(MyApp());
@@ -17,7 +22,43 @@ class MyApp extends StatelessWidget {
1722
primarySwatch: Colors.blue,
1823
visualDensity: VisualDensity.adaptivePlatformDensity,
1924
),
20-
home: SliverAppBarListViewPage(),
25+
home: ListViewPage(),
26+
);
27+
}
28+
}
29+
30+
class ListViewPage extends StatefulWidget {
31+
static const ROUTE_NAME = 'ListViewPage';
32+
@override
33+
_ListViewPageState createState() => _ListViewPageState();
34+
}
35+
36+
class _ListViewPageState extends State<ListViewPage> {
37+
static const TAG = 'ListViewPage';
38+
final GlobalKey key = GlobalKey();
39+
ListViewDataSource dataSource;
40+
@override
41+
void initState() {
42+
super.initState();
43+
dataSource = ListViewDataSource(NoteRepository());
44+
}
45+
@override
46+
Widget build(BuildContext context) {
47+
developer.log('build', name: 'ListViewPage');
48+
return Scaffold(
49+
appBar: AppBar(
50+
centerTitle: true,
51+
title: Text('Demo ListView'),
52+
),
53+
body: paging.ListView<Note>(
54+
key: key,
55+
padding: EdgeInsets.all(16),
56+
itemBuilder: (context, data, child) {
57+
return NoteWidget(data);
58+
},
59+
pageDataSource: dataSource,
60+
),
2161
);
2262
}
2363
}
64+

‎example/lib/pages/list_view_page.dart

-43
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,8 @@
1-
import 'dart:developer' as developer;
21
import 'package:example/data/models/note.dart';
32
import 'package:example/data/note_repository.dart';
4-
import 'package:example/widgets/note_widget.dart';
5-
import 'package:flutter/material.dart';
63
import 'package:paging/paging.dart' as paging;
74
import 'package:tuple/tuple.dart';
85

9-
import 'dart:developer' as developer;
10-
import 'package:flutter/material.dart';
11-
12-
class ListViewPage extends StatefulWidget {
13-
static const ROUTE_NAME = 'ListViewPage';
14-
@override
15-
_ListViewPageState createState() => _ListViewPageState();
16-
}
17-
18-
class _ListViewPageState extends State<ListViewPage> {
19-
static const TAG = 'ListViewPage';
20-
final GlobalKey key = GlobalKey();
21-
ListViewDataSource dataSource;
22-
@override
23-
void initState() {
24-
// TODO: implement initState
25-
super.initState();
26-
dataSource = ListViewDataSource(NoteRepository());
27-
}
28-
@override
29-
Widget build(BuildContext context) {
30-
developer.log('build', name: 'ListViewPage');
31-
return Scaffold(
32-
appBar: AppBar(
33-
centerTitle: true,
34-
title: Text('Demo ListView'),
35-
),
36-
body: paging.ListView<Note>(
37-
key: key,
38-
padding: EdgeInsets.all(16),
39-
itemBuilder: (context, data, child) {
40-
return NoteWidget(data);
41-
},
42-
pageDataSource: dataSource,
43-
),
44-
);
45-
}
46-
}
47-
48-
496
class ListViewDataSource extends paging.PageKeyedDataSource<int, Note> {
507
NoteRepository noteRepository;
518
ListViewDataSource(this.noteRepository) {

‎example/pubspec.yaml

+3-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@ dependencies:
2929
# Use with the CupertinoIcons class for iOS style icons.
3030
cupertino_icons: ^0.1.3
3131
paging:
32-
path: ../../paging
32+
git:
33+
url: https://github.com/dangngocduc/flutter_paging.git
34+
ref: master
3335
tuple:
3436

3537
dev_dependencies:

‎lib/paging.dart ‎lib/fl_paging.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
library paging;
1+
library fl_paging;
22
export 'src/widgets/list_view.dart';
33
export 'src/widgets/grid_view.dart';
44
export 'src/datasource/page_keyed_data_source.dart';

‎lib/src/datasource/page_keyed_data_source.dart

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
import 'dart:developer' as developer;
22

3-
import 'package:paging/src/datasource/data_source.dart';
43
import 'package:tuple/tuple.dart';
4+
5+
import 'data_source.dart';
56
/// Key is page index, Value is type Data
67
abstract class PageKeyedDataSource<Key, Value> extends DataSource<Value> {
78
static const TAG = 'PageKeyedDataSource';

‎lib/src/widgets/base_widget.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import 'package:flutter/material.dart';
2-
import 'package:paging/src/datasource/data_source.dart';
2+
import 'package:fl_paging/src/datasource/data_source.dart';
33

44
import 'builder.dart';
55

‎lib/src/widgets/grid_view.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import 'dart:developer' as developer;
22
import 'package:flutter/material.dart';
33
import 'package:flutter/widgets.dart' as widgets;
4-
import 'package:paging/src/datasource/data_source.dart';
4+
import 'package:fl_paging/src/datasource/data_source.dart';
55

66
import 'base_widget.dart';
77
import 'default/load_more_widget.dart';

‎lib/src/widgets/list_view.dart

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
import 'dart:developer' as developer;
22
import 'package:flutter/gestures.dart';
33
import 'package:flutter/material.dart';
4-
import 'package:paging/src/datasource/data_source.dart';
5-
import 'package:paging/src/widgets/base_widget.dart';
6-
import 'package:paging/src/widgets/default/paging_default_loading.dart';
7-
import 'package:paging/src/widgets/paging_state.dart';
4+
import 'package:fl_paging/src/datasource/data_source.dart';
5+
import 'package:fl_paging/src/widgets/base_widget.dart';
6+
import 'package:fl_paging/src/widgets/default/paging_default_loading.dart';
7+
import 'package:fl_paging/src/widgets/paging_state.dart';
88
import 'package:flutter/widgets.dart' as widgets;
99
import 'default/load_more_widget.dart';
1010

‎pubspec.yaml

+9-46
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
name: paging
1+
name: fl_paging
22
description: A new Flutter package for paging
3-
version: 0.0.1
4-
author:
5-
homepage:
3+
version: 1.0.1
4+
homepage: https://github.com/dangngocduc/flutter_paging
5+
repository: https://github.com/dangngocduc/flutter_paging
6+
issue_tracker: https://github.com/dangngocduc/flutter_paging/issues
7+
documentation: https://github.com/dangngocduc/flutter_paging
68

79
environment:
810
sdk: ">=2.7.0 <3.0.0"
@@ -11,51 +13,12 @@ environment:
1113
dependencies:
1214
flutter:
1315
sdk: flutter
14-
freezed_annotation: 0.11.0+1
16+
freezed_annotation: ^0.11.0+1
1517
tuple: ^1.0.3
1618

1719
dev_dependencies:
1820
flutter_test:
1921
sdk: flutter
20-
build_runner: 1.10.0
21-
freezed: 0.11.6
22-
23-
dependency_overrides:
24-
analyzer: '0.39.14'
25-
26-
# For information on the generic Dart part of this file, see the
27-
# following page: https://dart.dev/tools/pub/pubspec
28-
29-
# The following section is specific to Flutter.
22+
build_runner: ^1.10.0
23+
freezed: ^0.11.6
3024
flutter:
31-
32-
# To add assets to your package, add an assets section, like this:
33-
# assets:
34-
# - images/a_dot_burr.jpeg
35-
# - images/a_dot_ham.jpeg
36-
#
37-
# For details regarding assets in packages, see
38-
# https://flutter.dev/assets-and-images/#from-packages
39-
#
40-
# An image asset can refer to one or more resolution-specific "variants", see
41-
# https://flutter.dev/assets-and-images/#resolution-aware.
42-
43-
# To add custom fonts to your package, add a fonts section here,
44-
# in this "flutter" section. Each entry in this list should have a
45-
# "family" key with the font family name, and a "fonts" key with a
46-
# list giving the asset and other descriptors for the font. For
47-
# example:
48-
# fonts:
49-
# - family: Schyler
50-
# fonts:
51-
# - asset: fonts/Schyler-Regular.ttf
52-
# - asset: fonts/Schyler-Italic.ttf
53-
# style: italic
54-
# - family: Trajan Pro
55-
# fonts:
56-
# - asset: fonts/TrajanPro.ttf
57-
# - asset: fonts/TrajanPro_Bold.ttf
58-
# weight: 700
59-
#
60-
# For details regarding fonts in packages, see
61-
# https://flutter.dev/custom-fonts/#from-packages

‎test/paging_test.dart

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import 'package:flutter_test/flutter_test.dart';
22

3-
import 'package:paging/paging.dart';
3+
import 'package:fl_paging/fl_paging.dart';
44

55
void main() {
66
test('adds one to input values', () {

0 commit comments

Comments
 (0)