Draggable Home

A draggable Flutter widget that makes implementing a Sliding up and fully-stretchable much easier! Based on the Scaffold and Sliver.


Example Example Example


Usage

Make sure to check out examples for more details.

Installation

Add the following line to pubspec.yaml:

dependencies:
  draggable_home: ^1.0.2

Basic setup

The complete example is available here.

DraggableHome requires you to provide title, headerWidget and body:

  • title widget is basically for a title in the AppBar. For no title in AppBar, simply pass an empty Container.
  • headerWidget is the expanded widget just above the body when not fully expanded.
  • body is in the form of Column which requires a list of widget or a widget. Do not add any vertically scrollable widget or you may just disable the scroll.
  physics: const NeverScrollableScrollPhysics()

Sample code

DraggableHome(
  title: Text("Title"),
  headerWidget: headerWidget(),
  body: [
    Container(...),
    (...),
  ]
);

Arguments

There are several options that allow for more control:

PropertiesDescription
leadingA widget to display before the toolbar's title.
actionA list of Widgets to display in a row after the title widget.
drawerDrawers are typically used with the Scaffold.drawer property.
centerTitleAllows toggling of title from the center. By default, title is in the center.
headerExpandedHeightHeight of the header widget. The height is a double between 0.0 and 1.0. The default value of height is 0.35 and should be less than stretchMaxHeight
headerWidgetA widget to display Header above the body.
alwaysShowLeadingAndActionThis makes Leading and Action always visible. Default value is false.
headerBottomBarAppBar or toolBar like widget just above the body.
backgroundColorThe color of the Material widget that underlies the entire DraggableHome body.
curvedBodyRadiusCreates a border top-left and top-right radius of body, Default radius of the body is 20.0. For no radius simply set the value to 0.
fullyStretchableAllows toggling of fully expand draggability of the DraggableHome. Set this to true to allow the user to fully expand the header.
stretchTriggerOffsetThe offset of overscroll required to fully expand the header.
expandedBodyA widget to display when fully expanded as header or expandedBody above the body.
stretchMaxHeightHeight of the expandedBody widget. The height is a double between 0.0 and 0.95. The default value of height is 0.9 and should be greater than headerExpandedHeight
bottomSheetA persistent bottom sheet shows information that supplements the primary content of the app. A persistent bottom sheet remains visible even when the user interacts with other parts of the app.
bottomNavigationBarHeightThis is required when using custom height to adjust body height. This makes no effect on bottomNavigationBar.
bottomNavigationBarSnack bars slide from underneath the bottom navigation bar while bottom sheets are stacked on top.
floatingActionButtonA floating action button is a circular icon button that hovers over content to promote a primary action in the application.
floatingActionButtonLocationAn object that defines a position for the FloatingActionButton based on the Scaffold's ScaffoldPrelayoutGeometry.
floatingActionButtonAnimatorProvider of animations to move the FloatingActionButton between FloatingActionButtonLocations.


Sample code for ListView.builder

DraggableHome(
  title: Text("Title"),
  headerWidget: headerWidget(),
  body: [
    Container(...),

    // shrinkWrap true required for ListView.builder()
    // disable the scroll for any vertically scrollable widget
    // provide top padding 0 to fix extra space in listView
    ListView.builder(
      padding: EdgeInsets.only(top: 0),
      physics: NeverScrollableScrollPhysics(),
      shrinkWrap: true,
      itemCount: list.length,
      itemBuilder: (context, index) => Card(
        child: ListTile(
          title: Text("$index"),
        ),
      ),
    ),

    (...),
  ]
);


Example Example Example


Show some :heart: and :star: the repo

GitHub followers GitHub followers

Contributions

Contributions are welcome!

If you feel that a hook is missing, feel free to open a Pull Request.

For a custom hook to be merged, you will need to do the following:

  • Describe the use case.

  • Open an issue explaining why we need this hook, how to use it, ... This is important as a hook will not get merged if the hook doesn't appeal to a large number of people.

  • If your hook is rejected, don't worry! A rejection doesn't mean that it won't be merged later in the future if more people show an interest in it. In the meantime, feel free to publish your hook as a package on https://pub.dev.

  • A hook will not be merged unless fully tested, to avoid breaking it inadvertently in the future.

Libraries

draggable_home