snapping_sheet 2.0.0

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

Snapping sheet

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

Using a ListView in sheetBelow	Example using only placeholders	Using a ListView in sheetAbove

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: SnappingSheetContent(
                        child: Container(
                            color: Colors.red,
                        ),
                        heightBehavior: SnappingSheetHeight.fit()),
                    ),
                    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)
            ),
        ],
    )

Sheet content

SnappingSheetContent	Description
child	The widget inside the sheet.
margin	The margin for the sheet, can be negative
draggable	If the sheet should listen for drag events.
heightBehavior	How the sheet height should behave when the size is changing

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.
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.
lockOverflowDrag	Prevents the grabbing sheet to be dragged above the highest snapPosition or below the lowest snapPosition.