From 3f907c1cd4ac1637c1500aa852c6bcaf5264ba47 Mon Sep 17 00:00:00 2001 From: Niroj Dahal Date: Mon, 16 Aug 2021 19:25:51 +0545 Subject: [PATCH] Readme updated to include control details --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index e9fc777..159fe89 100644 --- a/README.md +++ b/README.md @@ -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 + +``` ``` + +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]