A Flutter package that makes it easy to create a sheet that snaps to different positions

Snapping sheet

A package that provides a highly customizable sheet widget that snaps to different vertical positions

Example using only placeholders Example using ListView

You can run the examples by cloning the following repository and run the app from the example folder.

Quick start

Begin by following the install instruction.

You can add the snapping sheet to you app by adding the following code

    import 'package:flutter/material.dart';
    import 'package:snapping_sheet/snapping_sheet.dart';

    class SnapSheetExample extends StatelessWidget {
        @override
        Widget build(BuildContext context) {
            return Scaffold(
            body: SnappingSheet(
                    sheetBelow: Container(
                        color: Colors.red
                    ),
                    grabbing: Container(
                        color: Colors.blue,
                    ),
                ),
            );
        }
    }

Snap positions

To change the snap positions for the sheet, change the snapPositions parameter witch takes in a list of SnapPosition.

  SnappingSheet(
        snapPositions: [
            SnapPosition(
                positionPixel: 25.0, 
                snappingCurve: Curves.elasticOut, 
                snappingDuration: Duration(milliseconds: 750)
            ),
            SnapPosition(
                positionFactor: 0.5, 
                snappingCurve: Curves.ease, 
                snappingDuration: Duration(milliseconds: 500)
            ),
        ],
    )

Other options

Name Description
child The widget behind the sheet.
sheetBelow The widget that is the remaining space between the bottom to the bottom of the grabbing widget.
sheetAbove The widget that is the remaining space between the top to the top of the grabbing widget
grabbing The widget fixed between the sheetBelow and sheetAbove.
grabbingHeight The height of the grabbing widget.
sheetBelowMargin The margin for the sheetBelow widget. Can be negative values.
sheetAboveMargin The margin for the sheetAbove widget. Can be negative values.
snapPositions The different snap positions for the sheet
initSnapPosition The init snap position, do not need to exist in the snapPositions list
snappingSheetController Control the sheet and get current snap position
onMove Callback when the sheet is moving.
onSnapBegin Callback when a snap begins, happens when the user stops dragging the sheet.
onSnapEnd Callback when a snap is completed.

Source credit Url : https://github.com/AdamJonsson/snapping_sheet