https://github.com/benchr267/touchpresenter
Highlights every touch with a given view to create better video presentations of your app.
https://github.com/benchr267/touchpresenter
Last synced: about 1 year ago
JSON representation
Highlights every touch with a given view to create better video presentations of your app.
- Host: GitHub
- URL: https://github.com/benchr267/touchpresenter
- Owner: BenchR267
- License: mit
- Created: 2016-07-17T15:48:57.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-08-21T11:33:36.000Z (almost 9 years ago)
- Last Synced: 2024-04-20T14:51:31.466Z (about 2 years ago)
- Language: Shell
- Size: 1.27 MB
- Stars: 18
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TouchPresenter
[](https://travis-ci.org/BenchR267/TouchPresenter)
[]()
[]()
[]()
[](http://cocoapods.org/pods/TouchPresenter)
[](http://cocoapods.org/pods/TouchPresenter)
[](http://cocoapods.org/pods/TouchPresenter)
## What does it do?
This framework provides an UIWindow subclass that highlights every touch. It can be used to create better video presentations of your app.
The idea of this project is heavily inspired by https://github.com/eumlab/EUMTouchPointView
## Example
To run the example project, clone the repo and open the workspace in the Example directory.
 
## Requirements
## Installation
TouchPresenter is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod 'TouchPresenter'
```
TouchPresenter is also available via Carthage. Just add this line to your Cartfile (more information [here](https://github.com/Carthage/Carthage)):
```
github "BenchR267/TouchPresenter" == 2.1.0
```
## Usage
In the project, you need to import the framework:
```Swift
import TouchPresenter
```
To use the window, just override the init method in your AppDelegate.swift and configure it like you want:
```Swift
override init() {
let config = TouchPresenterConfiguration(viewType: TPLightBlueCircleIndicator.self, enable3DTouch: true)
window = TPWindow(frame: UIScreen.mainScreen().bounds, configuration: config)
super.init()
}
```
If you are already using a custom window be sure to make it a subclass of TPWindow and call it's initializer as super in your initializer:
```Swift
class MyCustomWindow: TPWindow { ... }
```
It is also possible to use different indicators, there are three kinds provided currently by the framework which is TPLightBlueCircleIndicator, TPRedIndicator and TPCircleIndicator. If you want to use a custom one, just return the type of your custom view, the only requirement is, that it inherits from UIView. (See example project for an example of this)
You can also specify a configuration block in the configuration object. That will be called after initialising the view, so you could just use a plain UIImageView like in the example project:
```Swift
let config = TouchPresenterConfiguration(viewType: UIImageView.self, enable3DTouch: true) {
$0.image = UIImage(named: "oval")
}
window = TPWindow(frame: UIScreen.mainScreen().bounds, configuration: config)
```
## Features
- [x] all touches are highlighted (even multiple ones)
- [x] simple indicators are provided
- [x] Enable 3D touch visualization
- [ ] possibility to turn the functionality off temporary
- [x] add configuration parameter/closure for view
- [ ] add unit tests
- [ ] add travisCI
## Author
Benjamin Herzog, mail@benchr.de
## License
TouchPresenter is available under the MIT license. See the LICENSE file for more info.