Git Product home page Git Product logo

kwstepper's Introduction

KWStepper

Version Carthage Documentation Platform License

KWStepper is a stepper control written in Swift. Unlike UIStepper, KWStepper allows for a fully customized UI and provides callbacks for tailoring the UX.

KWStepper Screenshot

KWStepper was initially created in Objective-C for Addo Label's Counters• and is now available in Swift for you to enjoy 😁

Features

  • Allows for a fully customized UI.
  • Provides properties for setting different decrement and increment steps.
  • Offers optional callbacks for responding to control events and tailoring the UX.
  • Supports method chaining for easier configuration and event handling.

Installation

CocoaPods

KWStepper is available through CocoaPods. To install it, simply add the following lines to your Podfile:

use_frameworks!
pod 'KWStepper'

Carthage

To integrate KWStepper using Carthage, add the following line to you Cartfile:

github "kyleweiner/KWStepper"

Swift Package Manager

To add KWStepper to your Xcode project via Swift Package Manager, select File → Swift Packages → Add Package Dependency… and enter the URL for this repository.

Manually

If you prefer not to use a dependency manager, simply copy the source files into your project.

Usage

Try the example project!

var stepper: KWStepper!

@IBOutlet weak var countLabel: UILabel!
@IBOutlet weak var decrementButton: UIButton!
@IBOutlet weak var incrementButton: UIButton!
stepper = KWStepper(decrementButton: decrementButton, incrementButton: incrementButton)

Respond to control events using the valueChangedCallback property.

stepper.valueChangedCallback = { stepper in
    self.countLabel.text = String(stepper.value)
}

Or, use the target-action pattern.

stepper.addTarget(self, action: #selector(stepperDidChange), for: .valueChanged)

Configuring KWStepper

With the exception of the continuous property, KWStepper offers everything provided by UIStepper and more.

stepper.autoRepeat = true
stepper.autoRepeatInterval = 0.10
stepper.wraps = true
stepper.minimumValue = 0
stepper.maximumValue = 8
stepper.value = 0
stepper.incrementStepValue = 1
stepper.decrementStepValue = 1

Method chaining is also supported:

stepper
    .wraps(true)
    .maximumValue(10)
    .stepValue(2)
    .valueChanged { stepper in
        // ...
    }

If necessary, the rounding behavior for incrementing and decrementing may be modified via roundingBehavior.

KWStepperDelegate

Adopting KWStepperDelegate provides the following optional delegate methods for tailoring the UX.

  • optional func KWStepperDidDecrement()
  • optional func KWStepperDidIncrement()
  • optional func KWStepperMaxValueClamped()
  • optional func KWStepperMinValueClamped()
  • optional func KWStepperDidEndLongPress()

Callbacks

KWStepper provides the following callbacks:

  • valueChangedCallback
  • decrementCallback
  • incrementCallback
  • maxValueClampedCallback
  • minValueClampedCallback
  • longPressEndedCallback

Method chaining is supported for callbacks too:

stepper
    .valueChanged { _ in }
    .didDecrement { _ in }
    .didIncrement { _ in }
    .maxValueClamped { _ in }
    .minValueClamped { _ in }
    .longPressEnded { _ in }

// `maxValueClampedCallback` and `minValueClampedCallback` may be set simultaneously.
stepper.valueClamped { stepper in
    // ...
}

In the example project, valueChanged(_:) is used to update the count label text when the stepper value changes. valueClamped(:_) is used to present a UIAlertController when a limit is reached and the wraps property is set to false.

Author

KWStepper was written by Kyle Weiner and contributors.

License

KWStepper is available under the MIT license. See the LICENSE file for details.

kwstepper's People

Contributors

aoverholtzer avatar coledunsby avatar kyleweiner avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

kwstepper's Issues

Long Press

Hi, Thank you very much for the library.

I am building my first iOS app and open source libraries are a great help.

Is there a way to keep increasing or decreasing the value while the increment/decrement button is pressed.

I would like to keep updating the label while the button is pressed rather than displaying the value after the long press.

I tried to go through your example code but could not find anything.

Callback until long press end

Hi, thank you for this awesome library
Is there a way to to have callback until long press finish ? cause i use backend call

An opportunity

Hello, I need help finishing an app. If you can help me, Id love to tell you the idea. Its a great idea and very unique. I'm 60% done with the app and its one of a kind. If your interested in hearing the app, please email me back. I emailed you because of the project examples you have on GitHub. Thank you and hope to hear back from you.

Swift project XCode CocoaPods isn't working

I added pod 'KWStepper' to Podfile, ran pod install. Successfully imported import KWStepper to the file where I'm trying to use KWStepper. It can't find KWStepperDelegate and KWStepper even though the framework is attached.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.