README.md

SnapSliderFilters

SnapSliderFilters allows you to create easily a SnapChat like navigation between a picture and its filters (that you can automatically generate). You can add stickers above the slides, tap on the screen to add a message and place it wherever you want, exactly as you do every day on SnapChat !

Installation with CocoaPods

SnapSliderFilters is available through CocoaPods. To install it, add the following line to your Podfile:

pod "SnapSliderFilters"

Example

To run the example project, clone the repo, and run pod install from the Example directory first. This demo allows you to import your own image from the camera roll and to save the final edited image.

Requirements

Platform

• Swift 3
• Xcode 8
• iOS 9

Supported Device

iPhone 4s, 5, 5s, 5c, 6, 6 Plus, 6s, 6s Plus, all iPad having iOS 9.

How to use

Slider

To insert a slider in your ViewController, all you need is to create the slider, load the data and show it.

The slider must be displayed in fullscreen. SNUtils allows you to do it easily :

var slider = SNSlider(frame: CGRect(origin: CGPointZero, size: SNUtils.screenSize))

Then, you can generate filters from your original picture, using the Core Image Filter. SNFilter.filterNameListis a small selection of filters that you can use for a quick demo :

// Create your original filter
var originalPicture = SNFilter(frame: slider.frame, withImage: UIImage(named: "yourPicture")!)
// Generate differents filters by passing in argument the original picture and an array of filter's name
var data  = SNFilter.generateFilters(originalPicture, filters: SNFilter.filterNameList)

You can add some stickers above your filters, by creating a SNSticker and adding it to the proper filter :

var sticker = SNSticker(frame: CGRect(x: 20, y: 0, width: 140, height: 140), image: UIImage(named: "sticker1")!)
// In case of overlapping, you can provide a zPosition (the default one is 0)
var sticker2 = SNSticker(frame: CGRect(x: 30, y: 0, width: 140, height: 140), image: UIImage(named: "sticker2")!, atZPosition: 2))

// 2 stickers will be added to the filter at index 1
self.data[1].addSticker(sticker)
self.data[1].addSticker(sticker2)

Your ViewController must conform to the SNSliderDataSource protocol. It allows the slider to be populated with your own data.

extension ViewController: SNSliderDataSource {
  
  // The number of SNFilters that you want in the slider
  func numberOfSlides(slider: SNSlider) -> Int {
    return data.count
  }
  
  // For a given index, you return the corresponding SNFilter
  func slider(slider: SNSlider, slideAtIndex index: Int) -> SNFilter {
    return data[index]
  }
  
  // The starting index of the slider
  func startAtIndex(slider: SNSlider) -> Int {
    return 0
  }
}

Finally, you can show the slider :

slider.dataSource = self
slider.userInteractionEnabled = true
view.addSubview(slider)
slider.reloadData()

TextField

If you want to add a Snapchat like textfield above your slider, your can do it easily as well. Firstly, create the SNTextField : all you need to pass is your y starting point for the textfield, the width and the height of your screen (once again, SNUtils can help you).

var textfield = SNTextField(y: SNUtils.screenSize.height/2, width: SNUtils.screenSize.width, heightOfScreen: SNUtils.screenSize.height)

Make sure to put it above all your views by adding it to just after the initialization, and then show it :

textField.layer.zPosition = 100
self.view.addSubview(textField)

Now a little bit of boilerplate code, to create observers for the keyboard behaviour and to detect the tap gesture :

var tapGesture:UITapGestureRecognizer = UITapGestureRecognizer(target: self, action: #selector(handleTap))
tapGesture.delegate = self
slider.addGestureRecognizer(tapGesture)

NSNotificationCenter.defaultCenter().addObserver(self.textField, selector: #selector(SNTextField.keyboardWillShow(_:)), name: UIKeyboardWillShowNotification, object: nil)
NSNotificationCenter.defaultCenter().addObserver(self.textField, selector: #selector(SNTextField.keyboardWillHide(_:)), name: UIKeyboardWillHideNotification, object: nil)
NSNotificationCenter.defaultCenter().addObserver(self.textField, selector: #selector(SNTextField.keyboardTypeChanged(_:)), name: UIKeyboardDidShowNotification, object: nil)

You ViewController must conform to the UIGestureRecognizerDelegate. Add this extension at the end of your file :

extension ViewController: UIGestureRecognizerDelegate {
  func handleTap() {
    self.textField.handleTap()
  }
}

Finally, do not forget to remove observers :

override func viewWillDisappear(animated: Bool) {
  NSNotificationCenter.defaultCenter().removeObserver(textField)
}

Buttons

You can also add some snap-like buttons with a very simple target-action method :

private let button = SNButton(frame: CGRect(x: 20, y: SNUtils.screenSize.height - 35, width: 33, height: 30), withImageNamed: "saveButton")

button.setAction {
  [weak weakSelf = self] in
  // To do when the button is pressed
}

view.addSubview(button)

Get the final-edited image

let picture = SNUtils.screenShot(self.view)

If you have things on the screen that you don't want on your final image (buttons, ...), you can create another UIView, add everything you want to be on the picture as its subviews and perform the screenshot on this view.

You will find an example of this method in the example project (see screenView).

Author

Paul Jeannot, Computer Science & Engineering student at University of Technology of Compiègne. Contact at paul.jeannot95@gmail.com

License

Free Icons provided by Icons8

SnapSliderFilters is available under the MIT license. See the LICENSE file for more info.