Skip to content
Elissa displays a notification on top of a UITabBarItem or any UIView anchor view to reveal additional information.
Swift Ruby Objective-C
Branch: master
Clone or download
Broich Merge pull request #14 from KitchenStories/swift4
set swift language version to 4
Latest commit 4544d91 Feb 28, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Elissa fix Elissa size bug. May 23, 2017
Example
images Adds new demo gif example Mar 15, 2017
.gitignore add carthage support Feb 9, 2017
.travis.yml Updates Travis build configuration Mar 18, 2017
Elissa.podspec Release 3.0 Mar 18, 2017
LICENSE Initial commit May 25, 2016
README.md Scale down gif preview [skip ci] Mar 18, 2017
_Pods.xcodeproj Initial commit May 25, 2016

README.md

Elissa

CI Status Version Carthage compatible License Platform

Attach a local notification to any UIView to reveal additional user guidance.

Usage

Example

Per default, Elissa will try to align to the center of the UITabBarItem. However she will never move out of sight to her parent’s view screen bounds. Therefor she applies an offset calculation that will also move the little arrow pointer accordingly.

To run the example project, clone the repo, and run pod install from the Example directory first.

Configuration

You can display Elissa according to your app’s theming by creating and passing a fully customisable configuration.

var elissaConfig = ElissaConfiguration()
elissaConfig.message = "Find your favorites here"
elissaConfig.image = UIImage(named: "heartIcon") ?? UIImage()
elissaConfig.font = UIFont.systemFontOfSize(17)
elissaConfig.textColor = UIColor(red: 91/255, green: 91/255, blue: 91/255, alpha: 1.0)
elissaConfig.backgroundColor = UIColor(red: 241/255, green: 215/255, blue: 85/255, alpha: 1.0)
ElissaConfiguration *elissaConfig = [ElissaConfiguration new];
elissaConfig.message = @"Find your favorites here";
elissaConfig.image = [UIImage imageNamed:@"heartIcon"];
elissaConfig.font = [UIFont systemFontOfSize:17];
elissaConfig.textColor = [UIColor redColor];
elissaConfig.backgroundColor = [UIColor greenColor];

Presentation

As of now there are two different API calls for rendering Elissa depending on the specific use case that is preferred. When presenting Elissa on top of a UITabBarItem you present from an instance of UIViewController:

showElissaFromTabbar(at: 4, configuration: elissaConfig) {            
    Elissa.dismiss()
}
[self showElissaFromTabbarAt:0 configuration:elissaConfig onTouchHandler:^{
    [Elissa dismiss];
}];

In this case Elissa is created and internally managed as a Singleton instance.

When attaching Elissa to any UIView you call the API from a containing view which owns an anchor view for Elissa (typically a parent => child relation):

myViewController.view.showELissa(fromSourceView: sourceView, configuration: elissaConfig) {
  // optionally do something
}
[myViewController.view showELissaFromSourceView:sourceView configuration: elissaConfig onTouchHandler:^{
  // optionally do something
}];

Please not that the latter API call creates and returns an instance of Elissa.

Installation

CocoaPods

Elissa is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "Elissa"

Carthage

To use Carthage, first make sure you have installed it and updated it to the latest version by following their instructions on their repo.

First, you add Elissa to your Cartfile:

github "KitchenStories/Elissa"

Then, run Carthage:

carthage update

Author

Kersten Broich, kersten.broich@gmail.com

License

Elissa is available under the MIT license. See the LICENSE file for more info.

You can’t perform that action at this time.