Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/joetomkinson/xama.jtports.showcaseview

Xamarin.Android Native showcase view.
https://github.com/joetomkinson/xama.jtports.showcaseview

android-development android-ui animation circular-reveal material-design showcaseview showcaseview-library xamarin-android xamarin-plugin

Last synced: about 1 month ago
JSON representation

Xamarin.Android Native showcase view.

Awesome Lists containing this project

README

        

# Xamarin ShowcaseView

[![platform](https://img.shields.io/badge/platform-Xamarin.Android-brightgreen.svg)](https://www.xamarin.com/)
[![API](https://img.shields.io/badge/API-10%2B-orange.svg?style=flat)](https://android-arsenal.com/api?level=10s)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![NuGet](https://img.shields.io/nuget/v/xamarin.android.showcaseview.svg?label=NuGet)](https://www.nuget.org/packages/xamarin.android.showcaseview/)
![Build: Passing](https://img.shields.io/badge/Build-Passing-green.svg)

## Installation

![](https://github.com/DigitalSa1nt/Xamarin.ShowcaseView/blob/master/images/nugetIcon.png)

Simply install the [NuGet package](https://www.nuget.org/packages/Xama.JTPorts.ShowcaseView/) into your Xamarin.Android application and use as below.

This library now supports AndroidX libraries rather than v7 support libraries so it may ask you to install these dependencies in order to carry on using this control.

Package Manager:
> Install-Package Xama.JTPorts.ShowcaseView -Version 1.0.1

.NET CLI:
> dotnet add package Xama.JTPorts.ShowcaseView --version 1.0.1

### Namespace: Xama.JTPorts.ShowcaseView

_Xamarin.Android_ Native showcase view. An easy-to-use customizable show case view with circular reveal animation, ported from [FancyShowCaseView](https://github.com/faruktoptas/FancyShowCaseView) by [Faruk Toptaş](https://github.com/faruktoptas)

This is a ported build, converted from Java to C# for use with the Xamarin MonoFramework. There are only a couple of new additions from the original library currently.

# Features

## Ported Functionality
- Circular reveal animation (API Level 21+).
- Custom Background colors with opaque variances.
- Circle and Rounded Rectangle focus shapes.
- Custom title styles and position.
- Custom view inflation.
- Custom enter/exit animations.
- Chaining multiple Showcase view instances.
- Showing only one time.

## Additional Functionality
- Auto move-on for showcase queues.
- Auto dismiss for showcases.

# Customary sample GIF

![!gif](https://github.com/DigitalSa1nt/Xamarin.ShowcaseView/blob/master/images/Sample.gif)


# Basic usage
```
ShowCaseView showcase = new ShowCaseView.Builder()
.Context(this)
.CloseOnTouch(true)
.FocusOn(ControlToFocusOn)
.BackgroundColor(Color.DarkRed)
.FocusBorderColor(Color.White)
.FocusBorderSize(15)
.Title("Showcase text")
.FocusCircleRadiusFactor(1.5)
.Build();

showcase.Show();
```

# Contribution

More than happy for people to raise issues, or submit pull requests on adjustments, optimisations or improvements to the existing port. It's been migrated over to AndroidX support libraries so there's room to improve the ways the UI animations are created potentially.

# Support πŸ’Ž

If you want to support the work that I do and you find any of these libraries useful? Consider supporting it by joining [**stargazers**](https://github.com/DigitalSa1nt/Xama.JTPorts.ShowcaseView/stargazers) for this repository. :telescope: :stars:


or alternatively if you want to you can also buy me a coffee.

Buy Me A Coffee
-----
_You know, only if you want to._