README.md

Material Calendar View

A Material design back port of Android's CalendarView. The goal is to have a Material look and feel, rather than 100% parity with the platform's implementation.

Usage

1. Add compile 'com.prolificinteractive:material-calendarview:1.4.0' to your dependencies.
2. Add MaterialCalendarView into your layouts or view hierarchy.
3. Set a OnDateSelectedListener or call MaterialCalendarView.getSelectedDates() when you need it.

Javadoc Available Here

Example:

<com.prolificinteractive.materialcalendarview.MaterialCalendarView
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:id="@+id/calendarView"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    app:mcv_showOtherDates="all"
    app:mcv_selectionColor="#00F"
    />

@Experimental

CalendarMode.WEEK and all week mode functionality is officially marked @Experimental. All APIs marked @Experimental are subject to change quickly and should not be used in production code. They are allowed for testing and feedback.

Major Change in 1.4.0

• Breaking Change: setFirstDayOfWeek, setMin/MaxDate, and setCalendarDisplayMode are moved to a State object. This was necessary because it was unclear that these were not simple setters--individually, they were side effecting and triggered full adapter/date range recalculations. Typical usage of the view involves setting all these invariants up front during onCreate and it was unknown to the user that setting all 4 of these would create a lot of waste. Not to mention certain things were side effecting--some would reset the current day or selected date. As a result, the same 4 methods called in a different order could result in a different state, which is bad.

  For most cases you will simply need to replace setting those invariants with:

  mcv.state().edit()
    .setFirstDayOfWeek(Calendar.WEDNESDAY)
    .setMinimumDate(CalendarDay.from(2016, 4, 3))
    .setMaximumDate(CalendarDay.from(2016, 5, 12))
    .setCalendarDisplayMode(CalendarMode.WEEKS)
    .commit();

  mcv.state().edit() will retain previously set values; mcv.newState() will create a new state using default values. Calling commit will trigger the rebuild of adapters and date ranges. It is recommended these state changes occur as the first modification to MCV (before configuring anything else like current date or selected date); we make no guarantee those modifications will be retained when the state is modified.

  See CUSTOMIZATION_BUILDER for usage details.

• New: setSelectionMode(SELECTION_MODE_RANGE) was added to allow 2 dates to be selected and have the entire range of dates selected. Much thanks to papageorgiouk for his work on this feature.

See other changes in the CHANGELOG.

Major Change in 1.3.0

• Breaking change: getTileSize is deprecated. Use getTileWidth or getTileHeight.
• Added goToNext and goToPrevious API to programmatically trigger paging
• Allow users to click on dates outside of current month with setAllowClickDaysOutsideCurrentMonth
• Set tile width/height separately rather than single tile size with setTileWidth and setTileHeight
• Attributes: mcv_tileWidth, mcv_tileHeight, mcv_calendarMode
• TalkBack APIs: setContentDescriptionArrowPast, ArrowFuture, Calendar

Major Change in 1.2.0

You can now collapse the calendar view to single week paging by calling setCalendarDisplayMode(CalendarMode.WEEKS). By default it is set to CalendarMode.MONTHS. Thanks Dominik Zarzecki!

Major Change in 1.0.0

With the implementation of multiple selection, some of the apis needed to change to support it, namely OnDateChangedListener is now OnDateSelectedListener. There are also a bunch of new apis for multiple selection.

Also, showOtherDates is now a set of flags for finer control over which extra dates are shown.

Major Change in 0.8.0

The view now responds better to layout parameters. The functionality is similar to how adjustViewBounds works with ImageView, where the view will try and take up as much space as necessary, but we base it on tile size instead of an aspect ratio. The exception being that if a tileSize is set, that will override everything and set the view to that size.

Documentation

Make sure to check all the documentation available here.

Customization

One of the aims of this library is to be customizable. The many options include:

• Define the view's width and height in terms of tile size
• Single or Multiple date selection, or disabling selection entirely
• Showing dates from other months or those out of range
• Setting the first day of the week
• Show only a range of dates
• Customize the top bar
• Custom labels for the header, weekdays, or individual days

Events, Highlighting, Custom Selectors, and More!

All of this and more can be done via the decorator api. Please check out the decorator documentation.

Custom Selectors and Colors

If you provide custom drawables or colors, you'll want to make sure they respond to state. Check out the documentation for custom states.

Contributing

Would you like to contribute? Fork us and send a pull request! Be sure to checkout our issues first.

License

Material Calendar View is Copyright (c) 2016 Prolific Interactive. It may be redistributed under the terms specified in the LICENSE file.

Maintainers

Material Calendar View is maintained and funded by Prolific Interactive. The names and logos are trademarks of Prolific Interactive.