Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robinmanuelthiel/flexbutton
Flexible button control for Xamarin.Forms
https://github.com/robinmanuelthiel/flexbutton
xamarin xamarin-forms
Last synced: 8 days ago
JSON representation
Flexible button control for Xamarin.Forms
- Host: GitHub
- URL: https://github.com/robinmanuelthiel/flexbutton
- Owner: robinmanuelthiel
- License: mit
- Created: 2017-12-17T21:01:48.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-08-04T14:21:54.000Z (over 3 years ago)
- Last Synced: 2024-10-20T12:39:03.595Z (19 days ago)
- Topics: xamarin, xamarin-forms
- Language: C#
- Size: 2.44 MB
- Stars: 240
- Watchers: 18
- Forks: 34
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-xamarin-forms - FlexButton ★247
README
# Xamarin.Forms FlexButton
Flexible button control for Xamarin.Forms with events for different states, color overlays and adjustable shapes and paddings. Supports iOS, Android and UWP.
[](https://www.nuget.org/packages/Forms.Controls.FlexButton/) [](https://dev.azure.com/robinmanuelthiel/Flex%20Button/_build/latest?definitionId=1)
**Features:**
- Adjustable button size and shape
- Icons with adjustable size
- Color overlays for background and icon (normal and pressed state)
- Events for button hold and release
- Round button and Pill button (using corner radius)
- Icon only, text only or mixed mode
- Customizable Borders
- Toggle Mode
## How to use
**Add the [NuGet package](https://www.nuget.org/packages/Forms.Controls.FlexButton/) to the Xamarin.Forms project and all platform projects**
```bash
PM> Install-Package Forms.Controls.FlexButton
```
**[iOS only] Initialize the control**
In your **AppDelegate.cs** call this after `Forms.Init();`
```csharp
FlexButton.Init();
```
**Add the XML namespace**
```xml
xmlns:flex="clr-namespace:Flex.Controls;assembly=Flex"
```
**Add the control**
```xml
```
## Preview
Take a look a the [Demo Project](/Flex.Demo) in this repository for a full sample.
## API Reference
| Property | Default | Description |
|------------------|---------|-------------|
| `Icon` | `null` | Name of the icon file to use |
| `Text` | `string.Empty` | Button text to be displayed |
| `FontSize` | Default | Font size of the button text |
| `ForegroundColor` | `White` | Foreground color overlay for icon and text |
| `BackgroundColor` | `Transparent` | Background color of the button |
| `BorderColor` | `Transparent` | Border color of the button |
| `HighlightForegroundColor` | `White` | Foreground color overlay for icon and text when pressed down |
| `HighlightBackgroundColor` | `Transparent` | Background color of the button when pressed down |
| `HighlightBorderColor` | `Transparent` | Background color of the border when pressed down |
| `CornerRadius` | `0` | Button borner radius |
| `Padding` | 30% of height, 10-30% of width | Inside distance from icon to button borders |
| `IconPadding` | 0 | Additional Padding around the icon to control distance to text |
| `IconOrientation` | `IconOrientation.Left` | Positions the icon on a button that has icon and text |
| `BorderThickness` | `0` | Width of the border in each direction |
| `ToggleMode` | `false` | Sets the button in Toggle Mode |
| `IsToggled` | `false` | Represents the Toggle state, when Toggle Mode is enabled |
| `IconTintEnabled` | `true` | Enables tinting of the icon (Set to false, if your icon is colorized) |
| `HasShadow` | `false` | Enables Xamarin.Forms Frame's Shadow around the button |
| `MaxLines` | `1` | Maximum number of lines for test. Set it to `-1` for flexible amount of lines |
| `AccessibleName` | `string.Empty` | Accessibility Name for Automation |
| Event | Description |
|------------------|---------|
| `TouchedDown` | Triggered, when button got pressed down |
| `TouchedUp` | Triggered, when button got released |
| `TouchCanceled` | Triggered, when moving the pointer out of the button area |
| `Clicked` | Same as `TouchedUp` |
| `Toggled` | Triggered, when the button got toggled on or off |