Skip to content

Commit ddd0268

Browse files
authored
Update README.md
1 parent 0507e5e commit ddd0268

1 file changed

Lines changed: 18 additions & 14 deletions

File tree

README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,13 @@
55
This library is a Persian date picker with huge customization options.
66
My initial idea for creating this library was to build it to be used for a lot of different UI conditions.
77

8+
## Screenshot
9+
<img src="https://github.com/razavioo/PersianDatePicker/blob/master/screenshot/screenshot.png">
810

911
## Customizations
1012

1113
Views of this class can be changed directly, according to your UI needs. The library is dependent on this great [NumberPicker](https://github.com/ShawnLin013/NumberPicker) library.
12-
So you can play with each of these library's features except for **setOnValueChangedListener()**, which is directly used in our library.
13-
14-
## Special thanks
15-
16-
Thanks for Shawn with his great work in [NumberPicker](https://github.com/ShawnLin013/NumberPicker), which is beyond my imagination.
17-
The UI of this library is dependent on his module.
18-
19-
Thanks for the amazing work of Saman Zamani for creating the [PersianDate](https://github.com/samanzamani/PersianDate), which this class is built upon it.
20-
His work made creating this library so easy.
14+
So you can play with each of these library's features except for `setOnValueChangedListener()`, which is directly used in our library.
2115

2216
## Gradle
2317

@@ -45,7 +39,7 @@ After adding these two dependencies, sync your project and start using the View
4539
android:layout_width="wrap_content"
4640
android:layout_height="wrap_content" />
4741
```
48-
42+
* #### UI elements
4943
As you can see, this class does not have any custom XML attributes because that will make the view less customizable.
5044
If you need to change the UI parameter, you can get each of the inner view elements programmatically.
5145

@@ -60,15 +54,17 @@ The methods for grabbing Views that you can change it is as follows.
6054
| getMonthTitleTextView() | TextView | get TextView for title of month picker
6155
| getDayTitleTextView() | TextView | get TextView for title of day picker
6256

63-
The **NumberPicker** is the view of the custom number picker.
57+
The **NumberPicker** is the view of the custom number picker.
6458

65-
We have a method to choose whether you want to show month values as digits or strings.
66-
Digits are the number of the month, and the string is the name of the month.
59+
* #### Month picker format
60+
We have a method to choose whether you want to show month values as digits or strings.
61+
Digits are the number of the month, and the string is the name of the month.
6762

6863
| Method | Description
6964
| ------------------------------------- | --------|
7065
| setMonthType((monthType: MonthType)) | set month value type (**MonthType.DIGIT** or **MonthType.STRING**)
7166

67+
* #### Listener
7268
For listening to changes in the picker, you can use the below method.
7369
the interface hase three methods, **onYearChanged**, **onMonthChanged**, **onDayChanged**.
7470

@@ -78,8 +74,16 @@ the interface hase three methods, **onYearChanged**, **onMonthChanged**, **onDay
7874

7975
## Implementation suggestion
8076
As this clas needs to be customized based off of your special UI needs and conditions,
81-
I suggest that you create a class that extends the **PersianDatePicker** class and has initialized with all your special configurations. then use this class instead of the general class.
77+
I suggest that you create a class that extends the [**PersianDatePicker**](https://github.com/razavioo/PersianDatePicker/blob/master/PersianDatePicker/src/main/java/com/razavioo/persiandatepicker/PersianDatePicker.kt) class and has initialized with all your special configurations. then use this class instead of the general class.
8278
In the [sample](https://github.com/razavioo/PersianDatePicker/blob/master/app/src/main/java/com/razavioo/sample/MyPersianDatePicker.kt), I have created one and you can get the idea by watching it.
8379

80+
## Special thanks
81+
82+
Thanks for Shawn with his great work in [NumberPicker](https://github.com/ShawnLin013/NumberPicker), which is beyond my imagination.
83+
The UI of this library is dependent on his module.
84+
85+
Thanks for the amazing work of Saman Zamani for creating the [PersianDate](https://github.com/samanzamani/PersianDate), which this class is built upon it.
86+
His work made creating this library so easy.
87+
8488
## License
8589
The source code is licensed under the [apache2](LICENSE) license.

0 commit comments

Comments
 (0)