メインコンテンツまでスキップ

NestedScroll

NestedScrollウィジェットは、ヘッダー領域と本文領域のスクロールを1つに連動させて一緒に動かすスクロールコンテナです。
上部のヘッダーが折りたたまれたり固定されたりする間、下のリストが続けてスクロールする画面で使います。

備考

このウィジェットはFreeプランではロックされており、Pro・Enterpriseプランで使用できます。

定義・役割

NestedScrollウィジェットは、外側(outer)のスクロールと内側(inner)のスクロールを1つのジェスチャーで連結します。ヘッダースリバーとして指定した子は上部のヘッダー領域に、残りの子は本文領域に配置され、ヘッダーが折りたたまれた後に本文が続けてスクロールします。

  • カテゴリー: Layouts
  • スクロール方向: 縦(デフォルト)または横
  • ヘッダー固定(pinned)と浮かぶヘッダー(floating)の動作に対応

機能

機能説明
ヘッダー・本文のスクロール連動外側のヘッダー領域と内側の本文領域のスクロールを1つの動作として続けて処理します。
スクロール方向scrollDirectionで縦・横を指定し、reverseで進行方向を反転します。
ヘッダーを浮かせるfloatHeaderSliversをオンにすると、戻る方向にスクロールしたときにヘッダーがすぐに現れます。
スクロールイベントスクロールの開始・更新・停止・末尾到達のタイミングでアクションを実行します。
プログラムからの制御スクリプトで先頭または末尾へスクロール位置を移動します。

使い方

  1. 左のウィジェットパレットでLayoutsカテゴリーを開きます。
  2. NestedScroll項目をキャンバスにドラッグ&ドロップします。
  3. ヘッダーとして使う子と本文として使う子を中に配置します。
  4. 右のプロパティパネルでscrollDirectionreverseなどスクロールの動作を設定します。
  5. 必要に応じてonStartScrollonScrollEndなどのスクロールイベントに実行するアクションを接続します。

プロパティ

プロパティ説明デフォルト値値 / タイプ
scrollDirectionスクロール方向縦(verticalhorizontal, vertical
reverseスクロールの進行方向を反転falsetrue/false
floatHeaderSlivers戻る方向にスクロールしたときにヘッダーをすぐに表示falsetrue/false
clipBehavior内容が領域を超えたときの切り取り方式hardEdgenone, hardEdge, antiAlias, antiAliasWithSaveLayer
dragStartBehaviorドラッグによるスクロールが開始される基準startdown, start
restorationIdスクロール位置の復元用の識別子未設定文字列

注意・ヒント

ヒント

ヘッダー領域と本文領域は子の配置によって分かれます。ヘッダースリバーとして指定された子が上部のヘッダーになり、残りの子が本文として扱われます。

警告

NestedScrollの中にさらに別のNestedScrollを入れる構成はサポートされません。

さらに詳しく

ヒント

このウィジェットをスクリプトで制御するWidget Control(Property・Method・Event)の全体は、NestedScroll Widget Controlドキュメントで確認してください。