FlutterはGoogleが開発するUIフレームワークであり、ListViewはFlutterの中でも頻繁に使用されるウィジェットの1つです。ListViewは、一定のスクロール領域内に表示されるスクロール可能なリストを作成するために使用されます。この記事では、FlutterのListViewの使い方について説明します。
ListViewとは何ですか?
ListViewは、一定のスクロール領域内に表示されるスクロール可能なリストを作成するために使用されるFlutterのウィジェットです。ListViewは、大量のデータを効率的に処理することができ、Flutterのアプリ開発で非常に重要な役割を果たしています。
ListViewの使い方
FlutterのListViewを使用するには、以下の手順を実行する必要があります。
- ListViewをインポートする
FlutterでListViewを使用するためには、まずListViewをインポートする必要があります。
import 'package:flutter/material.dart';
- ListViewを作成する
ListViewを作成するには、ListView()
コンストラクタを使用します。ListViewには、子要素として表示するウィジェットのリストを指定する必要があります。
ListView(
children: [
// ListViewの子要素
],
)
- ListViewに表示する要素を作成する
ListViewに表示する要素は、通常、ListTile
ウィジェットを使用して作成されます。ListTile
には、アイコン、タイトル、サブタイトルなどの情報を表示するための多数のプロパティがあります。
ListView(
children: [
ListTile(
leading: Icon(Icons.account_circle),
title: Text('John Doe'),
subtitle: Text('johndoe@example.com'),
),
ListTile(
leading: Icon(Icons.account_circle),
title: Text('Jane Doe'),
subtitle: Text('janedoe@example.com'),
),
],
)
- ListViewを表示する
最後に、作成したListViewを画面に表示する必要があります。これは、Scaffoldウィジェットを使用して実行できます。
import 'package:flutter/material.dart';
void main() => runApp(MyApp());
class MyApp extends StatelessWidget {
@override
Widget build(BuildContext context) {
return MaterialApp(
title: 'Flutter Navigator',
initialRoute: '/',
routes: {
'/': (context) => HomeScreen(),
},
);
}
}
class HomeScreen extends StatelessWidget {
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text('ListView Example'),
),
body: ListView(
children: [
ListTile(
leading: Icon(Icons.account_circle),
title: Text('John Doe'),
subtitle: Text('johndoe@example.com'),
),
ListTile(
leading: Icon(Icons.account_circle),
title: Text('Jane Doe'),
subtitle: Text('janedoe@example.com'),
),
],
),
);
}
}
ここから先のサンプルコードは ListView 部分のみ抜粋して記載します。
ListViewの種類
Flutterには、ListViewにさまざまな種類があります。主な種類は以下の通りです。
ListView
: 通常のスクロールリストListView.builder
: 動的にアイテムを作成する場合に使用ListView.separated
: リストアイテムを区切り文字で区切る場合に使用ListView.custom
: カスタムスクロールリストを作成する場合に使用
これらの種類は、さまざまなアプリケーションで使用されます。ここでは、それぞれの種類の使い方を簡単に説明します。
ListView.builder
ListView.builder
は、動的にリストアイテムを生成する場合に使用されます。例えば、APIから取得したデータをリストとして表示する場合に使用できます。このウィジェットは、アイテムの数が多くなる場合に効率的であり、スクロールパフォーマンスに優れています。
List<Map<String, dynamic>> items = [
{"title": "テスト1", "description": "テスト結果は80点です。"},
{"title": "テスト2", "description": "テスト結果は100点です。"},
{"title": "テスト3", "description": "テスト結果は90点です。"},
];
ListView.builder(
itemCount: items.length,
itemBuilder: (BuildContext context, int index) {
return ListTile(
title: Text(items[index]["title"]),
subtitle: Text(items[index]["description"]),
);
},
),
ListView.builder
には、itemCount
とitemBuilder
の2つのプロパティがあります。itemCount
は、リスト内のアイテム数を指定するために使用されます。itemBuilder
は、リスト内の各アイテムを構築するために使用されます。itemBuilder
は、アイテムのインデックスを受け取り、各アイテムのウィジェットを返す関数を指定する必要があります。
ListView.separated
ListView.separated
は、リストアイテムを区切り文字で区切る場合に使用されます。例えば、ユーザーの連絡先リストを表示する場合に、各アルファベットの区切りを表示することができます。
ListView.separated(
itemCount: items.length,
separatorBuilder: (BuildContext context, int index) => Divider(),
itemBuilder: (BuildContext context, int index) {
return ListTile(
title: Text(items[index].title),
subtitle: Text(items[index].description),
);
},
)
ListView.separated
には、separatorBuilder
プロパティが追加されます。このプロパティは、リストアイテムを区切るために使用されるウィジェットを返す関数を指定する必要があります。
ListView.custom
ListView.custom
は、カスタムスクロールリストを作成する場合に使用されます。例えば、Googleマップのようなスクロール可能な地図を作成する場合に使用できます。
ListView.custom(
childrenDelegate: SliverChildBuilderDelegate(
(BuildContext context, int index) {
return Container(
height: 100,
child: Text('Item $index'),
);
},
childCount: 20,
),
)
ListView.custom
には、childrenDelegate
プロパティがあります。childrenDelegate
は、SliverChildBuilderDelegate
オブジェクトを受け取ります。
SliverChildBuilderDelegate
オブジェクトは、ListView.builder
と同じように、ウィジェットを動的に生成するために使用されます。childCount
プロパティは、リスト内のアイテム数を指定するために使用されます。
ListView
ウィジェットの追加のプロパティ
以下のプロパティを使用して、ListViewのスクロール動作をカスタマイズすることができます。
scrollDirection
: スクロール方向を設定します。Axis.horizontal
またはAxis.vertical
を指定することができます。controller
: スクロール位置を制御するために使用されます。ScrollController
を指定する必要があります。physics
: スクロール動作を制御するために使用されます。AlwaysScrollableScrollPhysics
やBouncingScrollPhysics
などのScrollPhysics
オブジェクトを指定することができます。padding
: ListView内のアイテムの周囲に余白を設定するために使用されます。
ListView(
scrollDirection: Axis.horizontal,
controller: _scrollController,
physics: BouncingScrollPhysics(),
padding: EdgeInsets.all(16.0),
children: [
Text('Item 1'),
Text('Item 2'),
Text('Item 3'),
],
)
これらのプロパティを使用して、ListViewのスクロール動作をカスタマイズすることができます。
まとめ
以上が、FlutterのListViewについての基本的な使い方の紹介です。各種類のListViewについて説明し、ListViewの追加のプロパティを紹介しました。これらの情報を基に、ListViewを使って簡単なリストを作成することができます。
上記サンプルコードでも記載しているとおり、ListViewウィジットではListTileを利用します。ListTileについては、別記事でまとめていますので、よかったら見てみてください。