Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/monster555/flutter_elastic_list_view

A Flutter package providing elastic scrolling effect in ListView.builder with enhanced functionality and customization.
https://github.com/monster555/flutter_elastic_list_view

flutter flutter-animations flutter-ui ui

Last synced: 5 days ago
JSON representation

A Flutter package providing elastic scrolling effect in ListView.builder with enhanced functionality and customization.

Awesome Lists containing this project

README

        

# ElasticListView

## Description

`ElasticListView` is a drop-in replacement for Flutter’s `ListView`, enhancing the user experience by dynamically calculating each item’s padding based on the scroll speed, creating an elastic effect. It supports the `builder` and `separated` constructors as well as the standard `ListView` constructor. To migrate to `ElasticListView`, simply add the Elastic prefix to any existing `ListView` widget.

![ElasticListView Demo](https://github.com/monster555/flutter_elastic_list_view/assets/32662133/c6a0e533-2641-4f7a-b313-ab427aba3f5e)

## Features

- **Features Elastic Effect**: `ElasticListView` provides an elastic effect to each item by dynamically calculating the padding based on the scroll speed, which is different from the traditional overscroll effect. This makes the list appear as if it’s made of rubber.
- **Drag to Scroll**: Adds the drag to scroll behavior by default, providing a smooth scrolling experience. This can be disabled by setting the `enableDragScrolling` property to false.
- **Optimized Performance**: Leverages the performance optimizations of the standard `ListView`, ensuring excellent performance.

## Extended Functionality with Full Compatibility

`ElasticListView` maintains the exact same properties as the standard `ListView`, ensuring full compatibility and making it a seamless replacement. In addition, it introduces new properties to control the elastic effect, offering enhanced functionality and customization options beyond the standard `ListView`.

## New Properties

Here are the new properties introduced by `ElasticListView`:

- `curve`: The curve to apply when animating the elastic effect. Defaults to `Curves.easeOut`.
- `animationDuration`: The duration of the elastic effect. Defaults to `Duration(milliseconds: 200)`.
- `enableDragScrolling`: Whether to enable drag scrolling. Defaults to `true`.
- `elasticityFactor`: The factor by which the scroll view’s padding changes dynamically based on the scroll speed. Defaults to `4`.

Each of these properties allows you to customize the behavior of the elastic effect in `ElasticListView`.

## Usage

To use `ElasticListView`, simply replace your existing `ListView` with `ElasticListView`. All the properties are the same, ensuring full compatibility.

For `ListView`:

```dart
ElasticListView(
children: [
ListTile(
leading: Icon(Icons.map),
title: Text('Map'),
),
ListTile(
leading: Icon(Icons.photo_album),
title: Text('Album'),
),
ListTile(
leading: Icon(Icons.phone),
title: Text('Phone'),
),
],
)
```

For `ListView.builder`:

```dart
ElasticListView.builder(
itemCount: 10,
itemBuilder: (context, index) {
return ListTile(
title: Text('Item $index'),
);
},
)
```

And for `ListView.separated`:

```dart
ElasticListView.separated(
itemCount: 10,
separatorBuilder: (BuildContext context, int index) => Divider(),
itemBuilder: (BuildContext context, int index) {
return ListTile(
title: Text('Item $index'),
);
},
)
```
## Contribution
Contributions are welcome! If you encounter any issues or have suggestions for improvements, please feel free to create a pull request.