Merge pull request #2 from bartlannoeye/Documentation

Documentation
This commit is contained in:
Jim Bennett 2017-02-04 11:02:41 +13:00 коммит произвёл GitHub
Родитель 0d395c443b 8b0aadc268
Коммит 7b34c9107d
12 изменённых файлов: 113 добавлений и 1 удалений

Просмотреть файл

@ -1,7 +1,7 @@
Forms Community Toolkit
===========
The Forms Community Toolkit is a collection of helper functions, custom controls, and app services. It simplifies and demonstrates common developer tasks building iOS, Android, and UWP apps with Xamarin.Forms
The Forms Community Toolkit is a collection of helper functions, custom controls, and app services. It simplifies and demonstrates common developer tasks building iOS, Android, and UWP apps with Xamarin.Forms.
## Build status

Просмотреть файл

@ -0,0 +1,55 @@
# CapitalizeKeyboardEffect
The **CapitalizeKeyboardEffect** enforces caps on the keyboard for an Entry control.
## Syntax
You can either use the capitalize effect from your XAML code:
```xaml
<Entry Placeholder="start typing..." VerticalOptions="Start">
<Entry.Effects>
<effects:CapitalizeKeyboardEffect />
</Entry.Effects>
</Entry>
```
or directly from code:
```csharp
MyEntry.Effects.Add(Effect.Resolve("FormsCommunityToolkit.Effects.CapitalizeKeyboardEffect"));
```
[CapitalizeKeyboardEffect Sample Page Source](https://github.com/FormsCommunityToolkit/Effects/blob/master/samples/Effects.SampleApp/Views/EntryPage.xaml)
## Properties
| Property Name | Type | Description |
| --- | --- | --- |
| Value | double | Some property description |
## Example Image
iOS
![CapitalizeKeyboardEffect animation](../Media/ClearEntryAndAllCaps_thumb.gif "CapitalizeKeyboardEffect")
Android
![CapitalizeKeyboardEffect animation](../Media/AndroidEffects_thumb.gif "CapitalizeKeyboardEffect")
## Requirements (Windows 10 Device Family)
| [Device family](http://go.microsoft.com/fwlink/p/?LinkID=526370) | Universal, [Windows 10 Anniversary SDK 14393](https://blogs.windows.com/windowsexperience/2016/07/18/build14393/) 10.0.14393.0 |
| --- | --- |
| Namespace | Microsoft.Toolkit.Uwp.UI.Animations |
## API source code
* [Android source code](https://github.com/FormsCommunityToolkit/Effects/blob/master/src/Effects.Android/Effects/CapitalizeKeyboardEffect.cs)
* [iOS source code](https://github.com/FormsCommunityToolkit/Effects/blob/master/src/Effects.iOS/Effects/CapitalizeKeyboardEffect.cs)
* [UWP source code](https://github.com/FormsCommunityToolkit/Effects/blob/master/src/Effects.UWP/Effects/CapitalizeKeyboardEffect.cs)

0
docs/Animations/todo.md Normal file
Просмотреть файл

0
docs/Behaviors/todo.md Normal file
Просмотреть файл

0
docs/Controls/todo.md Normal file
Просмотреть файл

0
docs/Converters/todo.md Normal file
Просмотреть файл

Просмотреть файл

@ -0,0 +1,43 @@
# CapitalizeKeyboardEffect
The **CapitalizeKeyboardEffect** enforces caps on the keyboard for an Entry control.
## Syntax
You can either use the capitalize effect from your XAML code:
```xaml
<Entry Placeholder="start typing..." VerticalOptions="Start">
<Entry.Effects>
<effects:CapitalizeKeyboardEffect />
</Entry.Effects>
</Entry>
```
or directly from code:
```csharp
MyEntry.Effects.Add(Effect.Resolve("FormsCommunityToolkit.Effects.CapitalizeKeyboardEffect"));
```
[CapitalizeKeyboardEffect Sample Page Source](https://github.com/FormsCommunityToolkit/Effects/blob/master/samples/Effects.SampleApp/Views/EntryPage.xaml)
## Example Image
iOS
![CapitalizeKeyboardEffect animation](../Media/ClearEntryAndAllCaps_thumb.gif "CapitalizeKeyboardEffect")
Android
![CapitalizeKeyboardEffect animation](../Media/AndroidEffects_thumb.gif "CapitalizeKeyboardEffect")
## API source code
* [Android source code](https://github.com/FormsCommunityToolkit/Effects/blob/master/src/Effects.Android/Effects/CapitalizeKeyboardEffect.cs)
* [iOS source code](https://github.com/FormsCommunityToolkit/Effects/blob/master/src/Effects.iOS/Effects/CapitalizeKeyboardEffect.cs)
* [UWP source code](https://github.com/FormsCommunityToolkit/Effects/blob/master/src/Effects.UWP/Effects/CapitalizeKeyboardEffect.cs)

Двоичные данные
docs/Effects/Media/AndroidEffects_thumb.gif Normal file

Двоичный файл не отображается.

После

Ширина:  |  Высота:  |  Размер: 1.0 MiB

Двоичные данные
docs/Effects/Media/ClearEntryAndAllCaps_thumb.gif Normal file

Двоичный файл не отображается.

После

Ширина:  |  Высота:  |  Размер: 1.3 MiB

13
docs/Effects/index.md Normal file
Просмотреть файл

@ -0,0 +1,13 @@
# Effects
Effects allow the native controls on each platform to be customized, and are typically used for small styling changes.
The Forms Community Toolkit has effects for these types of controls:
- Entry
- Label
- Picker
- Switch
- View
More info on effects can be found in the [official Xamarin documentation](https://developer.xamarin.com/guides/xamarin-forms/effects/introduction/).

0
docs/Gestures/todo.md Normal file
Просмотреть файл

1
docs/index.md Normal file
Просмотреть файл

@ -0,0 +1 @@
The Forms Community Toolkit is a collection of helper functions, custom controls, and app services. It simplifies and demonstrates common developer tasks building iOS, Android, and UWP apps with Xamarin.Forms.