Skip to content

Commit

Permalink
Readme updated to include control details
Browse files Browse the repository at this point in the history
  • Loading branch information
solo-developer authored Aug 16, 2021
1 parent 61a78ff commit 3f907c1
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,36 @@ Nepali Date Picker for Xamarin Forms

``` Install-Package Xam.Plugins.NepaliDatePicker -Version 1.0.0 ```

**Usage**

1. Import namespace in your xaml file

``` xmlns:CustomControls="clr-namespace:Xam.Plugins.NepaliDatePicker.CustomControls;assembly=Xam.Plugins.NepaliDatePicker" ```

2. Use CustomControl wherever required

``` <CustomControls:NepaliDatePickerEntry DateFormat="mDy" Separator="/" CurrentDate="04/31/2078" /> ```

3. Since, it uses [Rg.Plugins.Popup](https://github.com/rotorgames/Rg.Plugins.Popup/wiki/Getting-started) for showing calendar , initialise it in platform specific projects.

**Available Bindable Properties**
This plugin is a customisation on existing Entry . So, you can use all existing bindable properties of entry. Below are the bindable properties provided by this plugin

***CurrentDate***
Provide initial Value to the control by setting value in this property .Value defaults to String.Empty

***Separator***
Takes char value and used to separate the day,month and year parts . Value defaults to "-"

***DateFormat***
gets/sets Text value in control in specified format . Available Options are
1. yMd
2. dMy
3. mDy

Value defaults to yMd


**Working Screenshot**
![alt text][screenshot]

Expand Down

0 comments on commit 3f907c1

Please sign in to comment.