-
Notifications
You must be signed in to change notification settings - Fork 74
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Modify README Minor changes
- Loading branch information
jonatansalas
committed
Jan 17, 2017
1 parent
2a2cac3
commit c17dbf2
Showing
7 changed files
with
61 additions
and
178 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2016 BlackBox Vision | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,76 +1,16 @@ | ||
|
|
||
| #Material Calendar View  [](http://android-arsenal.com/details/1/2715) [](https://gitter.im/jonisaa/material-calendar-view?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | ||
|
|
||
| Material Calendar View is a Library based on the GitHub project: [Custom Calendar View](https://github.com/npanigrahy/Custom-Calendar-View) | ||
|
|
||
| I found [Custom Calendar View](https://github.com/npanigrahy/Custom-Calendar-View) as a really interesting project. But when I started using Custom Calendar View I’ve found that it needed some modifications in order to work as I expected. | ||
|
|
||
| So I decided to get involved onto Custom Calendar View to get the modifications I | ||
| needed. *(Thanks to [Npanigrahy](https://github.com/npanigrahy))* | ||
|
|
||
| Nowadays my project supports this features: | ||
| > - Compatibility with Android API 8+ | ||
| > - Swipe gesture-based navigation | ||
| > - 'Next' and 'Previous' month-based navigation | ||
| > - Full customization of calendar from XML file, or setters. | ||
| > - User-allowed to handle events when changes month and day selection | ||
| using two listeners. | ||
| > - Show/hide next/previous month overflow days. | ||
| > - User-allowed modify Typeface of the Calendar View by using setTypeface() | ||
| method. | ||
| > - Unlimited customizations for Day of the Month using custom Decorators. | ||
| > - Add Roboto Fonts files and a Util class to make this fonts accessible. *(This probably increase library size)* | ||
| ---------- | ||
| Features in Process | ||
| ------------- | ||
| In order to make the Calendar more customizable and Interactive, the next is | ||
| a list of some features that I want to add: | ||
| > - Provide two CalendarViews, one build in Java Calendar API, and the other in JODA Time API | ||
| > - Synchonize Events with Google Calendar ContentProvider | ||
| > - Add Ripple Effects when the user touches a day. | ||
| > - Add two layouts for CalendarView: first one that supports only Swipe navigation without buttons; the second one will support Swipe, and back/next button navigation (actually the default view). | ||
| ---------- | ||
| 6th November 2015 | ||
| ------------- | ||
| Announcing the draft of a new release v1.2.2.The changes applied are the next: | ||
| >- BugFix of , now CalendarView should not break activity when displaying for Chinese Locale. Speccially thanks to @maddie who solve submiting a pull request | ||
| ---------- | ||
| 4th November 2015 | ||
| ------------- | ||
| Announcing the draft of a new release v1.2.1. The changes applied are the next: | ||
| >- Deleted unused resources to reduce library file size. | ||
| >- Added RobotoFonts to the Assets folder. | ||
| >- Added a String file handling all path to RobotoFonts. | ||
| >- Added a Util class to get the Roboto typefaces called TypefaceUtil. | ||
| >- Better performance on Swipe by making some adjustments. | ||
| >- Added setBackButtonColor method, it allows you to change back arrow color. | ||
| >- Added setNextButtonColor method, it allows you to change next arrow color | ||
| >- Added setBackButtonDrawable method, it allows you to change back button drawable. | ||
| >- Added setNextButtonDrawable method, it allows you to change next button drawable. | ||
| >- Modified the month title show format from "MONTH_NAME" to "MONTH_NAME + ' ' + YEAR" | ||
| >- BugFix: Retain current day style even if you swipe to another month and come back to actual month. | ||
| >- Added method findViewByDate(), it receives a Date as param and returns a DayView object (Custom TextView). It lets you style dayView as you want. | ||
| >- Refactor of some methods in order to clarify code readability. | ||
| >- markCurrentDay is now renamed to setCurrentDay(). | ||
| >- markCurrentDateAsSelected is now renamed to setDateAsSelected(). | ||
| MaterialCalendarView is a prettier and simpler, material design calendar that allows full customization and it's backwards compatible with API 11+. | ||
|
|
||
| ---------- | ||
| Screenshots | ||
| ------------- | ||
| <img src="https://raw.githubusercontent.com/SAMSistemas/MaterialCalendarView/master/screenshots/calendars.png" height="425" width="100%"> | ||
|
|
||
| ---------- | ||
| Screencast | ||
| ------------- | ||
| <img src="https://i.imgur.com/ViolZD2.gif" height="550" width="100%" style="align: center;"> | ||
|
|
||
| ---------- | ||
| Adding to your Project | ||
| ------------- | ||
| Nowadays the library current stable version is 1.2.2. | ||
| ##Installation | ||
|
|
||
| ### For Gradle: | ||
| **Step 1:** you must add the JitPack repository to your build file. Type the | ||
|
|
@@ -118,12 +58,11 @@ resolvers += "jitpack" at "https://jitpack.io" | |
| ```java | ||
| libraryDependencies += "com.github.BlackBoxVision" % "material-calendar-view" % "v1.2.3" | ||
| ``` | ||
| ---------- | ||
| Using Material Calendar View library | ||
| ------------- | ||
| This project includes a Sample App that shows you the true power of this library. If you want to know more, feel free to clone, deploy and play with it. Else I’ll give you a little code snippets. | ||
|
|
||
| ##Usage example | ||
|
|
||
| Pay attention to the following: | ||
|
|
||
| ```xml | ||
| <io.blackbox_vision.calendarview.widget.CalendarView | ||
| android:id="@+id/calendar_view" | ||
|
|
@@ -132,7 +71,9 @@ Pay attention to the following: | |
| android:background="@color/colorPrimary"> | ||
| </io.blackbox_vision.calendarview.widget.CalendarView> | ||
| ``` | ||
|
|
||
| The above code snippet will show the simple Calendar View on the default layout. Now, you can use the following attributes if you want to customize the appearance of calendar: | ||
|
|
||
| ```xml | ||
| <io.blackbox_vision.calendarview.widget.CalendarView | ||
| android:id="@+id/calendar_view" | ||
|
|
@@ -190,45 +131,16 @@ final DayView dayView = calendarView.findViewByDate(new Date(System.currentTimeM | |
| if(null != dayView) | ||
| Toast.makeText(getApplicationContext(), "Today is: " + dayView.getText().toString() + "/" + calendarView.getCurrentMonth() + "/" + calendarView.getCurrentYear(), Toast.LENGTH_SHORT).show(); | ||
| ``` | ||
| ---------- | ||
| Known issues | ||
| ------------- | ||
|
|
||
| I’ve made a lot of testand I’ve found no issues. This library I’ve built againts travis and run the sample app in the supported API emulators. But maybe you can find an Issue that i can't detect or whatever. | ||
| ##Issues | ||
|
|
||
| If you do so, please, let me know. I will be happy to solve it in order to help you. | ||
| If you found a bug, or you have an answer, or whatever. Please, open an [issue](https://github.com/BlackBoxVision/material-calendar-view/issues). I will do the best to fix it, or help you. | ||
|
|
||
| ---------- | ||
| Specially Thanks | ||
| ------------- | ||
| Thanks to Mai Arrojo, who colaborate by my side to make English README file more understandable. We are working actually in the library code documentantion. She is good with translations. If you want to contact her for a job opportunity mail her to: [email protected] | ||
| ##Contributing | ||
|
|
||
| ---------- | ||
| Contact Me | ||
| ------------- | ||
| If you like this library, and want me to add some features in order to make it better just mail me to [email protected] or [email protected]. I’ll make it count. | ||
| Of course, if you see something that you want to upgrade from this library, or a bug that needs to be solved, **PRs are welcome!** | ||
|
|
||
| ---------- | ||
| License | ||
| ------------- | ||
| This library is distributed under **Apache License 2**, feel free to do any modification. | ||
| ##License | ||
|
|
||
| Distributed under the **MIT license**. See [LICENSE](https://github.com/BlackBoxVision/material-calendar-view/blob/master/LICENSE) for more information. | ||
|
|
||
| ``` | ||
| /* | ||
| * Copyright (C) 2015 ImanoWeb {link: http://imanoweb.com}. | ||
| * Copyright (C) 2015 SAMSistemas {link: http://www.samsistemas.com.ar} | ||
| * Copyright (C) 2015 Jonisaa {link: http://the-android-developer.blogspot.com.ar}. | ||
| * | ||
| * 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. | ||
| */ | ||
| ``` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.