|ReleasedLast Release||Oct 2015|
Maintained by Sam Stone.
Sam Stone, [email protected]
Snackbars are a Android UI component which present a stylish, actionable alert to the user. Google also uses their own iOS snackbar implementation in some of their iOS apps, such as Gmail.
Snackbar's are useful for presenting a brief message to the user which they can then act on. A common usage pattern is to display a snackbar after a user has performed some destructive action, providing the user with a grace period during which they can undo this action.
The included example project provides a demonstration of SSSnackbar. It displays a tableView containing a shopping list. When an item is deleted from the shopping list, a snackbar is presented allowing the user to undo that deletion.
The shopping list is divided into two sections:
To run the example project, clone the repo, and run
pod install from the Example directory first.
This project is available via CocoaPods. In order to install, simply add
"SSSnackbar" to your Podfile.
You can also integrate SSSnackbar manually by downloading SSSnackbar.h and SSSnackbar.m and adding them to your project.
This project contains a single class:
SSSnackbar objects cannot be "stacked" on-screen. If you display a snackbar while another is on-screen, the currently shown snackbar will be replaced, and it will act as though it had been dismissed after being on-screen for its configured length of time.
All messages sent to
SSSnackbar objects should be sent from the main thread.
New snackbar objects can be created using the following methods:
- (instancetype)initWithMessage:(NSString *)message actionText:(NSString *)actionText duration:(NSTimeInterval)duration actionBlock:(void (^)(SSSnackbar *sender))actionBlock dismissalBlock:(void (^)(SSSnackbar *sender))dismissalBlock + (instancetype)snackbarWithMessage:(NSString *)message actionText:(NSString *)actionText duration:(NSTimeInterval)duration actionBlock:(void (^)(SSSnackbar *sender))actionBlock dismissalBlock:(void (^)(SSSnackbar *sender))dismissalBlock
messageis the text to be displayed on the snackbar's text label.
actionTextis the text to be used as the title for the snackbar's button.
durationis the length of time for which the snackbar should remain on the screen before it is dismissed
actionBlockis a block to be called if the user presses the snackbar's button. Unless the snackbar object is configured otherwise, this block is executed on the main thread.
dismissalBlockis a block to be called when the snackbar is dismissed from the screen without having its action button pressed. This can be used to finalize any action the user has taken, since at this poin the user's grace period to undo the change is over.
The properties set wusing the initialiser method can be changed after the object is created, but should not be altered once the snackbar has been presented on-screen.
actionBlock is executed on the main thread. If the block will take significant time to execute, then it can be run on a background thread by setting the snackbar's
actionIsLongRunning property to
In this case, the block will be executed on a background thread and a
UIActivityIndicator will replace the snackbar's action button.
SSSnackbarinstances to the user
Once created and configured, a snackbar object can be shown on the screen by sending it the
Snackbar objects dismiss themselves either after they have remained on-screen for their configured duration of time, or if the user presses the snackbar's button and the snackbar's action block has finished executing.
It is sometimes necessary however, to dismiss a snackbar object manually. This can be done by sending the object either the