https://github.com/nathangitter/homebutton

Bringing the home button back to iPhone X
https://github.com/nathangitter/homebutton

Last synced: 7 days ago
JSON representation

Bringing the home button back to iPhone X

• Host: GitHub
• URL: https://github.com/nathangitter/homebutton
• Owner: nathangitter
• License: mit
• Created: 2018-03-16T20:41:59.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-04-01T21:36:41.000Z (over 6 years ago)
• Last Synced: 2023-10-20T07:56:46.752Z (about 1 year ago)
• Language: Swift
• Homepage:
• Size: 1.63 MB
• Stars: 312
• Watchers: 9
• Forks: 11
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        






[![CI Status](http://img.shields.io/travis/nathangitter/HomeButton.svg?style=flat)](https://travis-ci.org/nathangitter/HomeButton)

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

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

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

![iOS Version](http://img.shields.io/badge/iOS-11+-4A90E2.svg)

![Xcode Version](http://img.shields.io/badge/Xcode-9+-4A90E2.svg)

![GitHub top language](https://img.shields.io/github/languages/top/badges/HomeButton.svg)

![Code Coverage](https://img.shields.io/badge/coverage-100%25-green.svg)

![Tests Passing](https://img.shields.io/badge/tests%20passing-22%2F22-green.svg)

![Code Quality](https://img.shields.io/badge/code%20quality-high-orange.svg)

![Performance](https://img.shields.io/badge/performance-A+-FF65FA.svg)

![Swift 4.1](http://img.shields.io/badge/swift-4.1-orange.svg)

![Open Source](http://img.shields.io/badge/open%20source-GitHub-2F2F2F.svg)

![Documentation](http://img.shields.io/badge/documentation-great-A3CEFF.svg)

![Demo Gif](http://img.shields.io/badge/demo%20gif-yes-green.svg)

![Haptics](https://img.shields.io/badge/haptics-yes-green.svg)

![Sounds](https://img.shields.io/badge/sounds-yes-green.svg)

![Design](https://img.shields.io/badge/design-Sketch-yellow.svg)

![Animation Frames](https://img.shields.io/badge/animation%20fps-60-50E3C2.svg)

![Dependencies](https://img.shields.io/badge/dependencies-none-brightgreen.svg)

![Gitter Chat](https://img.shields.io/badge/chat-gitter-48B393.svg)

![App Store Ready](https://img.shields.io/badge/app%20review-fail-red.svg)

![Rating](https://img.shields.io/badge/rating-5.0/5.0-blue.svg)

![Released](https://img.shields.io/badge/released-April%201,%202018-C5C5C5.svg)

![Badges](https://img.shields.io/badge/badges-26-943EFF.svg)

![Star this repo](https://img.shields.io/badge/please%20star-this%20repo-FAE249.svg)

When Apple released the iPhone X, they removed iPhone's most iconic feature—the home button.

`HomeButton` is a CocoaPod that brings back the home button. Best part: **it actually works**.



## Usage

`HomeButton` can be added to your poject with zero lines of code. Yes, that's right—no code needed. Simply link the framework in your app, and the home button adds itself.

## Customization

`HomeButton` supports four styles: `classic`, `classicWhite`, `modern`, and `modernWhite`.







The default style is `classic`. To change the style, add the following line:

    HomeButton.style = .modern

    

This can be placed anywhere in your app, but it probably makes the most sense in your AppDelegate's `application(_:didFinishLaunchingWithOptions:)` function.

## Installation via CocoaPods

`HomeButton` is available through [CocoaPods](http://cocoapods.org). To install

it, simply add the following line to your Podfile:

```ruby

pod 'HomeButton'

```

## Frequently Asked Questions

> Will this cause my app to be rejected from the App Store?

It explicity breaks guideline 5.2.1 due to usage of private API's and probably 5.2.5 as well for mimicking system UI. So honestly it depends on the mood of the reviewer.

> Is this a joke?

Because satire is sometimes lost over the internet—yes, this is a joke. It was created as a fun April Fool's project. However, we think it's actually a decent re-creation of the home button, and is valuable as a UI/UX experiment.

## Authors

[Nathan Gitter](https://twitter.com/nathangitter) and [Ian McDowell](https://twitter.com/ian_mcdowell)

## License

MIT. See the LICENSE file for more info.