Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clickup/clickup_fading_scroll
Add a fading effect when the user can scroll.
https://github.com/clickup/clickup_fading_scroll
clickup flutter listview scrolling
Last synced: 1 day ago
JSON representation
Add a fading effect when the user can scroll.
- Host: GitHub
- URL: https://github.com/clickup/clickup_fading_scroll
- Owner: clickup
- License: other
- Created: 2022-05-24T07:23:39.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-10T12:07:13.000Z (over 1 year ago)
- Last Synced: 2024-06-18T13:47:59.663Z (5 months ago)
- Topics: clickup, flutter, listview, scrolling
- Language: Dart
- Homepage:
- Size: 7.13 MB
- Stars: 27
- Watchers: 6
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Add a fading effect when the user can scroll.
## Quickstart
Add the dependency to `fading_scroll` to your `pubspec.yaml` file.
```bash
flutter pub add clickup_fading_scroll
```
Wrap your scrollable content in a `FadingScroll` widget and give the provided `ScrollController` to your scrollable widget.
```dart
@override
Widget build(BuildContext context) {
return FadingScroll(
builder: (context, controller) {
return ListView(
controller: controller,
children: [
// ...
],
),
},
);
}
```
## Usage
### Customize fading size and scroll threshold
You can customise the effect by providing custom scroll extents and fading sizes.
```dart
@override
Widget build(BuildContext context) {
return FadingScroll(
fadingSize: 100,
scrollExtent: 120,
builder: (context, controller) {
return ListView(
controller: controller,
children: [
// ...
],
),
},
);
}
```
### Using a different controller
You can also provide your own `ScrollController` to the `FadingScroll`. This may be useful for controller subclasses like the `PageController`.
```dart
class _State_ extends State {
late final pageController = PageController();
@override
void dispose() {
pageController.dispose();
super.dispose();
}
@override
Widget build(BuildContext context) {
return FadingScroll(
controller: pageController,
builder: (context, controller) {
return PageView(
controller: pageController,
children: [
// ...
],
);
},
);
}
}
```
## About
This package has been developped by the ClickUp mobile team for it is own needs, but feel free to participate by filing issues or submit pull-requests.
## Open Sourced by ClickUp 💙
> Saving people time by making the world more productive.
We're looking for experienced developers.
Be Part of Something Great and [Join Us](https://clickup.com/careers)!