Java Material design android-library Android picker
Need help with MaterialDateTimePicker?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.
wdullaer

Description

Pick a date or time on Android in style

4.5K Stars 953 Forks Apache License 2.0 473 Commits 93 Opened issues

Services available

Need anything else?

Material DateTime Picker - Select a time/date in style

Join the chat at https://gitter.im/wdullaer/MaterialDateTimePicker Maven Central Build Status

Material DateTime Picker tries to offer you the date and time pickers as shown in the Material Design spec, with an easy themable API. The library uses the code from the Android frameworks as a base and tweaked it to be as close as possible to Material Design example.

Support for Android 4.1 and up. (Android 4.0 was supported until 3.6.4)

Feel free to fork or issue pull requests on github. Issues can be reported on the github issue tracker.

Version 2 Layout

Date Picker

Time Picker
Date Picker Time Picker

Version 1 Layout

Date Picker

Time Picker
Date Picker Time Picker

Table of Contents

  1. Setup
  2. Using Material Date/Time Pickers
  3. Implement Listeners
  4. Create Pickers
  5. Theme the Pickers
  6. Additional Options
  7. FAQ
  8. Potential Improvements
  9. License

Setup

The easiest way to add the Material DateTime Picker library to your project is by adding it as a dependency to your

build.gradle
groovy
dependencies {
    implementation 'com.wdullaer:materialdatetimepicker:4.2.3'
}

You may also add the library as an Android Library to your project. All the library files live in

library
.

The library also uses some Java 8 features, which Android Studio will need to transpile. This requires the following stanza in your app's

build.gradle
. See https://developer.android.com/studio/write/java8-support.html for more information on Java 8 support in Android.
groovy
android {
  ...
  // Configure only for each module that uses Java 8
  // language features (either in its source code or
  // through dependencies).
  compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
  }
}

Using Material Date/Time Pickers

The library follows the same API as other pickers in the Android framework. For a basic implementation, you'll need to

  1. Implement an
    OnTimeSetListener
    /
    OnDateSetListener
  2. Create a
    TimePickerDialog
    /
    DatePickerDialog
    using the supplied factory
  3. Theme the pickers

Implement an
OnTimeSetListener
/
OnDateSetListener

In order to receive the date or time set in the picker, you will need to implement the

OnTimeSetListener
or
OnDateSetListener
interfaces. Typically this will be the
Activity
or
Fragment
that creates the Pickers. The callbacks use the same API as the standard Android pickers. ```java @Override public void onTimeSet(RadialPickerLayout view, int hourOfDay, int minute, int second) { String time = "You picked the following time: "+hourOfDay+"h"+minute+"m"+second; timeTextView.setText(time); }

@Override public void onDateSet(DatePickerDialog view, int year, int monthOfYear, int dayOfMonth) { String date = "You picked the following date: "+dayOfMonth+"/"+(monthOfYear+1)+"/"+year; dateTextView.setText(date); } ```

Create a
TimePickerDialog
/
DatePickerDialog
using the supplied factory

You will need to create a new instance of

TimePickerDialog
or
DatePickerDialog
using the static
newInstance()
method, supplying proper default values and a callback. Once the dialogs are configured, you can call
show()
.
java
Calendar now = Calendar.getInstance();
DatePickerDialog dpd = DatePickerDialog.newInstance(
  MainActivity.this,
  now.get(Calendar.YEAR), // Initial year selection
  now.get(Calendar.MONTH), // Initial month selection
  now.get(Calendar.DAY_OF_MONTH) // Inital day selection
);
// If you're calling this from a support Fragment
dpd.show(getFragmentManager(), "Datepickerdialog");
// If you're calling this from an AppCompatActivity
// dpd.show(getSupportFragmentManager(), "Datepickerdialog");

Theme the pickers

The library contains 2 layout versions for each picker.

  • Version 1: this is the original layout. It is based on the layout google used in the kitkat and early material design era
  • Version 2: this layout is based on the guidelines google posted when launching android marshmallow. This is the default and still the most current design.

You can set the layout version using the factory

java
dpd.setVersion(DatePickerDialog.Version.VERSION_2);

The pickers will be themed automatically based on the current theme where they are created, based on the current

colorAccent
. You can also theme the dialogs via the
setAccentColor(int color)
method. Alternatively, you can theme the pickers by overwriting the color resources
mdtp_accent_color
and
mdtp_accent_color_dark
in your project.
xml
#009688
#00796b

The exact order in which colors are selected is as follows:

  1. setAccentColor(int color)
    in java code
  2. android.R.attr.colorAccent
    (if android 5.0+)
  3. R.attr.colorAccent
    (eg. when using AppCompat)
  4. R.color.mdtp_accent_color
    and
    R.color.mdtp_accent_color_dark
    if none of the others are set in your project

The pickers also have a dark theme. This can be specified globablly using the

mdtp_theme_dark
attribute in your theme or the
setThemeDark(boolean themeDark)
functions. The function calls overwrite the XML setting.
xml
true

Additional Options

[All]
setThemeDark(boolean themeDark)

The dialogs have a dark theme that can be set by calling

java
dialog.setThemeDark(true);

[All]
setAccentColor(String color)
and
setAccentColor(int color)

Set the accentColor to be used by the Dialog. The String version parses the color out using

Color.parseColor()
. The int version requires a ColorInt bytestring. It will explicitly set the color to fully opaque.

[All]
setOkColor()
and
setCancelColor()

Set the text color for the OK or Cancel button. Behaves similar to

setAccentColor()

[TimePickerDialog]
setTitle(String title)

Shows a title at the top of the

TimePickerDialog

[DatePickerDialog]
setTitle(String title)

Shows a title at the top of the

DatePickerDialog
instead of the day of the week

[All]
setOkText()
and
setCancelText()

Set a custom text for the dialog Ok and Cancel labels. Can take a resourceId of a String. Works in both the DatePickerDialog and TimePickerDialog

[DatePickerDialog]
setMinDate(Calendar day)

Set the minimum valid date to be selected. Date values before this date will be deactivated

[DatePickerDialog]
setMaxDate(Calendar day)

Set the maximum valid date to be selected. Date values after this date will be deactivated

[TimePickerDialog]
setMinTime(Timepoint time)

Set the minimum valid time to be selected. Time values earlier in the day will be deactivated

[TimePickerDialog]
setMaxTime(Timepoint time)

Set the maximum valid time to be selected. Time values later in the day will be deactivated

[TimePickerDialog]
setSelectableTimes(Timepoint[] times)

You can pass in an array of

Timepoints
. These values are the only valid selections in the picker.
setMinTime(Timepoint time)
,
setMaxTime(Timepoint time)
and
setDisabledTimes(Timepoint[] times)
will further trim this list down. Try to specify Timepoints only up to the resolution of your picker (i.e. do not add seconds if the resolution of the picker is minutes).

[TimePickerDialog]
setDisabledTimes(Timepoint[] times)

You can pass in an array of

Timepoints
. These values will not be available for selection. These take precedence over
setSelectableTimes
and
setTimeInterval
. Be careful when using this without selectableTimes: rounding to a valid Timepoint is a very expensive operation if a lot of consecutive Timepoints are disabled. Try to specify Timepoints only up to the resolution of your picker (i.e. do not add seconds if the resolution of the picker is minutes).

[TimePickerDialog]
setTimeInterval(int hourInterval, int minuteInterval, int secondInterval)

Set the interval for selectable times in the TimePickerDialog. This is a convenience wrapper around

setSelectableTimes
. The interval for all three time components can be set independently. If you are not using the seconds / minutes picker, set the respective item to 60 for better performance.

[TimePickerDialog]
setTimepointLimiter(TimepointLimiter limiter)

Pass in a custom implementation of

TimeLimiter
Disables
setSelectableTimes
,
setDisabledTimes
,
setTimeInterval
,
setMinTime
and
setMaxTime

[DatePickerDialog]
setSelectableDays(Calendar[] days)

You can pass a

Calendar[]
to the
DatePickerDialog
. The values in this list are the only acceptable dates for the picker. It takes precedence over
setMinDate(Calendar day)
and
setMaxDate(Calendar day)

[DatePickerDialog]
setDisabledDays(Calendar[] days)

The values in this

Calendar[]
are explicitly disabled (not selectable). This option can be used together with
setSelectableDays(Calendar[] days)
: in case there is a clash
setDisabledDays(Calendar[] days)
will take precedence over
setSelectableDays(Calendar[] days)

[DatePickerDialog]
setHighlightedDays(Calendar[] days)

You can pass a

Calendar[]
of days to highlight. They will be rendered in bold. You can tweak the color of the highlighted days by overwriting
mdtp_date_picker_text_highlighted

[DatePickerDialog]
showYearPickerFirst(boolean yearPicker)

Show the year picker first, rather than the month and day picker.

[All]
OnDismissListener
and
OnCancelListener

Both pickers can be passed a

DialogInterface.OnDismissLisener
or
DialogInterface.OnCancelListener
which allows you to run code when either of these events occur.
java
tpd.setOnCancelListener(new DialogInterface.OnCancelListener() {
    @Override
    public void onCancel(DialogInterface dialogInterface) {
      Log.d("TimePicker", "Dialog was cancelled");
    }
});

[All]
vibrate(boolean vibrate)

Set whether the dialogs should vibrate the device when a selection is made. This defaults to

true
.

[All]
dismissOnPause(boolean dismissOnPause)

Set whether the picker dismisses itself when the parent Activity is paused or whether it recreates itself when the Activity is resumed.

[All]
setLocale(Locale locale)

Allows the client to set a custom locale that will be used when generating various strings in the pickers. By default the current locale of the device will be used. Because the pickers will adapt to the Locale of the device by default you should only have to use this in very rare circumstances.

[DatePickerDialog]
autoDismiss(boolean autoDismiss)

If set to

true
will dismiss the picker when the user selects a date. This defaults to
false
.

[TimepickerDialog]
enableSeconds(boolean enableSconds)
and
enableMinutes(boolean enableMinutes)

Allows you to enable or disable a seconds and minutes picker on the

TimepickerDialog
. Enabling the seconds picker, implies enabling the minutes picker. Disabling the minute picker will disable the seconds picker. The last applied setting will be used. By default
enableSeconds = false
and
enableMinutes = true
.

[DatePickerDialog]
setTimeZone(Timezone timezone)
deprecated

Sets the

Timezone
used to represent time internally in the picker. Defaults to the current default Timezone of the device. This method has been deprecated: you should use the
newInstance()
method which takes a Calendar set to the appropriate TimeZone.

[DatePickerDialog]
setDateRangeLimiter(DateRangeLimiter limiter)

Provide a custom implementation of DateRangeLimiter, giving you full control over which days are available for selection. This disables all of the other options that limit date selection.

getOnTimeSetListener()
and
getOnDateSetListener()

Getters that allow the retrieval of a reference to the callbacks currently associated with the pickers

[DatePickerDialog]
setScrollOrientation(ScrollOrientation scrollOrientation)
and
getScrollOrientationi()

Determines whether months scroll

Horizontal
or
Vertical
. Defaults to
Horizontal
for the v2 layout and
Vertical
for the v1 layout

FAQ

Why does the
DatePickerDialog
return the selected month -1?

In the java

Calendar
class months use 0 based indexing: January is month 0, December is month 11. This convention is widely used in the java world, for example the native Android DatePicker.

How do I use a different version of a support library in my app?

This library depends on some androidx support libraries. Because the jvm allows only one version of a fully namespaced class to be loaded, you will run into issues if your app depends on a different version of a library than the one used in this app. Gradle is generally quite good at resolving version conflicts (by default it will retain the latest version of a library), but should you run into problems (eg because you disabled conflict resolution), you can disable loading a specific library for MaterialDateTimePicker.

Using the following snippet in your apps

build.gradle
file you can exclude this library's transitive appcompat library dependency from being installed.
implementation ('com.wdullaer:materialdatetimepicker:4.2.3') {
        exclude group: 'androidx.appcompat'
        exclude group: 'androidx.recyclerview'
}

MaterialDateTimepicker uses the following androidx libraries:

implementation 'androidx.appcompat:appcompat:1.0.2'
implementation 'androidx.recyclerview:recyclerview:1.0.0'

Excluding a dependency will work fine as long as the version your app depends on is recent enough and google doesn't release a version in the future that contains breaking changes. (If/When this happens I will try hard to document this). See issue #338 for more information.

How do I turn this into a year and month picker?

This DatePickerDialog focuses on selecting dates, which means that it's central design element is the day picker. As this calendar like view is the center of the design it makes no sense to try and disable it. As such selecting just years and months, without a day, is not in scope for this library and will not be added.

How do I select multiple days?

The goal of this library is to implement the Material Design Date picker. This design is focused on picking exactly 1 date (with a large textual representation at the top). It would require quite a bit of redesigning to make it useful to select multiple days. As such this feature is currently out of scope for this library and will not be added. If you happen to make a library that implements this, based on this code or not, drop me a line and I'll happily link to it.

How do I use my custom logic to enable/disable dates?

DatePickerDialog
exposes some utility methods to enable / disable dates for common scenario's. If your needs are not covered by these, you can supply a custom implementation of the
DateRangeLimiter
interface. Because the
DateRangeLimiter
is preserved when the
Dialog
pauzes, your implementation must also implement
Parcelable
.
class MyDateRangeLimiter implements DateRangeLimiter {
  public MyDateRangeLimiter(Parcel in) {

}

@Override public int getMinYear() { return 1900; }

@Override public int getMaxYear() { return 2100; }

@Override public Calendar getStartDate() { Calendar output = Calendar.newInstance(); output.set(Calendar.YEAR, 1900); output.set(Calendar.DAY_OF_MONTH, 1); output.set(Calendar.MONTH, Calendar.JANUARY); return output; }

@Override public Calendar getEndDate() { Calendar output = Calendar.newInstance(); output.set(Calendar.YEAR, 2100); output.set(Calendar.DAY_OF_MONTH, 1); output.set(Calendar.MONTH, Calendar.JANUARY); return output; }

@Override public boolean isOutOfRange(int year, int month, int day) { return false; }

@Override public Calendar setToNearestDate(Calendar day) { return day; }

@Override public void writeToParcel(Parcel out) {

}

@Override public int describeContents() { return 0; }

public static final Parcelable.Creator CREATOR = new Parcelable.Creator() { public MyDateRangeLimiter createFromParcel(Parcel in) { return new MyDateRangeLimiter(in); }

public MyDateRangeLimiter[] newArray(int size) {
    return new MyDateRangeLimiter[size];
}

}; }

When you provide a custom

DateRangeLimiter
the built-in methods for setting the enabled / disabled dates will no longer work. It will need to be completely handled by your implementation.

Why do the OK and Cancel buttons have the accent color as a background when combined with the Material Components library

Material Components replaces all instances of

Button
with an instance of
MaterialButton
when using one of its regular themes: https://github.com/material-components/material-components-android/blob/master/docs/getting-started.md#material-components-themes
The default version of
MaterialButton
uses
colorPrimary
as the background color. Because Material Components replaces the View replacer with their own implementation there is not much I can do to fix this from this library.

There are a few workarounds: * Use one of the bridge themes, which do not replace the View Inflater * Overwrite the style of the mdtp buttons with one that inherits from Material Components text buttons, as described here:

xml
    
* Overwrite the View inflater again in your application theme by adding the following statement in your application theme:
xml
  androidx.appcompat.app.AppCompatViewInflater
You will then need to explicitly use
MaterialButton
in your application rather than
Button

Why are my callbacks lost when the device changes orientation?

The simple solution is to dismiss the pickers when your activity is paused.

tpd.dismissOnPause(true);

If you do wish to retain the pickers when an orientation change occurs, things become a bit more tricky.

By default, when an orientation changes occurs android will destroy and recreate your entire

Activity
. Wherever possible this library will retain its state on an orientation change. The only notable exceptions are the different callbacks and listeners. These interfaces are often implemented on
Activities
or
Fragments
. Naively trying to retain them would cause memory leaks. Apart from explicitly requiring that the callback interfaces are implemented on an
Activity
, there is no safe way to properly retain the callbacks, that I'm aware off.

This means that it is your responsibility to set the listeners in your

Activity
's
onResume()
callback.
@Override
public void onResume() {
  super.onResume();

DatePickerDialog dpd = (DatePickerDialog) getFragmentManager().findFragmentByTag("Datepickerdialog"); TimePickerDialog tpd = (TimePickerDialog) getFragmentManager().findFragmentByTag("TimepickerDialog");

if(tpd != null) tpd.setOnTimeSetListener(this); if(dpd != null) dpd.setOnDateSetListener(this); }

Potential Improvements

  • Landscape timepicker can use some improvement
  • Code cleanup: there is a bit too much spit and ductape in the tweaks I've done.
  • Document all options on both pickers

License

Copyright (c) 2015 Wouter Dullaert

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.