Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/honghaoz/autokeyboardscrollview

AutoKeyboardScrollView is an UIScrollView subclass which makes showing and dismissing keyboard for UITextFields much easier. So called keyboard avoidance.
https://github.com/honghaoz/autokeyboardscrollview

Last synced: 5 days ago
JSON representation

AutoKeyboardScrollView is an UIScrollView subclass which makes showing and dismissing keyboard for UITextFields much easier. So called keyboard avoidance.

Host: GitHub
URL: https://github.com/honghaoz/autokeyboardscrollview
Owner: honghaoz
License: mit
Created: 2015-02-02T02:53:29.000Z (almost 10 years ago)
Default Branch: master
Last Pushed: 2024-08-28T16:45:34.000Z (4 months ago)
Last Synced: 2024-09-28T22:46:30.119Z (3 months ago)
Language: Swift
Homepage:
Size: 1.62 MB
Stars: 121
Watchers: 6
Forks: 19
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# AutoKeyboardScrollView

[![Version](https://img.shields.io/cocoapods/v/AutoKeyboardScrollView.svg?style=flat)](http://cocoapods.org/pods/AutoKeyboardScrollView)
[![License](https://img.shields.io/cocoapods/l/AutoKeyboardScrollView.svg?style=flat)](http://cocoapods.org/pods/AutoKeyboardScrollView)
[![Platform](https://img.shields.io/cocoapods/p/AutoKeyboardScrollView.svg?style=flat)](http://cocoapods.org/pods/AutoKeyboardScrollView)

AutoKeyboardScrollView is a smart UIScrollView which can:
- Scroll to proper position and make sure the active textField is visible when keyboard is showing
- Customize top and bottom margin for textField
- Dismiss keyboard when tap on scrollView
- Dismiss keyboard on tap "Return"
- New `contentView` which makes your life with Auto Layout easier

## Preview
![demo](https://raw.githubusercontent.com/honghaoz/AutoKeyboardScrollView/master/demo.gif)

## Why?
Form views are very common when developing iOS projects. When keyboard is showing up, the big keyboard is covering great areas, which will hide the active textField.

It's kind of annoying to handle scrolling on UIScrollView and it's trivial to write keyboard notification and textField target action code again.

To keep your code DRY and make your life with iOS development easier.

## Requirements

- iOS 8.0+ / Mac OS X 10.9+
- Xcode 7.0

## Installation

### CocoaPods
AutoKeyboardScrollView is available through [CocoaPods](http://cocoapods.org). To install it, simply add the following line to your Podfile:

```ruby
pod "AutoKeyboardScrollView", '~> 1.5'
```

### Manually

Just drag [`AutoKeyboardScrollView.swift`](https://raw.githubusercontent.com/honghaoz/AutoKeyboardScrollView/master/Source/AutoKeyboardScrollView.swift) (Located in `./Source`, right click and **Download Linked File**) into your project and use it directly.

## Usage
Just use `AutoKeyboardScrollView` as parent view of textFields, or views contain textFields. Add subViews on `autoKeyboardScrollView.contentView` (Be sure to add subViews on `.contentView`), then it just works!

(Note, only textField which is already on the view to be added can be handled, you can manually add textFields that need to be handled by calling `handleTextField:` or `handleTextFields:`)

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

## How it works?
`AutoKeyboardScrollView` is a subClass of `UIScrollView`, some key features are list as following:

#### contentView
A new property: `contentView` is added, which is served same purpose as UITableViewCell. All subviews should be added on contentView, this is extremely helpful when dealing Auto Layout with ScrollView (refer: [Apple Technical Note TN2154 - UIScrollView And Autolayout](https://developer.apple.com/library/ios/technotes/tn2154/_index.html))

Note: To let `AutoKeyboardScrollView` determine its `contentSize`, the height and width of `contentView` must be fully specified.

#### Dismiss keyboard on Tap
AutoKeyboardScrollView will be attached with a Tap gesture and let you dismiss keyboard by tapping the empty space around textFields.

#### Dismiss keyboard on "Return"
AutoKeyboardScrollView will automatically detect textFields on newly added subViews, and add UIControlEditing actions for these textField, it will let you dismiss keyboard when tap "Return".

#### Work with Interface Builder
Create a wrapper view in IB, then add it as a subview on `autoKeyboardScrollView.contentView`.

See example project and select target *InterfaceBuilderExample*:

![targets](https://raw.githubusercontent.com/honghaoz/AutoKeyboardScrollView/master/Example/select_targets.png)

## Requirements
Works with Auto Layout, not tested on frame based code.

Support iOS 7 and above. Not tested on iOS 6, since Auto Layout came from iOS6, should be fine.

## Author

Honghao Zhang

## License

AutoKeyboardScrollView is available under the MIT license. See the [LICENSE](https://github.com/honghaoz/AutoKeyboardScrollView/blob/master/LICENSE) file for more info.