Search packages, repositories and app categories

snap_scroll_physics cover
Package detailsv0.0.1+3

snap_scroll_physics

Scroll physics to snap the user scroll at different offsets

AndroidiOSWebmacOSWindowsLinux
30-day downloads
9
Likes
76
Pub points
140

Install package

flutter pub add snap_scroll_physics

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

A Flutter package providing scroll physics that snap the scroll position to specific offsets, enhancing user experience in scrollable widgets. It allows precise control over scrolling behavior, making it ideal for carousel-like interfaces or grid layouts where alignment to predefined positions is required. The package supports all major platforms and integrates seamlessly with standard ScrollViews. It extends Flutter's built-in physics system, offering customizable snapping intervals and smooth transitions.

Use cases

  • Carousel sliders
  • Grid layouts with alignment
  • Form field navigation
  • Product carousels
  • Custom scroll snapping
  • Interactive tutorials

Key features

  • Snap to predefined offsets
  • Smooth transition animations
  • Cross-platform support
  • Extends default physics
  • Configurable snap intervals
  • Easy integration with ScrollViews

Suitable for

  • Developers building interactive scroll interfaces
  • Designers needing precise scroll alignment
  • Apps with carousel or tab-based navigation
  • Projects requiring custom scroll behaviors
  • Teams targeting multiple platforms

Considerations

  • May require tuning for optimal UX
  • Can conflict with other physics if not managed
  • Not ideal for continuous scroll content
  • Performance impact with many snap points
  • Limited to scrollable widgets only

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

Snap Scroll Physics

pub package

When building scrollable views, sometimes you would prefer that the scroll stopped at a given offset, or that it avoids to stop inside some area. This package allows you to implement this on any Flutter scroll view.

This kind of behaviour can be seen in any iOS app using the UIKit/SwiftUI Navigation bar, also with custom headers inside some popular apps like Twitter, Chrome, Gmail, Google Photos, Apple Music, Facebook and many more!

snap_scroll

physics: SnapScrollPhysics(
    snaps: [
        Snap(200, distance: 50), // If the scroll offset is expected to stop between 150-250 the scroll will snap to 200,
        Snap(200, leadingDistance: 50), // If the scroll offset is expected to stop  between 150-200 the scroll will snap to 200,
        Snap(200, trailingDistance: 50), // If the scroll offset is expected to stop between 150-200 the scroll will snap to 200,
        Snap(200, trailingDistance: 50), // If the scroll offset is expected to stop between 150-200 the scroll will snap to 200,
        Snap.avoidZone(0, 200), // If the scroll offset is expected to stop between 0-200, the scroll will snap to 0 if the expected one is between 0-99, and to 200 if it is between 100-200,
        Snap.avoidZone(0, 200, delimiter: 50), // If the scroll offset is expected to stop between 0-200, the scroll will snap to 0 if the expected one is between 0-49, and to 200 if it is between 50-200
    ]
),
physics: SnapScrollPhysics.cupertinoAppBar, // Default values for the Cupertino appbar

https://user-images.githubusercontent.com/19904063/116775316-b67b8f80-aa62-11eb-9ae1-58da68a381e4.mp4

https://user-images.githubusercontent.com/19904063/116775452-56391d80-aa63-11eb-95ae-f8fd8154cbc9.mp4

IMPORTANT! Sadly ScrollPhysics are not reactivily updated, so if you change the values, they won't be automatically updated. See #80051.

This can be temporaly fixed by this, while is discouraged in production if no changes are needed at runtime:


List<Snap> getSnaps() {
    return [
       Snap(200), // Hot reload works
    ];
}
@override
  Widget build(BuildContext context) {
    return CustomScrollView(
      physics: SnapScrollPhysics.builder(getSnaps),
      slivers: [
       // ....
      ],
    );
  }

Categories

Source repository

Projects using this package