Skip to content

Commit

Permalink
Updated README (HorusSoftwareUY#1)
Browse files Browse the repository at this point in the history
* Updated README

* Updated README

* Updated README

* Updated Readme
  • Loading branch information
seba47 authored and AgustinBonilla committed Sep 16, 2019
1 parent 1a8c115 commit cea14e4
Showing 1 changed file with 25 additions and 19 deletions.
44 changes: 25 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# Xamarin.Forms.Skeleton

# Xamarin.Forms.Skeleton
<img src="https://raw.githubusercontent.com/HorusSoftwareUY/Xamarin.Forms.Skeleton/master/icon.png" width="128">

The new loading approach for cool apps in Xamarin Forms
The latest trend on loading approaches for Xamarin Forms apps. Skeleton can be easily implemented on each view contained in your Xaml.

## Sample

<img src="https://github.com/HorusSoftwareUY/Xamarin.Forms.Skeleton/blob/master/screenshots/iOS.gif" width="300">

## Setup
* Available on NuGet: [Xamarin.Forms.Skeleton](https://www.nuget.org/packages/Xamarin.Forms.Skeleton/) [![NuGet](https://img.shields.io/nuget/v/Xamarin.Forms.Skeleton.svg?label=NuGet)](https://www.nuget.org/packages/Xamarin.Forms.Skeleton/)
* Install into your Core project and Client projects.
* Install into your Core and Client projects.

**Platform Support**

Expand All @@ -24,7 +27,7 @@ You must add this namespace to your xaml files:
xmlns:extension="clr-namespace:Xamarin.Forms.Skeleton;assembly=Xamarin.Forms.Skeleton"
```

Add the following properties to generate a load animation:
Add the following properties to generate a loading animation:

```XML
<ListView RowHeight="109"
Expand All @@ -38,7 +41,7 @@ Add the following properties to generate a load animation:
extension:Skeleton.Animation="Fade" />
```

Add the following properties to set a load background color:
Add the following properties to set a loading animation with a specific background color:

```XML
<Label Text="{Binding Title}"
Expand All @@ -51,42 +54,45 @@ Add the following properties to set a load background color:
### Properties

#### IsParent (Boolean)
- Indicates if it is a parent control that has skeleton children controls.
- Indicates if it is a parent control which has skeleton children controls.
- The default value is false.

#### IsBusy (Boolean)
- Indicates if the control is in busy state.
- Indicates if the control is busy in a loading state.
- The default value is false.

#### BackgroundColor (Color)
- Background color of the control in busy state.
- Control background color when is busy.
- The default value is the xamarin forms default color.

#### Hide (Boolean)
- Indicates if the control is hide in busy state.
- Indicates if the control is hide when is busy.
- The default value is false.

#### Animation (AnimationTypes)
- Control animation in busy state.
- Possible values: None, Fade and Beat.
- Control animation when is busy.
- Possible values: None, Fade and Beat (working in new Animations for the next release)
- The default value is None.

#### AnimationInterval (Int)
- Animation interval in busy state.
- The value is in milliseconds.
- Animation interval when is busy.
- Value in milliseconds.
- The default value is 500.

#### AnimationParameter (Double?)
- Animation parameter used to modify the animation.
- Animation parameter to modify the animation.
- The default value is null.

## Sample

<img src="https://github.com/HorusSoftwareUY/Xamarin.Forms.Skeleton/blob/master/screenshots/iOS.gif" width="300">

## Demo
https://github.com/HorusSoftwareUY/Xamarin.Forms.Skeleton/tree/master/SkeletonExample

## Roadmap
- New animations
- Automatic ItemsSource population (fake data) for skeleton preview in: ListView, CollectionView, Repeater, etc.

## Developed by
<a href="http://horus.com.uy" ><img src="https://horus.com.uy/img/logo_horus.png" width="128"></a>

## Contributions
Contributions are welcome! If you find a bug want a feature added please report it.

Expand Down

0 comments on commit cea14e4

Please sign in to comment.