Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
monster555 authored Jan 26, 2024
1 parent 823f867 commit feeb28d
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

## Description

`ElasticListView` is a drop-in replacement for Flutter's `ListView`, providing an elastic overscroll effect. It adds 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` is a drop-in replacement for Flutters `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

- **Elastic Overscroll Effect**: `ElasticListView` enhances the user experience by providing an elastic overscroll effect.
- **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.

Expand All @@ -21,9 +21,9 @@
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 overscroll bounce animation. Defaults to `Duration(milliseconds: 200)`.
- `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 overscrolls. Defaults to `4`.
- `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`.

Expand Down

0 comments on commit feeb28d

Please sign in to comment.