Scroll Wheel Date Picker #

Have you been in a situation where you want to use CupertinoDatePicker but sadly you can't achieve a flat scroll view just like in android TikTok? Or maybe, you also resorted using ListWheelScrollView yet still the same?

Good news!

This package supports a wheel-type date-picker that has two scroll types: CurveScrollWheel and FlatScrollWheel.

Features #

ScrollWheelDatePicker uses ListWheelScrollView for the CurveScrollWheel underneath. However, some features were added and modified in order to have the same functionality but without the curve perspective in FlatScrollWheel.

Centered Selected Item

Just like using CupertinoDatePicker or ListWheelScrollView, it allows you to select a date and expects that a particular item will always land on the center of the viewport.

Choose Center Overlay

You can choose what type of overlay you want to have on the current selected item. holo, highlight, and line are some of the overlays to choose for. If you don't want any overlays you can just set it to none. (Expect additional overlays or the option to add your own soon..)

Month Format

It allows you to select what type of month format you want to display. The available formats are full which simply means the complete name of the month, threeLetters and twoLetters basically formats the months based on their common abbreviations with the letter count.

Locale

Pass a locale to the theme to translate month names via intl instead of the default English names:

CurveDatePickerTheme(
  monthFormat: MonthFormat.full,
  locale: const Locale('es'), // enero, febrero, marzo...
)

locale defaults to null (English). For any other locale, your app must call initializeDateFormatting() (from package:intl/date_symbol_data_local.dart) for that locale before building the picker, otherwise intl throws. Note that MonthFormat.twoLetters combined with a locale takes the first two characters of the localized abbreviation and may collide between different months in some languages — use threeLetters for guaranteed uniqueness.

Faded Vertical Edges

It adds fade on top and bottom to create a smooth disappearance effect when the items are beyond the viewport. Defaults to true for CurveDatePickerTheme, and false for FlatDatePickerTheme (so the flat picker has no edge fade out of the box). Pass fadeEdges: true and lower overAndUnderCenterOpacity (which defaults to 1.0 on the flat theme) to opt into the softened, curve-like look on a flat picker.

Listen On Item Changes After Animation Completed

Unlike CupertinoDatePicker, it gives you an option whether to listen to item changes only after the scroll animation ended/completed. listenAfterChanges defaults to true, otherwise, change to false to have the default functionality.

Infinite Loop

Supports looping on items. You can choose whether to enable looping on days, months or years individually.

Demo #

Flat Scroll Wheel #

Curve Scroll Wheel #

Usage #

Add the package to pubspec.yaml

$ flutter pub add scroll_wheel_date_picker

or

dependencies:
  scroll_wheel_date_picker: ^0.1.1 # x-release-please-version

Then import the package.

import 'package:scroll_wheel_date_picker/scroll_wheel_date_picker.dart';

And use like this...

ScrollWheelDatePicker(
  theme: FlatDatePickerTheme(
    backgroundColor: Colors.white,
    overlay: ScrollWheelDatePickerOverlay.holo,
    itemTextStyle: defaultItemTextStyle.copyWith(color: Colors.black),
    overlayColor: Colors.black,
  ),
),

FlatDatePickerTheme renders fully flat by default: no edge fade, off-center items at full opacity. To opt into the softened, curve-like dimming instead:

ScrollWheelDatePicker(
  theme: FlatDatePickerTheme(
    backgroundColor: Colors.white,
    fadeEdges: true,
    overAndUnderCenterOpacity: 0.2,
  ),
),

Development #

This project uses FVM to ensure all contributors use the same Flutter version. Install FVM, then run:

fvm install
fvm flutter pub get

Run tests and lints before committing:

fvm flutter analyze
fvm flutter test

Contributors #

Ghian Tan @ Fingertips (Github)