Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aminography/primedatepicker
PrimeDatePicker is a tool that provides picking a single day, multiple days, and a range of days.
https://github.com/aminography/primedatepicker
calendar calendar-component calendar-view calendarview datepicker datepicker-range gregorian-calendar hijri-calendar japanese-calendar material material-design monthview persian-calendar picker-bottom-sheet
Last synced: 5 days ago
JSON representation
PrimeDatePicker is a tool that provides picking a single day, multiple days, and a range of days.
- Host: GitHub
- URL: https://github.com/aminography/primedatepicker
- Owner: aminography
- License: apache-2.0
- Created: 2019-05-23T16:34:01.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-26T10:04:06.000Z (7 months ago)
- Last Synced: 2025-02-01T18:40:59.165Z (5 days ago)
- Topics: calendar, calendar-component, calendar-view, calendarview, datepicker, datepicker-range, gregorian-calendar, hijri-calendar, japanese-calendar, material, material-design, monthview, persian-calendar, picker-bottom-sheet
- Language: Kotlin
- Homepage:
- Size: 9.84 MB
- Stars: 473
- Watchers: 6
- Forks: 52
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# `PrimeDatePicker` :zap:
[](https://android-arsenal.com/details/1/7743)
[](http://androidweekly.net/issues/issue-367)
[](https://app.codacy.com/manual/aminography/PrimeDatePicker?utm_source=github.com&utm_medium=referral&utm_content=aminography/PrimeDatePicker&utm_campaign=Badge_Grade_Dashboard)
[](https://android-arsenal.com/api?level=13)
Firstly, **`PrimeDatePicker`** is a tool that provides picking a single day, multiple days, and a range of days. Secondly, you can use internal elements like `MonthView` and `CalendarView` as stand-alone views in your projects.
Multiple Days | Civil
BottomSheet | Dark
Range of Days | Persian
BottomSheet | Light
Single Day | Hijri
Dialog | Light
Goto Feature | Japanese
Dialog | Dark
Table of Contents
-----------------
- [Core Logic](#core-logic)
- [Main Characteristics](#main-characteristics)
- [Download](#download)
- [Usage](#usage)
- [Java Example](#java-example)
- [Builder Configurations](#builder-configurations)
- [Input Calendar Configurations](#input-calendar-configurations)
- [Customizing Theme](#customizing-theme)
- [Customizing Texts](#customizing-texts)
- [Stand-Alone Views](#stand-alone-views)
- [Change Log](#change-log)
Core Logic
----------
The ❤️ of this library is provided by [**PrimeCalendar**](https://github.com/aminography/PrimeCalendar).
Main Characteristics
--------------------
- Endless Scrolling
- Fully Customizable Views & Themes
- Align With Material Design
- Fluent UI
- RTL Support
- Landscape Support
- Various Calendar Types
- Various Date Picking Strategies
- Dialog & BottomSheet Presentations
- Fast Goto
#### :dart: Download [SampleApp.apk](https://github.com/aminography/PrimeDatePicker/releases/download/v3.4.0/sample-app-release.apk)
Download
--------
**`PrimeDatePicker`** is available on `MavenCentral` to download using build tools systems. Add the following lines to your `build.gradle` file:
```gradle
dependencies {
implementation 'com.aminography:primedatepicker:3.6.0'
implementation 'com.aminography:primecalendar:1.7.0'
}
```
Usage
-----
To enjoy `PrimeDatePicker`, create an instance using a builder pattern in simple 4 steps.
1. Decide on **BottomSheet** or **Dialog** representation along with an initial calendar:
```kotlin
// To show a date picker with Civil dates, also today as the starting date
val today = CivilCalendar()
val datePicker = PrimeDatePicker.bottomSheetWith(today) // or dialogWith(today)
```
2. Decide on picking strategy along with passing a proper callback:
```kotlin
val callback = SingleDayPickCallback { day ->
// TODO
}
val today = CivilCalendar()
val datePicker = PrimeDatePicker.bottomSheetWith(today)
.pickSingleDay(callback) // or pickRangeDays(callback) or pickMultipleDays(callback)
```
3. Apply some optional configurations:
```kotlin
...
val datePicker = PrimeDatePicker.bottomSheetWith(today)
.pickSingleDay(callback)
.initiallyPickedSingleDay(pickedDay)
...
```
4. Build the date picker and show it:
```kotlin
val callback = SingleDayPickCallback { day ->
// TODO
}
val today = CivilCalendar()
val datePicker = PrimeDatePicker.bottomSheetWith(today)
.pickSingleDay(callback)
.initiallyPickedSingleDay(pickedDay)
.build()
datePicker.show(supportFragmentManager, "SOME_TAG")
```
### Java Example
> Java
```java
SingleDayPickCallback callback = new SingleDayPickCallback() {
@Override
public void onSingleDayPicked(PrimeCalendar singleDay) {
// TODO
}
};
// To show a date picker with Japanese dates, also today as the starting date
PrimeCalendar today = new JapaneseCalendar();
PrimeDatePicker datePicker = PrimeDatePicker.Companion.dialogWith(today)
.pickSingleDay(callback)
.build();
datePicker.show(getSupportFragmentManager(), "SOME_TAG");
```
### Builder Configurations
There are several builder functions applying relevant configurations on the date picker.
Function
Picking Strategy
• minPossibleDate(minDate: PrimeCalendar)
ALL
Specifies the minimum feasible date to be shown in date picker, which is selectable.
• maxPossibleDate(maxDate: PrimeCalendar)
ALL
Specifies the maximum feasible date to be shown in date picker, which is selectable.
• firstDayOfWeek(firstDayOfWeek: Int)
ALL
Specifies the day that should be considered as the start of the week. Possible values are: Calendar.SUNDAY, Calendar.MONDAY, etc.
• disabledDays(disabledDays: List<PrimeCalendar>)
ALL
Specifies the list of disabled days, which aren't selectable.
• applyTheme(themeFactory: ThemeFactory)
ALL
Specifies the theme.
• initiallyPickedSingleDay(pickedDay: PrimeCalendar)
SingleDay
Specifies initially picked day when the date picker has just shown.
• initiallyPickedRangeDays(startDay: PrimeCalendar, endDay: PrimeCalendar)
RangeDays
Specifies initially picked range of days when the date picker has just shown.
• autoSelectPickEndDay(autoSelect: Boolean)
RangeDays
Specifies automatic selection of picking end day when the start day gets picked.
• initiallyPickedMultipleDays(pickedDays: List<PrimeCalendar>)
MultipleDays
Specifies initially picked multiple days when the date picker has just shown.
### Input Calendar Configurations
In addition to the builder functions, `PrimeDatePicker` receives some configurations from the input calendar. For example:
```kotlin
// shows a Persian calendar, but in English language, which leads to LTR direction
val calendar = PersianCalendar(Locale.ENGLISH).also {
it.year = 1398 // determines starting year
it.month = 7 // determines starting month
it.firstDayOfWeek = Calendar.MONDAY // sets first day of week to Monday
}
val datePicker = PrimeDatePicker.bottomSheetWith(calendar)
...
.build()
```
Customizing Theme
-----------------
`PrimeDatePicker` is fully customizable and you can tailor it to what you desire.
Almost everything you see is customizable. For example:
- text sizes & colors
- background & element colors
- padding & distances
- font typeface
- string formatter
- calendar animations & transition parameters
- *etc*
In this way, a set of customizable theme factory classes are provided to specify theme parameters.
By default, there are two concrete subclasses for the them factory:
- [`DarkThemeFactory`](library/src/main/java/com/aminography/primedatepicker/picker/theme/DarkThemeFactory.kt)
- [`LightThemeFactory`](library/src/main/java/com/aminography/primedatepicker/picker/theme/LightThemeFactory.kt)
You can override their parameters, or inherit a class from, or make your own theme factory.
Here is an example of how to override theme parameters to customize it:
```kotlin
val themeFactory = object : LightThemeFactory() {
override val typefacePath: String?
get() = "fonts/Righteous-Regular.ttf"
override val dialogBackgroundColor: Int
get() = getColor(R.color.yellow100)
override val calendarViewBackgroundColor: Int
get() = getColor(R.color.yellow100)
override val pickedDayBackgroundShapeType: BackgroundShapeType
get() = BackgroundShapeType.ROUND_SQUARE
override val calendarViewPickedDayBackgroundColor: Int
get() = getColor(R.color.green800)
override val calendarViewPickedDayInRangeBackgroundColor: Int
get() = getColor(R.color.green400)
override val calendarViewPickedDayInRangeLabelTextColor: Int
get() = getColor(R.color.gray900)
override val calendarViewTodayLabelTextColor: Int
get() = getColor(R.color.purple200)
override val calendarViewWeekLabelFormatter: LabelFormatter
get() = { primeCalendar ->
when (primeCalendar[Calendar.DAY_OF_WEEK]) {
Calendar.SATURDAY,
Calendar.SUNDAY -> String.format("%s😍", primeCalendar.weekDayNameShort)
else -> String.format("%s", primeCalendar.weekDayNameShort)
}
}
override val calendarViewWeekLabelTextColors: SparseIntArray
get() = SparseIntArray(7).apply {
val red = getColor(R.color.red300)
val indigo = getColor(R.color.indigo500)
put(Calendar.SATURDAY, red)
put(Calendar.SUNDAY, red)
put(Calendar.MONDAY, indigo)
put(Calendar.TUESDAY, indigo)
put(Calendar.WEDNESDAY, indigo)
put(Calendar.THURSDAY, indigo)
put(Calendar.FRIDAY, indigo)
}
override val calendarViewShowAdjacentMonthDays: Boolean
get() = true
override val selectionBarBackgroundColor: Int
get() = getColor(R.color.brown600)
override val selectionBarRangeDaysItemBackgroundColor: Int
get() = getColor(R.color.orange700)
}
```
Using above theme, we can transform the light theme (left picture) to the right one.
Normal Light Theme
Customized Light Theme
> Java Theme Customization Example
```java
BaseThemeFactory themeFactory = new LightThemeFactory() {
@NotNull
@Override
public PrimeCalendarView.FlingOrientation getCalendarViewFlingOrientation() {
return PrimeCalendarView.FlingOrientation.HORIZONTAL;
}
@Override
public int getSelectionBarBackgroundColor() {
return super.getColor(R.color.green300);
}
// Other customizations...
};
```
### Customizing Texts
If you want to change some texts in `PrimeDatePicker`, such as a button text, the current solution is to
define some strings in your project's `strings.xml` with equal name defined in the library's `strings.xml`, to override them.
Stand-Alone Views
-----------------
To see how to use **`PrimeMonthView`** & **`PrimeCalendarView`**, [refer to wiki page](https://github.com/aminography/PrimeDatePicker/wiki#stand-alone-views) .
Change Log
----------
The change log is available [here](https://github.com/aminography/PrimeDatePicker/wiki/Change-Log).
License
--------
```
Copyright 2019 Mohammad Amin Hassani.
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.
```