Snapping sheet

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

Using only placeholders 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

NameDescription
childThe widget behind the sheet.
sheetBelowThe widget that is the remaining space between the bottom to the bottom of the grabbing widget.
sheetAboveThe widget that is the remaining space between the top to the top of the grabbing widget
grabbingThe widget fixed between the sheetBelow and sheetAbove.
grabbingHeightThe height of the grabbing widget.
sheetBelowMarginThe margin for the sheetBelow widget. Can be negative values.
sheetAboveMarginThe margin for the sheetAbove widget. Can be negative values.
snapPositionsThe different snap positions for the sheet
initSnapPositionThe init snap position, do not need to exist in the napPositions list
snappingSheetControllerControl the sheet and get current snap position
onMoveCallback when the sheet is moving.
onSnapBeginCallback when a snap begins, happens when the user stops dragging the sheet.
onSnapEndCallback when a snap is completed.

Libraries

snapping_sheet