Dodo - SwiftGit

SwiftUI

Dodo

October 30, 2023

Dodo, a message bar for iOS / Swift

This is a UI widget for showing text messages in iOS apps. It is useful for showing short messages to the user, something like: “Message sent”, “Note saved”, “No Internet connection”.

Dodo includes styles for success, info, warning and error type messages.
The bar can have buttons with custom tap handlers.
Bar styles can be customized.
You can provide custom animations for showing and hiding the bar or use one of the default animation presets.
Supports iOS 9+.

At last the Dodo said, `EVERYBODY has won, and all must have prizes.’

From Alice’s Adventures in Wonderland. Original illustration by John Tenniel, 1865. Source: Wikimedia Commons.

Setup

There are multiple ways you can add Dodo to your project.

Add source

Simply add DodoDistrib.swift file into your Xcode project.

Setup with Carthage

Add github "evgenyneu/Dodo" ~> 13.0 to your Cartfile and run carthage update.

Setup with CocoaPods

If you are using CocoaPods add this text to your Podfile and run pod install.


                                              
                                                use_frameworks!

target ‘Your target name’

pod ‘Dodo’, ‘~> 13.0’

Setup with Swift Package Manager

In Xcode 11+ select File > Packages > Add Package Dependency….
Enter this project’s URL: https://github.com/evgenyneu/Dodo.git

Legacy Swift versions

Setup a previous version of the library if you use an older version of Swift.

Usage

Add import Dodo to your source code (unless you used the file setup method).

Dodo is an extension of UIView class. You can reach it by using using the dodo property in any instance of UIView or its subclass. It can be, for example, the view property of your view controller.

Show and hide message bar


                                              
                                                view.dodo.success(“Everybody has won and all must have prizes.”)

view.dodo.info(“Extinction is the rule. Survival is the exception.”)

view.dodo.warning(“This world is but a canvas to our imagination.”)

view.dodo.error(“The perception of beauty is a moral test.”)
view.dodo.hide()

If you are showing the bar in the root view you may need to provide top or bottom anchors. This will prevent the message bar from overlapping with the status or the tab bar.


                                              
                                                view.dodo.topAnchor = view.safeAreaLayoutGuide.topAnchor

view.dodo.bottomAnchor = view.safeAreaLayoutGuide.bottomAnchor

view.dodo.success(“I solemnly swear to avoid the notch.”)

Alternatively, you can specify the anchors from the layout guides:


                                              
                                                view.dodo.topAnchor = topLayoutGuide.bottomAnchor

view.dodo.bottomAnchor = bottomLayoutGuide.topAnchor

view.dodo.success(“I solemnly swear to avoid the notch.”)

Styling

Set dodo.style property to style the message bar before it is shown. See the styling manual for the complete list of configuration options.


                                              
                                                // Set the text color

view.dodo.style.label.color = UIColor.white
// Set background color

view.dodo.style.bar.backgroundColor = DodoColor.fromHexString(“#00000090”)
// Close the bar after 3 seconds

view.dodo.style.bar.hideAfterDelaySeconds = 3
// Close the bar when it is tapped

view.dodo.style.bar.hideOnTap = true
// Show the bar at the bottom of the screen

view.dodo.style.bar.locationTop = false
// Do something on tap

view.dodo.style.bar.onTap = { /* Tapped on the bar */ }

Add buttons or icons

Set style.leftButton and style.rightButton properties to show buttons or icons. As with other style properties please style the buttons before the message is shown.


                                              
                                                // Use a built-in icon

view.dodo.style.leftButton.icon = .close
// Supply your image

view.dodo.style.leftButton.image = UIImage(named: “CloseIcon”)
// Change button’s image color

view.dodo.style.leftButton.tintColor = DodoColor.fromHexString(“#FFFFFF90”)
// Do something on tap

view.dodo.style.leftButton.onTap = { /* Button tapped */ }
// Close the bar when the button is tapped

view.dodo.style.leftButton.hideOnTap = true

Customize animation

Configure the animation effect of the bar before it is shown. See the animation wiki page for more information.


                                              
                                                // Use existing animations

view.dodo.style.bar.animationShow = DodoAnimations.rotate.show

view.dodo.style.bar.animationHide = DodoAnimations.slideRight.hide
// Turn off animation

view.dodo.style.bar.animationShow = DodoAnimations.noAnimation.show

Unit testing

Sometimes it is useful to verify which messages were shown by your app in unit tests. It can be done by setting an instance of DodoMock class to view.dodo property.

See the unit testing manual for more details.