================= Android Week View
Android Week View is an android library to display calendars (week view or day view) within the app. It supports custom styling.
Features
- Week view calendar
- Day view calendar
- Custom styling
- Horizontal and vertical scrolling
- Infinite horizontal scrolling
- Live preview of custom styling in xml preview window
Who uses it
- [Quivr] (https://quivr.be/en/)
- Series Addict
- Unicaen Timetable
- Using the library? Just make an issue
Usage
- Import the library into your project.
-
Grab via maven
<dependency> <groupId>com.github.quivr</groupId> <artifactId>android-week-view</artifactId> <version>2.0.2</version> <type>aar</type> </dependency>
-
Grab via gradle
compile 'com.github.quivr:android-week-view:2.0.2'
-
Add WeekView in your xml layout.
<com.alamkanak.weekview.WeekView android:id="@+id/weekView" android:layout_width="match_parent" android:layout_height="match_parent" app:eventTextColor="@android:color/white" app:textSize="12sp" app:hourHeight="60dp" app:headerColumnPadding="8dp" app:headerColumnTextColor="#8f000000" app:headerRowPadding="12dp" app:columnGap="8dp" app:noOfVisibleDays="3" app:headerRowBackgroundColor="#ffefefef" app:dayBackgroundColor="#05000000" app:todayBackgroundColor="#1848adff" app:headerColumnBackground="#ffffffff"/>
-
Write the following code in your java file.
// Get a reference for the week view in the layout. mWeekView = (WeekView) findViewById(R.id.weekView); // Set an action when any event is clicked. mWeekView.setOnEventClickListener(mEventClickListener); // The week view has infinite scrolling horizontally. We have to provide the events of a // month every time the month changes on the week view. mWeekView.setMonthChangeListener(mMonthChangeListener); // Set long press listener for events. mWeekView.setEventLongPressListener(mEventLongPressListener);
-
Implement
WeekView.MonthChangeListener
,WeekView.EventClickListener
,WeekView.EventLongPressListener
according to your need. -
Provide the events for the
WeekView
inWeekView.MonthChangeListener.onMonthChange()
callback. Please remember that the calendar pre-loads events of three consecutive months to enable lag-free scrolling.MonthLoader.MonthChangeListener mMonthChangeListener = new MonthLoader.MonthChangeListener() { @Override public List<WeekViewEvent> onMonthChange(int newYear, int newMonth) { // Populate the week view with some events. List<WeekViewEvent> events = getEvents(newYear, newMonth); return events; } };
Customization
You can customize the look of the WeekView
in xml. Use the following attributes in xml. All these attributes also have getters and setters to enable you to change the style dynamically.
allDayEventHeight
autoLimitTime
columnGap
dayBackgroundColor
dayNameLength
eventCornerRadius
eventMarginVertical
eventPadding
eventTextColor
eventTextSize
firstDayOfWeek
futureBackgroundColor
futureWeekendBackgroundColor
headerColumnBackground
headerColumnPadding
headerColumnTextColor
headerRowBackgroundColor
headerRowPadding
horizontalFlingEnabled
hourHeight
hourSeparatorColor
hourSeparatorHeight
maxHourHeight
maxTime
minHourHeight
minTime
newEventColor
newEventId
newEventIconResource
newEventLengthInMinutes
newEventTimeResolutionInMinutes
noOfVisibleDays
nowLineColor
nowLineThickness
overlappingEventGap
pastBackgroundColor
pastWeekendBackgroundColor
scrollDuration
showDistinctPastFutureColor
showDistinctWeekendColor
showFirstDayOfWeekFirst
showNowLine
textSize
timeColumnResolution
todayBackgroundColor
todayHeaderTextColor
verticalFlingEnabled
xScrollingSpeed
zoomFocusPoint
The focused point (percentage of the view height) where the week view is zoomed around. This point will not move while zooming. You can declare it as a fractionapp:focusPoint="30%"
and if is not declared the top of the view is used.zoomFocusPointEnabled
If you set this tofalse
the zoomFocusPoint won't take effect any more while zooming. The zoom will always be focused at the center of your gesture.
Interfaces
Use the following interfaces according to your need.
mWeekView.setWeekViewLoader()
to provide events to the calendarmWeekView.setMonthChangeListener()
to provide events to the calendar by monthsmWeekView.setOnEventClickListener()
to get a callback when an event is clickedmWeekView.setEventLongPressListener()
to get a callback when an event is long pressedmWeekView.setEmptyViewClickListener()
to get a callback when any empty space is clickedmWeekView.setEmptyViewLongPressListener()
to get a callback when any empty space is long pressedmWeekView.setDateTimeInterpreter()
to set your own labels for the calendar header row and header columnmWeekView.setScrollListener()
to get an event every time the first visible day has changedmWeekView.setAddEventClickListener()
to get the start and end time of an event to add Sample
There is also a sample app to get you started.
To do
- Add event touch feedback selector
Changelog
Version 2.0.0
- This fork is first released
- Possibility to set minDate and maxDate
- Allday events are supported
- Events can be add by clicking on empty space
Version 1.2.6
- Add empty view click listener
- Fix padding bug
- Fix bug when setting colors of different components
- Add ability to turn off fling gesture
- Add example of how to load events asynchronously in the sample app
Version 1.2.5
- Add support for using subclasses of
WeekViewEvent
- Fix scroll animation
- Add support for semi-transparent header colors
Version 1.2.4
- NOTE: If you are using
WeekView.MonthChangeListener
, make sure to change it intoMonthLoader.MonthChangeListener
- Add support to have loaders other than MonthViewLoader
- Add pinch to zoom support
- Add support for location
- Add ability to have different colors for past, future, weekend days
- Add support for "now" line
Version 1.2.3
- Get callbacks when scrolling horizontally
goToHour
andgoToDate
methods has been fixed- Use
getFirstVisibleHour
method to get the first visible hour in the week view
Version 1.2.1
- Better scrolling added
- Get callbacks when empty view is tapped/long pressed
- Control the speed of scrolling
- Support for multiple language added
- Ability to set your own interpreter for header row and column added
Version 1.1.7
- You can now dynamically scroll to an hour of your preference.
Version 1.1.6
- Added support for events that expands to multiple days
Version 1.1.5
- A bug related to overlapping events fixed
- You can now programmatically get first and last visible day in the week view
Version 1.1.4
- Small bug fixed
Version 1.1.3
- Margins support added for overlapping events
Version 1.1.2
- Small bugs fixed
- Hour separator inconsistency fixed
Version 1.1.1
- Overlapping event bug fixed
Version 1.1.0
- Added support for overlapping events
License
Copyright 2014 Raquib-ul-Alam
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.