Go to file
Xavier Schott eb5d751045 Merge branch 'JakubMazur-master' 2017-04-15 09:02:35 -07:00
TGPControls Merge branch 'JakubMazur-master' 2017-04-15 09:02:35 -07:00
TGPControls.xcodeproj add Carhage support 2017-03-22 14:50:15 +01:00
TGPControlsDemo UIImage generalization 2017-04-14 17:53:02 -07:00
.gitignore Added .gitignore 2015-02-18 19:05:15 -08:00
LICENSE License 2017-02-13 22:19:49 -08:00
README.md Merge branch 'master' of https://github.com/JakubMazur/TGPControls into JakubMazur-master 2017-04-14 13:03:55 -07:00
TGPControlDemo.gif added demo gif 2017-03-16 16:20:26 -07:00
TGPControls.podspec Swift 3 2017-02-14 18:31:21 -08:00

README.md

Demo Project

Slider with ticks & animated Label (Swift)

TGPControls are drop-in replacement of UISlider & UILabel, with visual preview in Interface Builder, single liner instrumentation, smooth animations, simple API, powerful customization.

What's DiscreteSlider?

ticksdemo

TGPDiscreteSlider: A slider with discrete steps (i.e. ticks), discrete range, with customizable track, thumb and ticks. Ideal to select individual steps, star rating, integers, rainbow colors, slices and in general any value that is not a continuum. Just set the number of stops, TGPDiscreteSlider handles the selection and the animations for you.

What's CamelLabels?

camellabels2

TGPCamelLabels: A set of animated labels (dock effect) representing a selection. Can be used alone or in conjunction with a UIControl. Ideal to represent steps. The discrete slider and the camel labels can work in unison.

Compatibility

  1. Written in Swift 3, can be integrated with Swift or Obj-C
  2. TGPControls are AutoLayout, IB Designable and IB Inspectable ready (†)
  3. Version 3.0.0 comes with a Swift 3 demo application, for iOS 10 down to 8. (†) Earlier 2.x versions provide iOS 7 support

imagessliderdemo

Copyright disclaimer
The above slider is inspired by National Parks by National Geographic iPhone App.
National Parks iPhone App is developed by Rally Interactive LLC.
The above image, styling, appearance and look & feel all Copyright © 2015 National Geographic Society.
TGPControls is not associated with National Geographic Society, Rally Interactive LLC or any of it's subsidiaries.

Fully Customizable

alphabetslider

Control everything about the slider or its labels, starting with colors, images and fonts, including track and ticks shape, and thumb shadows. All computations regarding range and sizing and handled automatically. Use the two classes in tandem to create stunning new controls, which can be resized dynamically, to intergrate beautifully into your application.

onoff

Most customization can be done in Interface Builder and require zero coding.

How to integrate

Using CocoaPods

  • iOS 10 and later down to iOS 8: install CocoaPods 1.2.0+ CocoaPods-Frameworks, add use_frameworks! to your podfile.
  • iOS 7: Use TGPControls version 2.1.0

Using Carthage

github "SwiftArchitect/TGPControls"

Please note that Carthage is available only for iOS 8 or higher

Besides customization, which you can do entirely under Interface Builder in iOS 8 and later, both TGPDiscreteSlider and TGPCamelLabels require surprisingly little code to integrate.

DiscreteSlider

For simplicity, TGPDiscreteSlider does not descend from UISlider but from UIControl. It uses a minimumValue, a tickCount and an incrementValue (instead of minimumValue and maximumValue). All graphic aspects, such as physical spacing of the ticks or physical width of the track are controlled internally. This makes TGPDiscreteSlider predictable. it is guaranteed to always fit snuggly inside its bounds.

Single step: To use DiscreteSlider + CamelLabels in tandem, you need exactly 1 line of code:

discreteSlider.ticksListener = camelLabels

complete That's all!
Through the TGPControlsTicksProtocol, the camelLabels listen to value and size changes. You may want to adopt this protocol to handle changes, or use the traditional UIControl notifications:

Advanced Steps (1a): register to notifications (just like any UIControl)

discreteSlider.addTarget(self,
action: #selector(valueChanged(_:event:)),
for: .valueChanged)

Advanced Steps (1b): respond to notification

func valueChanged(_ sender: TGPDiscreteSlider, event:UIEvent) {
self.stepper.value = Double(sender.value)
}

tickStyle, trackStyle, thumbStyle Properties:

Constant Value
.iOS 0 Gives to any component the iOS appearance: Ticks are invisible, track is blue and gray, thumb is round with a shadow
.rectangular 1 Boxy look with hard edges
.rounded 2 From rounded rectangles to perfects circles, depending on vertical to horizontal ratio
.invisible 3 Surprisingly useful to individually hide ticks, track, or even thumb

Other Properties:

Listener
ticksListener a TGPControlsTicksProtocol listener, such as TGPCamelLabels, which receives spacing changes notifications.
allTargets Inherited from UIControl, receives actions for control event
Tick
tickSize absolute dimension
tickImage Resource name as string, fits in tickSize
tickCount discrete steps, must be 2 or greater
ticksDistance horizontal spacing (calculated)
Track
trackThickness height
trackImage resource name as string, ignores trackThickness
minimumTrackTintColor track lower side
maximumTrackTintColor track higher side
Thumb
thumbSize absolute size
thumbImage dictates thumbSize
thumbTintColor background
thumbShadowRadius breaking the flat design concept
thumbShadowOffset applied to thumbShadowRadius, may affect control bounds

image

CamelLabels

Besides font customization, TGPCamelLabels only requires a set of labels (supplied as strings), and an active index selection.

Step 1: tell the TGPCamelLabels what to select (Refer to Single step section above to use DiscreteSlider + CamelLabels in tandem)

camelLabels.value = sender.value

There is no step 2. Most of the customization can be done inside Interface Builder.

Properties:

Property
ticksListener ties a discrete slider to its camel labels. This is your most robust method to not only ensure that the layout of both controls match exactly, but also adjust this spacing when orientation changes. A typical use may be discreteSlider.ticksListener = camelLabels
names supplies a new set of labels ; supersedes the tickCount property, which will return the number of labels. A typical use may be camelLabels.names = ["OFF", "ON"]
ticksDistance override the labels spacing entirely ; prefer the ticksListener mechanism if it is available to you. A typical use may be camelLabels.ticksDistance = 15
value which label is emphasized (selected)
backgroundColor labels become tap-through (click-through) when set to UIColor.clear ; use TGPCamelLabels on top of other UI elements, even native iOS objects!:uiswitch
Edges & Animation
offCenter leftmost and righmost labels only: relative inset expressed as a proportion of individual label width: 0: none, +0.5: nudge in by a half width (fully fit) or -0.5: draw completely outside
insets leftmost and righmost labels only: absolute inset expressed in pixels
emphasisLayout emphasized (selected) labels vertical alignment ; .top, .centerY or .bottom. Default is .top (†)
regularLayout regular labels vertical alignment ; .top, .centerY or .bottom. Default is .bottom (†)

(†) No camel animation will occur when emphasisLayout = regularLayout, i.e. .centerY.

Emphasized labels
upFontName font
upFontSize size
upFontColor color
Regular labels
dnFontName font
dnFontSize size
dnFontColor color

Code example

See TGPControlsDemo project: TGPControlsDemo (Modern Swift syntax + IBInspectable)

import UIKit
import TGPControls

class ViewController: UIViewController {
@IBOutlet weak var oneTo10Labels: TGPCamelLabels!
@IBOutlet weak var oneTo10Slider: TGPDiscreteSlider!
@IBOutlet weak var alphabetLabels: TGPCamelLabels!
@IBOutlet weak var alphabetSlider: TGPDiscreteSlider!
@IBOutlet weak var switch1Camel: TGPCamelLabels!

override func viewDidLoad() {
super.viewDidLoad()

alphabetLabels.names = ["A","B","C","D","E","F",
"G","H","I","J","K","L","M",
"N","O","P","Q","R","S",
"T","U","V","W","X","Y","Z"]
switch1Camel.names = ["OFF", "ON"]

// Automatically track tick spacing and value changes
alphabetSlider.ticksListener = alphabetLabels
oneTo10Slider.ticksListener = oneTo10Labels
}

// MARK: - UISwitch

@IBAction func switch1ValueChanged(_ sender: UISwitch) {
switch1Camel.value = (sender.isOn) ? 1 : 0
}
}

Customization examples

image

custom