Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ieuanwalker/xamarin.forms.statebutton

With this control, you are able to create any style of button. This is possible as it acts as a wrapper to your XAML and provides you the events/ commands and properties to bind to.
https://github.com/ieuanwalker/xamarin.forms.statebutton

button control custom navigation nuget ui ui-component user-interface ux xamarin xamarin-forms

Last synced: about 2 months ago
JSON representation

With this control, you are able to create any style of button. This is possible as it acts as a wrapper to your XAML and provides you the events/ commands and properties to bind to.

Host: GitHub
URL: https://github.com/ieuanwalker/xamarin.forms.statebutton
Owner: IeuanWalker
Created: 2021-04-21T15:14:50.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2024-10-18T06:26:56.000Z (3 months ago)
Last Synced: 2024-11-13T23:33:05.645Z (about 2 months ago)
Topics: button, control, custom, navigation, nuget, ui, ui-component, user-interface, ux, xamarin, xamarin-forms
Language: C#
Homepage:
Size: 23.1 MB
Stars: 14
Watchers: 3
Forks: 4
Open Issues: 3
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        | :warning:        | This NuGet/ repo is now in maintenance mode and support will end once xamarin.forms is no longer supported. _Bug fixes only._  MAUI repo - https://github.com/IeuanWalker/Maui.StateButton  |

|---------------|:------------------------|

# Xamarin.Forms.StateButton  [![Nuget](https://img.shields.io/nuget/v/IeuanWalker.StateButton)](https://www.nuget.org/packages/IeuanWalker.StateButton) [![Nuget](https://img.shields.io/nuget/dt/IeuanWalker.StateButton)](https://www.nuget.org/packages/IeuanWalker.StateButton) 

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FIeuanWalker%2FXamarin.Forms.StateButton.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FIeuanWalker%2FXamarin.Forms.StateButton?ref=badge_shield)

With this control you are able to create any style of button.

This is possible as it acts as a wrapper to your XAML and provides you the events/ commands and properties to bind too.

## How to use it?

Install the [NuGet package](https://www.nuget.org/packages/IeuanWalker.StateButton) into your shared project project

```

Install-Package IeuanWalker.StateButton

```

For iOS the control needs to be initialised in you `AppDelegate.cs` before `Forms.Init();`

```csharp

using StateButton.iOS;

.............

StateButtonRenderer.Init();

```

## What can I do with it?

### Properties

| Property | What it does | Extra info |

|---|---|---- |

| State | This changes based on the button state. i.e. `Pressed`, `NotPressed` | Default state is `NotPressed` 
  
 The binding mode is `OneWayToSource` so it can only be controlled via this control. |

### Events

| Event | What it does |

|---|---|

| Clicked | Triggerd when the button is pressed and released |

| Pressed | Triggerd when the button is pressed |

| Released | Triggerd when the button is released |

### Commands

| Command | What it does |

|---|---|

| ClickedCommand | Triggerd when the button is pressed and released |

| PressedCommand | Triggerd when the button is pressed |

| ReleasedCommand | Triggerd when the button is released |

## How to style the button for different states

There are 2 ways to style the button -

- [DataTriggers](https://docs.microsoft.com/en-us/xamarin/xamarin-forms/app-fundamentals/triggers#data-triggers)

- [VisualStateManager](https://docs.microsoft.com/en-us/xamarin/xamarin-forms/user-interface/visual-state-manager) _(not recommended)_

### DataTriggers

Simply add a DataTrigger to any element and bind it to the `State` property of the button - 

```xaml

    

        

            

                

                    

                

            

            

                

                    

                        

                    

                

            

        

    

```

### VisualStateManager

You can also use the VisualStateManager, but this is NOT RECOMENDED due to a bug in Xamarin.forms that causes a `NullReferenceException` when `TargetName` property is used, heres a link to the bug - https://github.com/xamarin/Xamarin.Forms/issues/10710.

If you still want to use it -

```xaml

    

        

            

        

    

    

        

            

                

                    

                

            

            

                

                    

                

            

        

    

```

## Examples

| Designs from a production app | Complex example |

|------|------|

|![Production example of control](/Docs/prodExample.gif)| 
This shows the StateButton as the wrapper for a card. When the card is pressed or clicked then the title is set to bold and the border goes darker.
  The card also shakes when clicked, this shows that it works with the [AnimationBehaviours from XamarinCommunityToolkit](https://github.com/xamarin/XamarinCommunityToolkit). 
 It also shows that it works with nested TapGestureRecognizer, XF native button and nested StateButton - 
 ![Complex example of control](/Docs/ComplexExample.gif)|

## License

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FIeuanWalker%2FXamarin.Forms.StateButton.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FIeuanWalker%2FXamarin.Forms.StateButton?ref=badge_large)