on master help sign in
huekit/README.md
79 lines 3.0 kB history raw
1<p align="center">
2<img src="readme-resources/hero@2x.png" style="max-height: 300px;" alt="HueKit for iOS">
3</p>
5<p align="center">
6<a href="https://travis-ci.org/louisdh/huekit"><img src="https://travis-ci.org/louisdh/huekit.svg?branch=master" style="max-height: 300px;" alt="Build Status"/></a>
7<br>
8<a href="https://developer.apple.com/swift/"><img src="https://img.shields.io/badge/Swift-4.1-orange.svg?style=flat" style="max-height: 300px;" alt="Swift"/></a>
9<a href="https://cocoapods.org/pods/HueKit"><img src="https://img.shields.io/cocoapods/v/HueKit.svg" style="max-height: 300px;" alt="Pod Version"/></a>
10<a href="https://github.com/Carthage/Carthage"><img src="https://img.shields.io/badge/Carthage-compatible-4bc51d.svg?style=flat" style="max-height: 300px;" alt="Carthage Compatible"/></a>
11<img src="https://img.shields.io/badge/platform-iOS-lightgrey.svg" style="max-height: 300px;" alt="Platform: iOS">
12<br>
13<a href="http://twitter.com/LouisDhauwe"><img src="https://img.shields.io/badge/Twitter-@LouisDhauwe-blue.svg?style=flat" style="max-height: 300px;" alt="Twitter"/></a>
14<a href="https://paypal.me/louisdhauwe"><img src="https://img.shields.io/badge/Donate-PayPal-green.svg?style=flat" alt="Donate via PayPal"/></a>
15</p>
17<p align="center">
18<img src="readme-resources/example.gif" style="max-height: 1480px;" alt="HueKit for iOS">
19</p>
22## About
23HueKit is a UI framework for iOS that provides components and utilities for building color pickers. Since each app may want a custom color picker, the design of this framework is geared towards reusability and allows for great customization.
25### Components
26All components are marked `open`, so they can be subclassed. Also, all components are marked `@IBDesignable`, so they can be previewed in Interface Builder. Components that provide user interaction are subclassed from `UIControl`, you can observe a change in value by using `@IBAction`.
28#### ColorBarPicker
29![](readme-resources/components/ColorBarPicker.png)
31#### ColorBarView
32![](readme-resources/components/ColorBarView.png)
34#### ColorIndicatorView
35![](readme-resources/components/ColorIndicatorView.png)
37#### ColorSquarePicker
38![](readme-resources/components/ColorSquarePicker.png)
40#### ColorSquareView
41![](readme-resources/components/ColorSquareView.png)
43#### SourceColorView
44![](readme-resources/components/SourceColorView.png)
47## Installation
49### [CocoaPods](http://cocoapods.org)
51To install, add the following line to your ```Podfile```:
53```ruby
54pod 'HueKit', '~> 1.0'
55```
57### [Carthage](https://github.com/Carthage/Carthage)
58To install, add the following line to your ```Cartfile```:
60```ruby
61github "louisdh/huekit" ~> 1.0
62```
63Run ```carthage update``` to build the framework and drag the built ```HueKit.framework``` into your Xcode project.
67## Requirements
69* iOS 10.0+
70* Xcode 9.3+
72## Todo
74- [ ] Add tests
75- [ ] Add documentation
77## License
79This project is available under the MIT license. See the LICENSE file for more info.