Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/kciter/Floaty

:heart: Floating Action Button for iOS
https://github.com/kciter/Floaty

floatingactionbutton swift ui-components

Last synced: about 2 months ago
JSON representation

:heart: Floating Action Button for iOS

Lists

README 

        
# Floaty

![Swift 5.0](https://img.shields.io/badge/Swift-5.0-orange.svg)

[![Version](https://img.shields.io/cocoapods/v/Floaty.svg?style=flat)](https://cocoapods.org/pods/floaty)

[![License](https://img.shields.io/cocoapods/l/Floaty.svg?style=flat)](https://cocoapods.org/pods/floaty)

[![Platform](https://img.shields.io/cocoapods/p/Floaty.svg?style=flat)](https://cocoapods.org/pods/floaty)

[![Build Status](https://travis-ci.org/kciter/Floaty.svg?branch=master)](https://travis-ci.org/kciter/Floaty)



Floaty is simple floating action button for iOS. (formerly KCFloatingActionButton)

> Why change the name?

> 1. Follow the swift naming convention.

> 2. `KCFloatingActionButton` is too long.



## Preview

Preview gif



## Requirements

* iOS 10.0+

* Swift 5.0



## Installation

### CocoaPods

```ruby

use_frameworks!

pod 'Floaty', '~> 4.2.0'

```

### Carthage

```ruby

github "kciter/Floaty"

```



### Swift Package Manager

Once you have your Swift package set up, adding Floaty as a dependency is as easy as adding it to the dependencies value of your `Package.swift`.

```swift

dependencies: [

    .package(url: "https://github.com/kciter/Floaty.git", from: "4.2.1")

]

```



### Manually

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



## Usage

### Storyboard support

Storyboard support1

Storyboard support2



### Dependent on the UIWindow.

```swift

Floaty.global.button.addItem(title: "Hello, World!")

Floaty.global.show()

```

Dependent on the UIWindow



### Dependent on the UIViewController.

```swift

let floaty = Floaty()

floaty.addItem(title: "Hello, World!")

self.view.addSubview(floaty)

```

Dependent on the UIViewController



### Use icon

```swift

let floaty = Floaty()

floaty.addItem("Hello, World!", icon: UIImage(named: "icon")!)

self.view.addSubview(floaty)

```

Use icon



### Use handler

#### Swift

```swift

let floaty = Floaty()

floaty.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.present(alert, animated: true, completion: nil)

    floaty.close()

})

self.view.addSubview(floaty)

```

Use handler



### Use custom item

```swift

let item = FloatyItem()

item.buttonColor = UIColor.blueColor()

item.title = "Custom item"

Floaty.global.button.addItem(item: item)

```

Use custom item



### RTL Support

You can use the `rtlMode` property to mirror the Floaty Button for rtl languages.

```swift

Floaty.global.rtlMode = true

```

Rtl Enabled Rtl Disabled



### Sticky

You can use the `sticky` property.

```swift

floaty.sticky = true // sticking to parent UIScrollView(also UITableView, UICollectionView)

scrollView.addSubview(floaty)

```



### Friendly Tap

You can use the `friendlyTap` property.

```swifty

fab.friendlyTap = true

scrollView.addSubview(fab)

```

With the default location of the frame, the button is now tappable until the right and rightbottom of the screen. This prevents tapping behind it by accident.



### Animation type



PopFadeSlide Left



Pop animation gif

Fade animation gif

Slide left animation gif



Slide UpNone



Slide up animation gif

None animation gif



## ToDo

* [ ] Labels to come at the right hand side of the FAB Item menu.



## Donate

If you like this open source, you can sponsor it. :smile:



[Paypal me](https://paypal.me/kciter)



## 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.