Skip to content

Commit 7d4d7c0

Browse files
enisnenisn
committed
Update README.md
1 parent fa8988b commit 7d4d7c0

File tree

1 file changed

+35
-140
lines changed

1 file changed

+35
-140
lines changed

‎README.md‎

Lines changed: 35 additions & 140 deletions
Original file line numberDiff line numberDiff line change
@@ -53,115 +53,59 @@
5353
5454
<hr />
5555

56-
<a href="https://github.com/enisn/Xamarin.Forms.InputKit/wiki/CheckBox">
57-
<h2>Checkbox</h2>
58-
</a>
59-
<p>A useful, customizable, full-featured, fully-bindable CheckBox.</p>
6056

61-
<h4>SAMPLE:</h4>
6257

63-
```xaml
64-
<?xml version="1.0" encoding="utf-8" ?>
65-
<ContentPage xmlns="http://xamarin.com/schemas/2014/forms"
66-
xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
67-
xmlns:local="clr-namespace:Sample.InputKit"
68-
xmlns:input="clr-namespace:Plugin.InputKit.Shared.Controls;assembly=Plugin.InputKit"
69-
x:Class="Sample.InputKit.MainPage">
70-
<StackLayout Spacing="12" Padding="30,0">
71-
<input:CheckBox Text="Option 1" Type="Box" />
72-
<input:CheckBox Text="Hello World I'm Option 2" Type="Check"/>
73-
<input:CheckBox Text="Consetetur eum kasd eos dolore Option 3" Type="Cross"/>
74-
<input:CheckBox Text="Sea sed justo" Type="Star"/>
75-
</StackLayout>
76-
</ContentPage>
77-
```
58+
## CheckBox
59+
60+
A checkbox control that is useful, customizable, full-featured, fully-bindable and easy to use.
61+
62+
- [Sample Code](sandbox/SandboxMAUI/Pages/CheckBoxPage.xaml)
63+
- [Documentation](docs/Controls/CheckBox.md)
64+
7865
<br />
7966
<table>
8067
<tr>
8168
<td>
82-
<img src="https://raw.githubusercontent.com/enisn/Xamarin.Forms.InputKit/develop/shreenshots/checkboxes_android.gif" alt="Xamarin Forms CheckBox Input Kit Enis Necipoglu" width="270" height="480" class="aligncenter size-medium wp-image-996" />
69+
<img src="docs/images/checkbox-dark-windows.gif" alt="Xamarin Forms CheckBox Input Kit Enis Necipoglu" width="270" class="aligncenter size-medium wp-image-996" />
70+
</td>
71+
72+
<td>
73+
<img src="docs/images/checkbox-light-android.gif" alt="Xamarin Forms CheckBox Input Kit Enis Necipoglu" width="270" class="aligncenter size-medium wp-image-996" />
8374
</td>
8475
<td>
85-
<img src="https://raw.githubusercontent.com/enisn/Xamarin.Forms.InputKit/develop/shreenshots/checkboxes_ios.png" alt="Xamarin Forms CheckBox Input Kit Enis Necipoglu" width="270" height="480" class="aligncenter size-medium wp-image-996" />
76+
<img src="https://raw.githubusercontent.com/enisn/Xamarin.Forms.InputKit/develop/shreenshots/checkboxes_ios.png" alt="Xamarin Forms CheckBox Input Kit Enis Necipoglu" width="270" class="aligncenter size-medium wp-image-996" />
8677
</td>
8778
</tr>
8879
</table>
89-
90-
<h4>PROPERTIES:</h4>
91-
<ul>
92-
<li><strong>CheckChanged:</strong> <em>(Event)</em> Invokes when check changed.</li>
93-
<li><strong>CheckChangedCommand:</strong> <em>(Command)</em> Bindable Command, executed when check changed.</li>
94-
<li><strong>Key:</strong> <em>(int)</em> A key you can set to define checkboxes as ID.</li>
95-
<li><strong>Text:</strong> <em>(string)</em> Text to display description</li>
96-
<li><strong>IsChecked:</strong> <em>(bool)</em> Checkbox checked situation. Works TwoWay Binding as default.</li>
97-
<li><strong>Color:</strong> <em>(Color)</em> Color of selected check.</li>
98-
<li><strong>TextColor:</strong> <em>(Color)</em> Color of description text.</li>
99-
<li><strong>Type:</strong> <em>(CheckType)</em> Type of checkbox checked style. (Check,Cross,Star,Box etc.)</li>
100-
</ul>
10180
<hr />
10281

10382

104-
<h2>RadioButon</h2>
105-
<p>Radio Buttons should use inside a <strong>RadioButtonGroupView</strong>. If you want this view will return you selected radio button. But you can handle it one by one too. </p>
106-
<h4>SAMPLE:</h4>
107-
108-
```xaml
109-
<?xml version="1.0" encoding="utf-8" ?>
110-
<ContentPage xmlns="http://xamarin.com/schemas/2014/forms"
111-
xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
112-
xmlns:local="clr-namespace:Sample.InputKit"
113-
xmlns:input="clr-namespace:Plugin.InputKit.Shared.Controls;assembly=Plugin.InputKit"
114-
x:Class="Sample.InputKit.MainPage">
115-
116-
<StackLayout Spacing="12" Padding="30,0">
83+
## RadioButton
11784

118-
<input:RadioButtonGroupView>
119-
<input:RadioButton Text="Option 1" />
120-
<input:RadioButton Text="Option 2" />
121-
<input:RadioButton Text="Option 3" />
122-
<input:RadioButton Text="Option 4" />
123-
</input:RadioButtonGroupView>
85+
A radio button control that is useful, customizable, full-featured, fully-bindable and easy to use.
12486

125-
</StackLayout>
126-
127-
</ContentPage>
128-
```
87+
- [Sample Code](sandbox/SandboxMAUI/Pages/RadioButtonPage.xaml)
88+
- [Documentation](docs/Controls/RadioButton.md)
12989

13090
<table>
13191
<tr>
13292
<td>
133-
<img src="https://raw.githubusercontent.com/enisn/Xamarin.Forms.InputKit/develop/shreenshots/radiobuttons_android.gif" alt="Xamarin Forms Radio Button Input Kit Enis Necipoğlu" width="270" height="480" class="aligncenter size-medium wp-image-1001" />
93+
<img src="docs/images/radiobutton-dark-windows.gif" alt="Xamarin Forms MAUI RadioButton Input Kit Enis Necipoglu" width="270" class="aligncenter size-medium wp-image-996" />
94+
</td>
95+
96+
<td>
97+
<img src="docs/images/radiobutton-light-android.gif" alt="Xamarin Forms CheckBox Input Kit Enis Necipoglu" width="270" class="aligncenter size-medium wp-image-996" />
13498
</td>
13599
<td>
136-
<img src="https://raw.githubusercontent.com/enisn/Xamarin.Forms.InputKit/develop/shreenshots/radiobuttons_ios.png" alt="Xamarin Forms Radio Button Input Kit Enis Necipoğlu" width="270" height="480" class="aligncenter size-medium wp-image-1001" />
100+
<img src="https://raw.githubusercontent.com/enisn/Xamarin.Forms.InputKit/develop/shreenshots/radiobuttons_ios.png" alt="Xamarin Forms Radio Button Input Kit Enis Necipoğlu" width="270" class="aligncenter size-medium wp-image-1001" />
137101
</td>
138102
</tr>
139103
</table>
140-
<h4>PROPERTIES:</h4>
141-
<h5>RadioButtonGroupView</h5>
142-
<ul>
143-
<li><strong>SelectedIndex:</strong> <em>(int)</em> Gets or Sets selected radio button inside itself by index</li>
144-
<li><strong>SelectedItem:</strong> <em>(object)</em> Gets or Sets selected radio button inside itself by Value</li>
145-
</ul>
146-
<h5>RadioButton</h5>
147-
<ul>
148-
<li><strong>Clicked:</strong> <em>(event)</em> Invokes when clikced</li>
149-
<li><strong>ClickCommand:</strong> <em>(int)</em> Bindable Command, Executes when clicked</li>
150-
<li><strong>Value:</strong> <em>(object)</em> A value keeps inside and groupview returns that value as SelectedItem</li>
151-
<li><strong>IsChecked:</strong> <em>(bool)</em> Gets or Sets that radio button selected</li>
152-
<li><strong>Text:</strong> <em>(string)</em> Text to display near of Radio Button</li>
153-
<li><strong>TextFontSize:</strong> <em>(double)</em> Fontsize of Text</li>
154-
<li><strong>Color:</strong> <em>(Color)</em> Color of selected radio button dot</li>
155-
<li><strong>TextColor:</strong> <em>(Color)</em> Color of Text</li>
156-
</ul>
157-
<hr />
158104
<hr />
159105

160106

161-
<h2>AutoCompleteEntry ( Experimental )</h2>
162-
<p>Alternative picker with dropdown menu.
163-
</p>
164-
<h4>SAMPLE:</h4>
107+
## AutoCompleteEntry
108+
Alternative picker with dropdown menu. _( Xamarin Forms only )_
165109

166110
```xaml
167111
<input:AutoCompleteEntry Title="Type something below:"
@@ -195,8 +139,8 @@
195139
To be added...
196140
<hr />
197141

198-
<h2>Dropdown ( Experimental * Not Stable * )</h2>
199-
<p>Alternative picker with dropdown menu.
142+
<h2>Dropdown ( Experimental )</h2>
143+
<p>Alternative picker with dropdown menu. _(Xamarin Forms only)_
200144
</p>
201145
<h4>SAMPLE:</h4>
202146

@@ -225,66 +169,16 @@ To be added...
225169
<li><strong>IsRequired:</strong> <em>(bool)</em> IValidation implementation. Same with IsAnnotated</li>
226170
</ul>
227171

228-
To be adde...
229172
<hr />
230173

231174

175+
## Advanced Entry
176+
This entry has many features to develop your applications quickly. When this entry is completed, it finds the next entry in the Parent layout and focuses it. AdvancedEntry contains a validation system inside it. You can set some properties to validate it and you can handle whether all your entries are validated or not with **FormView**.
177+
You can set validation message and AnnotatinColor. Entry will automatically display your message when it's not validated.
232178

233-
<hr />
234-
<h2>Advanced Entry</h2>
235-
<p>This entry has many features to develop your applications quickly. When this entry completed, it finds next entry in Parent layout and focus it. AdvancedEntry contains validation system inside it. You can set some properties to validate it and you can handle all your entries is validated or not with **FormView**.
236-
You can set validation message and AnnotatinColor. Entry will automaticly display your message when it's not validated.
237-
</p>
238-
<h4>SAMPLE:</h4>
179+
- [Sample Code](sandbox/SandboxMAUI/Pages/AdvancedEntryPage.xaml)
180+
- [Documentation](docs/Controls/AdvancedEntry.md)
239181

240-
```xaml
241-
<StackLayout Padding="30">
242-
<Label Text="You can see FormView Below:"/>
243-
<BoxView HeightRequest="1" Color="LightGray" />
244-
<input:FormView IsValidated="{Binding IsValidated}">
245-
246-
<input:AdvancedEntry
247-
Text="{Binding Email}"
248-
IsRequired="True"
249-
Title="Place your email below:"
250-
Annotation="Email"
251-
Placeholder="[email protected]"
252-
AnnotationColor="Accent"
253-
ValidationMessage="Please type a valid email address"
254-
IconImage="ic_email_black_24dp.png"
255-
MinLength="10"
256-
MaxLength="50"
257-
/>
258-
259-
<input:AdvancedEntry
260-
Text="{Binding NameSurname}"
261-
IsRequired="True"
262-
Title="Place your name below:"
263-
Annotation="NameSurname"
264-
Placeholder="John Doe"
265-
AnnotationColor="Accent"
266-
ValidationMessage="Please type your name correctly"
267-
IconImage="ic_account_circle_black_24dp.png"
268-
MinLength="5"
269-
MaxLength="30"
270-
/>
271-
272-
<input:AdvancedEntry
273-
Text="{Binding Phone}"
274-
IsRequired="True"
275-
Title="Place your phone number below:"
276-
Annotation="Phone"
277-
Placeholder="5439998877"
278-
AnnotationColor="Accent"
279-
ValidationMessage="Please type your phone number correctly"
280-
IconImage="ic_account_circle_black_24dp.png"
281-
MaxLength="10"
282-
/>
283-
284-
<Button Command="{Binding SubmitCommand}" Text="Submit" BackgroundColor="Accent" CornerRadius="20" TextColor="White" />
285-
</input:FormView>
286-
</StackLayout>
287-
```
288182
<a href="#"><img src="https://media.giphy.com/media/1zl0u7O2doNolIXnrT/giphy.gif" width="270" height="480" alt="Xamarin Forms Slider Sticky Label" class="aligncenter size-medium" /></a>
289183

290184
<h4>PROPERTIES:</h4>
@@ -346,8 +240,9 @@ You can set validation message and AnnotatinColor. Entry will automaticly displa
346240
</ul>
347241
<hr />
348242

349-
<h2>SelectionView</h2>
350-
<p>Presents options to user to choose. This view didn't created to static usage. You should Bind a model List as ItemSource, or if you don't use MVVM you can set in page's cs file like below. (You can override ToString method to fix display value or I'll add displayMember property soon.)</p>
243+
## SelectionView
244+
Presents options to user to choose. This view didn't created to static usage. You should Bind a model List as ItemSource, or if you don't use MVVM you can set in page's cs file like below. (You can override ToString method to fix display value or I'll add displayMember property soon.)</p>
245+
351246
<h4>SAMPLE:</h4>
352247

353248
```xaml

0 commit comments

Comments
 (0)