Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jamesmontemagno/ImageCirclePlugin
Circle Images for your Xamarin.Forms Applications
https://github.com/jamesmontemagno/ImageCirclePlugin
Last synced: 29 days ago
JSON representation
Circle Images for your Xamarin.Forms Applications
- Host: GitHub
- URL: https://github.com/jamesmontemagno/ImageCirclePlugin
- Owner: jamesmontemagno
- License: mit
- Archived: true
- Created: 2016-06-20T22:38:43.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-10-05T19:25:50.000Z (about 4 years ago)
- Last Synced: 2024-10-08T12:11:51.306Z (2 months ago)
- Language: C#
- Size: 1010 KB
- Stars: 239
- Watchers: 24
- Forks: 68
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-xamarin-forms - ImageCircle ★241
- awesome-xamarin - Circle Image Control - Simple but elegant way of display circle images in your Xamarin.Forms projects. (Xamarin.Forms)
README
## Circle Image Control Plugin for Xamarin.Forms
A simple and elegant way of displaying circle images in your Xamarin.Forms projects.
Be sure to change the DLL name to:
```xml
xmlns:controls="clr-namespace:ImageCircle.Forms.Plugin.Abstractions;assembly=ImageCircle.Forms.Plugin"
```
#### Setup
* Available on NuGet: [](https://www.nuget.org/packages/Xam.Plugins.Forms.ImageCircle/)
* [https://www.nuget.org/packages/Xam.Plugins.Forms.ImageCircle](https://www.nuget.org/packages/Xam.Plugins.Forms.ImageCircle)
* Install into your PCL project and Client projects.
* Build status: 
In your iOS, Android, and Windows projects call:
```csharp
Xamarin.Forms.Init(); //platform specific init
ImageCircleRenderer.Init();
```
You must do this AFTER you call `Xamarin.Forms.Init();`
**Platform Support**
|Platform|Version|
| ------------------- | :------------------: |
|Xamarin.iOS|iOS 7+|
|Xamarin.Android|API 14+|
|Windows 10 UWP|10+|
#### Usage
Instead of using an Image simply use a CircleImage instead!
You **MUST** set the width & height requests to the same value and you will want to use `Aspect.AspectFill` for the value of the `Aspect` property. Here is a sample:
```csharp
new CircleImage
{
BorderColor = Color.White,
BorderThickness = 3,
HeightRequest = 150,
WidthRequest = 150,
Aspect = Aspect.AspectFill,
HorizontalOptions = LayoutOptions.Center,
Source = UriImageSource.FromUri(new Uri("http://upload.wikimedia.org/wikipedia/commons/5/55/Tamarin_portrait.JPG"))
}
```
**XAML:**
First add the xmlns namespace:
```xml
xmlns:controls="clr-namespace:ImageCircle.Forms.Plugin.Abstractions;assembly=ImageCircle.Forms.Plugin"
```
Then add the xaml:
```xml
55
75
55
75
```
**Bindable Properties**
You are able to set the ```BorderColor``` to a Forms.Color to display a border around your image and also ```BorderThickness``` for how thick you want it.
You can also set ```FillColor``` to the Forms.Color to fill the circle. DO NOT set ```BackgroundColor``` as that will be the square the entire image takes up.
These are supported in iOS, Android, WinRT, and UWP (not on Windows Phone 8 Silverlight).
### Final Builds
For linking you may need to add:
#### Android:
```
ImageCircle.Forms.Plugin;
```
#### iOS:
```
--linkskip=ImageCircle.Forms.Plugin
```
#### UWP:
Be sure to read through the [troubleshooting for UWP with .NET Native](https://developer.xamarin.com/guides/xamarin-forms/platform-features/windows/installation/universal/#Troubleshooting) for your final package. You should add the package to the Init call of Xamarin.Forms such as:
```csharp
var rendererAssemblies = new[]
{
typeof(ImageCircleRenderer).GetTypeInfo().Assembly
};
Xamarin.Forms.Forms.Init(e, rendererAssemblies);
```
#### License
Licensed under MIT, see license file
### Want To Support This Project?
All I have ever asked is to be active by submitting bugs, features, and sending those pull requests down! Want to go further? Make sure to subscribe to my weekly development podcast [Merge Conflict](http://mergeconflict.fm), where I talk all about awesome Xamarin goodies and you can optionally support the show by becoming a [supporter on Patreon](https://www.patreon.com/mergeconflictfm).