Skip to content

Latest commit

 

History

History
279 lines (179 loc) · 9.13 KB

README.md

File metadata and controls

279 lines (179 loc) · 9.13 KB
Raw

Xamarin Forms Labs

Xamarin Forms Labs is a open source project that aims to provide a powerful and cross platform set of controls tailored to work with Xamarin Forms.

Call for action for all Xamarin Developers, embrace this project and share your controls and services with the community, add your own control to the toolkit.

Important for developers The master branch is the current development branch and the next release for 2.0. The v.1.2 is the stable branch.

Available controls

Available services (Beta)

  • Accelerometer
  • Cache
  • Camera (Picture and Video picker, Take Picture, Take Video)
  • Device (battery info, device info, sensors, accelerometers)
  • Display
  • Geolocator
  • Phone Service (cellular network info, make phonecalls)
  • SoundService
  • Text To Speech

Available Mvvm helpers (Beta)

  • ViewModel (navigation, isbusy)
  • ViewFactory
  • IOC
  • IXFormsApp (application events)

Available Plugins (Beta)

  • Serialization (ServiceStackV3, ProtoBuf, JSON.Net)
  • Caching (SQLLiteSimpleCache)
  • Dependency Injection containers (TinyIOC, Autofac, NInject, SimpleInjector, Unity)
  • Web (RestClient)
  • Charting (Line, Bar & Pie) (Alpha)

HOW-TO

We are working in a great wiki on how to use the controls and services.

https://github.com/XForms/Xamarin-Forms-Labs/wiki

Using the MVVM Helpers

ViewFactory Coming soon

Using the controls

Add Xamarin.Forms.Labs.Controls reference to your projects , main pcl, ios, android, and wp.

Xaml :

Reference the assembly namespace

 xmlns:controls="clr-namespace:Xamarin.Forms.Labs.Controls;assembly=XLabs.Forms"

Render your control:

 <controls:ImageButton Text="Twitter" BackgroundColor="#01abdf" TextColor="#ffffff" HeightRequest="75" WidthRequest="175" Image="icon_twitter" Orientation="ImageToLeft"  ImageHeightRequest="50" ImageWidthRequest="50" />

Or from your codebehind:

var button = new ImageButton() {
			ImageHeightRequest = 50,
			ImageWidthRequest = 50,
			Orientation = Orientation.ImageToLeft,
			Source = "icon_twitter.png",
			Text = "Twitter"
		};
stacker.Children.Add (button);

Using the Services

TextToSpeechService

DependencyService.Get<ITextToSpeechService>().Speak(TextToSpeak);

Device

	var device = Resolver.Resolve<IDevice>();
	device.Display; //display information
	device.Battery; //battery information

PhoneService

 	var device = Resolver.Resolve<IDevice>();
	// not all devices have phone service, f.e. iPod and Android tablets
	// so we need to check if phone service is available
	if (device.PhoneService != null)
	{
		device.PhoneService.DialNumber("+1 (855) 926-2746");
	}

Initializing the Services

Do this before using the services

Step 1:

  • iOS => Make sure your AppDelegate inherits from XFormsApplicationDelegate

  • Android => MainActivity inherits from XFormsApplicationDroid

  • Windows Phone => Add this line to your App.cs var app = new XFormsAppWP(); app.Init(this);

Step 2: Initialize the container in your app startup code.

	var container = new SimpleContainer ();
	container.Register<IDevice> (t => AppleDevice.CurrentDevice);
	container.Register<IDisplay> (t => t.Resolve<IDevice> ().Display);
	container.Register<INetwork>(t=> t.Resolve<IDevice>().Network);

	Resolver.SetResolver (container.GetResolver ());

For more info on initialization go to the Labs Wiki

Helper

Current version v1.2.0

v1.2.0 - Xamarin Forms Labs Framework Helper for online use

v1.2.0 - Xamarin.Forms.Labs.chm file for offline use

Based in last developments (master)

Master- Xamarin Forms Labs Framework Helper for online use

Master - Xamarin.Forms.Labs.chm file for offline use

Build the project

To develop on this project, just clone the project to your computer, package restore is enable so build the solution first, if you get any errors try to build each project independently .

Nuget

Main Packages:

Plugins:

  • Caching
  • DI
  • Serialization
  • Cryptography

Contributions:

Other Project Contributions:

  • Xamarin.Mobile

Contribute

Everbody is welcome to contribute with any kind of controls or features at this time. Since there's no oficial releases feel free to submit your playground controls even if they aren't perfect.

Twitter hashtag : #xflabs

CHAT

Xamarin Forms Labs Chat room online on Jabbr

License

License Apache 2.0 more about that in the LICENSE file.