https://github.com/marcbruins/ttgsnackbar-xamarin-ios

https://github.com/marcbruins/ttgsnackbar-xamarin-ios

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/marcbruins/ttgsnackbar-xamarin-ios
• Owner: MarcBruins
• License: mit
• Created: 2016-04-28T17:01:07.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-01-25T14:04:13.000Z (almost 6 years ago)
• Last Synced: 2024-10-06T09:30:46.936Z (3 months ago)
• Language: C#
• Size: 124 KB
• Stars: 47
• Watchers: 2
• Forks: 19
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# TTGSnackbar-Xamarin-iOS

A C#/Xamarin based implementation of the Android Snackbar for iOS.

![Screenshot](https://user-images.githubusercontent.com/1341446/51748842-90a5fa00-20a5-11e9-819f-8f085de22c7b.png)

# About

TTGSnackbar is useful for showing a brief message at the bottom of the screen with an action button.  

It appears above all other elements on screen and only one can be displayed at a time.  

It disappears after a timeout or after user click the action button.

### Requirement

iOS 8+

# Usage

## Show a simple message

![Example](https://user-images.githubusercontent.com/1341446/51748937-ce0a8780-20a5-11e9-8202-a165f1b9ac04.png)

```c

var snackbar = new TTGSnackbar("Message", TTGSnackbarDuration.Short);

snackbar.Show();

```

## Show a simple message with an action button

![Example](https://user-images.githubusercontent.com/1341446/51748962-ec708300-20a5-11e9-8364-994ee351d6aa.png)

```c

var snackbar = new TTGSnackbar("Message", TTGSnackbarDuration.Long, "Cancel", () => { Console.WriteLine("clicked");});   

snackbar.Show();

```

## Show a simple message with a long running action

![Example](https://user-images.githubusercontent.com/1341446/51748979-fe522600-20a5-11e9-9a65-3235c7759da3.png)

```c

var snackbar = new TTGSnackbar("Message", TTGSnackbarDuration.Forever, "Cancel", async (s) => {

				await Task.Delay(3000);

				s.dismiss();

			});

snackbar.Show();

```

## Show a simple message with an icon image

![Example](https://user-images.githubusercontent.com/1341446/51749009-132eb980-20a6-11e9-81b8-a1cc922d53b1.png)

```c

var snackbar = new TTGSnackbar("Message", TTGSnackbarDuration.Long, "Cancel", () => { Console.WriteLine("clicked");});

snackbar.Icon = UIImage.FromBundle("EmojiCool");

snackbar.Show();

```

 +

 

## Show a simple message with two action buttons

![Example](https://user-images.githubusercontent.com/1341446/51749034-22156c00-20a6-11e9-8ccb-6271532adf97.png)

```c

var snackbar = new TTGSnackbar("Message", TTGSnackbarDuration.Middle);

// Action 1

snackbar.ActionText = "Yes";

snackbar.ActionTextColor = UIColor.Green;

snackbar.ActionBlock = (t) => { Console.WriteLine("clicked yes"); };

// Action 2

snackbar.SecondActionText = "No";

snackbar.SecondActionTextColor = UIColor.Purple;

snackbar.SecondActionBlock = (t) => { Console.WriteLine("clicked no"); };

snackbar.Show();

```

# Customization

### Message

`message: String` defines the message to diaplay.

### Message text color

`messageTextColor: UIColor` defines the message text color.

### Message text font

`messageTextFont: UIFont` defines the message text font.

### Display duration

`duration: TTGSnackbarDuration`defines the display duration.  

`TTGSnackbarDuration` : `Short`, `Middle`, `Long` and `Forever`.  

When you set `Forever`, the snackbar will show an activity indicator after user click the action button and you must dismiss the snackbar manually.

### Action title

`actionText: String` defines the action button title.

### Action title color

`actionTextColor: UIColor` defines the action button title color.

### Action title font

`actionTextFont: UIFont` defines the action button title font.

### Action callback

`actionBlock: TTGActionBlock?` will be called when user click the action button.

```

// TTGActionBlock definition.

public Action ActionBlock

```

### Second action title, color, font and callback

```

secondActionText: String  

secondActionTextColor: UIColor  

secondActionTextFont: UIFont  

secondActionBlock: TTGActionBlock?

```

### Dismiss callback

`dismissBlock: TTGDismissBlock?` will be called when snackbar  dismiss automatically or when user click action button to dismiss the snackbar.

```

// TTGDismissBlock definition.

public typealias TTGDismissBlock = (snackbar: TTGSnackbar) -> Void

```

### Animation type

`animationType: TTGSnackbarAnimationType` defines the style of snackbar when it show and dismiss.  

`TTGSnackbarAnimationType` : `FadeInFadeOut`, `SlideFromBottomToTop`, `SlideFromBottomBackToBottom`, `SlideFromLeftToRight`,  `SlideFromRightToLeft` and `Flip`.

The default value of `animationType` is `SlideFromBottomBackToBottom`, which is the same as Snackbar in Android.

### Animation duration

`animationDuration: NSTimeInterval` defines the duration of show and hide animation.

### Margins

`leftMargin: CGFloat`, `rightMargin: CGFloat` and `bottomMargin: CGFloat` define the margins of snackbar.

### Snackbar height

`height: CGFloat` defines the height of snackbar.

### Corner radius

`cornerRadius: CGFloat` defines the corner radius of snackbar.

# Credits

This is a port of https://github.com/zekunyan/TTGSnackbar/. All credits go to zekunynan.