ScrollBuilder constructor

const ScrollBuilder({
  1. Key? key,
  2. Future<void> onRefresh()?,
  3. ScrollController? controller,
  4. bool showScrollbarWhenDesktopOrWeb = true,
  5. required Widget builder(
    1. BuildContext context,
    2. ScrollController controller
    ),
})

This widget can be placed on top of a ListView or SingleChildScrollView to easily add a RefreshIndicator or Scrollbar.

If showScrollbarWhenDesktopOrWeb is true, a mouse scrollable scrollbar will be displayed only on PC or Web.

If onRefresh is not null, a RefreshIndicator will be placed and Pull to Refresh will be enabled.

Please pass a ListView or SingleChildScrollView to builder.

An internal ScrollController is created and passed to builder. If you want to specify your own ScrollController, pass it to controller.

ListViewやSingleChildScrollViewの上に配置することで、RefreshIndicatorやScrollbarを簡単に追加できるようにするためのウィジェットです。

showScrollbarWhenDesktopOrWebをtrueにすると、PCやWebでのみマウスでドラッグ可能なスクロールバーを表示します。

onRefreshがnullでない場合、RefreshIndicatorを配置し、Pull to Refreshを有効にします。

builderでListViewやSingleChildScrollViewを渡してください。

内部でScrollControllerが作られ、それがbuilderに渡されます。自身でScrollControllerを指定したい場合はcontrollerに渡してください。

Implementation

const ScrollBuilder({
  super.key,
  this.onRefresh,
  this.controller,
  this.showScrollbarWhenDesktopOrWeb = true,
  required this.builder,
});