testableapp / kcfloatingactionbutton

:heart: Floating Action Button for iOS

KCFloatingActionButton

Simple Floating Action Button for iOS

Preview

Requirements

• iOS 8.0+
• Swift 2.0
• Xcode 7

Installation

CocoaPods

use_frameworks!
pod "KCFloatingActionButton"

Manually

To install manually the KCFloatingActionButton in an app, just drag the KCFloatingActionButton/*.swift file into your project.

Usage

Storyboard support

Dependent on the UIWindow.

Swift

KCFABManager.defaultInstance().getButton().addItem(title: "Hello, World!")
KCFABManager.defaultInstance().show()

Objective-C

[[[KCFABManager defaultInstance] getButton] addItemWithTitle:@"Hello, world!"];
[[KCFABManager defaultInstance] show:true];

Dependent on the UIViewController.

Swift

let fab = KCFloatingActionButton()
fab.addItem(title: "Hello, World!")
self.view.addSubview(fab)

Objective-C

KCFloatingActionButton *fab = [[KCFloatingActionButton alloc] init];
[fab addItemWithTitle:@"Hello, World!"];
[self.view addSubview:fab];

Use icon

Swift

let fab = KCFloatingActionButton()
fab.addItem("Hello, World!", icon: UIImage(named: "icon")!)
self.view.addSubview(fab)

Objective-C

KCFloatingActionButton *fab = [[KCFloatingActionButton alloc] init];
[fab addItem:@"Hello, World" icon:[UIImage imageNamed:@"icon"]];
[self.view addSubview:fab];

Use handler

Swift

let fab = KCFloatingActionButton()
fab.addItem("I got a handler", icon: UIImage(named: "icon")!, handler: { item in
    let alert = UIAlertController(title: "Hey", message: "I'm hungry...", preferredStyle: .Alert)
    alert.addAction(UIAlertAction(title: "Me too", style: .Default, handler: nil))
    self.presentViewController(alert, animated: true, completion: nil)
    fab.close()
})
self.view.addSubview(fab)

Objective-C

KCFloatingActionButton *fab = [[KCFloatingActionButton alloc] init];
__weak KCFloatingActionButton *_fab = fab;
[fab addItem:@"I got a handler" icon:[UIImage imageNamed:@"icon"] handler:^(KCFloatingActionButtonItem *item) {
    UIAlertController *alert = [UIAlertController alertControllerWithTitle:@"Hey" message:@"I'm hungry..." preferredStyle:UIAlertControllerStyleAlert];
    [alert addAction:[UIAlertAction actionWithTitle:@"Me too" style:UIAlertActionStyleDefault handler:nil]];
    [self presentViewController:alert animated:true completion:nil];
    [_fab close];
}];
[self.view addSubview:fab];

Use custom item

Swift

let item = KCFloatingActionButtonItem()
item.buttonColor = UIColor.blueColor()
item.title = "Custom item"
KCFABManager.defaultInstance().getButton().addItem(item: item)

Objective-C

KCFloatingActionButtonItem *item = [[KCFloatingActionButtonItem alloc] init];
item.buttonColor = [UIColor blueColor];
item.title = @"Custom item";
[[[KCFABManager defaultInstance] getButton] addItemWithItem:item];

Methods / Properties

KCFABManager

Methods

Method	Parameter	Return type	Description
defaultInstance		KCFABManager	Return singleton object.
show	animated: Bool = true		Show KCFloatingActionButton object.
hide	animated: Bool = true		Hide KCFloatingActionButton object.
toggle	animated: Bool = true		Toggle show/hide.
isHidden		Bool	Check Floating Action Button to hidden.
getButton		KCFloatingActionButton	Return KCFloatingActionButton object.

KCFloatingActionButton

Methods

Method	Parameter	Return type	Description
open			Show items.
close			Hide items.
toggle			Toggle show/hide.
addItem	item item: KCFloatingActionButtonItem		Add the custom item.
addItem	title title: String	KCFloatingActionButtonItem	Add the default item that has title only.
addItem	title: String, icon: UIImage	KCFloatingActionButtonItem	Add the default item that has title and icon.
addItem	title: String, icon: UIImage, handler: ((KCFloatingActionButtonItem) -> Void)	KCFloatingActionButtonItem	Add the default item that has all params.
addItem	icon icon: UIImage	KCFloatingActionButtonItem	Add the default item that has icon only.
addItem	icon: UIImage, handler: ((KCFloatingActionButtonItem) -> Void)	KCFloatingActionButtonItem	Add the default item that has icon and handler.
removeItem	item: KCFloatingActionButtonItem		Remove the item.

Properties

Property	Type	Description
size	CGFloat	Button size.
padding	CGFloat
buttonColor	UIColor
plusColor	UIColor	Plus icon color on the inside button.
overlayColor	UIColor	The background color that appears when the icons show.
closed	Bool	Check items open and close
itemSpace	CGFloat
itemSize	CGFloat
itemButtonColor	UIColor

KCFloatingActionButtonItem

Properties

Property	Type	Description
size	CGFloat	Button size.
buttonColor	UIColor
circleShadowColor	UIColor
titleShadowColor	UIColor
title		String
icon		UIImage
handler	((KCFloatingActionButtonItem) -> Void)?	Touch up inside event handler

TODO

• More animate style
• Highly customizable
• Add documentation
• Storyboard support
• Swift 1.2 support
• Objective-C support

License

The MIT License (MIT)

Copyright (c) 2015 Lee Sun-Hyoup

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.