serralvo / textfieldcounter Goto Github PK

UITextField character counter with lovable UX 💖. No math skills required 🙃.

License: MIT License

Swift 94.03% Ruby 5.97%

uitextfield swift textfield

textfieldcounter's Introduction

TextFieldCounter

UITextField character counter with lovable UX 💖. No math skills required 🙃.

Features

Set max length of UITextField.
A beautiful and animated label about the limits. Show it by ascending or descending way.
Haptic Feedback.
Easy setup with @IBInspectable.

Requirements

TextFieldCounter Version	1.1.0	1.0.4
iOS Version	10.0+	8.0+
Xcode Version	11.2	8

Installation

CocoaPods

You can use CocoaPods to install TextFieldCounter by adding it to your Podfile:

platform :ios, '10.0'
use_frameworks!
pod 'TextFieldCounter'

To get the full benefits import TextFieldCounter wherever you import UIKit

import UIKit
import TextFieldCounter

Manually

Download and drop TextFieldCounter.swift in your project.
Congratulations 🚀

Usage example

By Inspector

Set the class and configure the options.

Programmatically

import TextFieldCounter

let frame = CGRect(x: 20, y: 80, width: 320, height: 30)
let textField = TextFieldCounter(frame: frame, limit: 20, animate: true, ascending: true, counterColor: .black, limitColor: .red)

view.addSubview(textField)

Use Delegate

Set counterDelegate and enjoy it 🚀:

override func viewDidLoad() {
    super.viewDidLoad()
    textField.counterDelegate = self
}

func didReachMaxLength(textField: TextFieldCounter) {
    print("didReachMaxLength")
}

Next Steps

Add UIAppearance support
Add More tests
Add Carthage support

Contribute

We would ❤️ to see your contribution! To contribute to TextFieldCounter, check the LICENSE file for more info.

License

Distributed under the MIT license. See LICENSE for more information.

About

Created by Fabricio Serralvo – serralvo.co

Special thanks 👍 to @ciceroduarte and @rogerluan

textfieldcounter's People

Contributors

Stargazers

Watchers

textfieldcounter's Issues

Create a target label to show limits

The idea is provide a way to show the information about limits in an external label, by default, we keep using internal label (as right view).

Setting UITextFieldDelegate in ViewController for the custom TextField

If I set the UITextFieldDelegate in my own ViewController, the TextFieldCounter class doesn't get any delegate callbacks from UITextFieldDelegate and so it doesn't work anymore.

Is it possible to support both delegates?

Updates tests to give more readability

Now our tests is not using a good naming spec, IMO we should update that.

https://github.com/serralvo/TextFieldCounter/blob/master/TextFieldCounter/TextFieldCounterTests/TextFieldCounterTests.swift

Good referente to follow: https://qualitycoding.org/unit-test-names/

Block-Style Interaction?

Hey,

It's a matter of taste, but if I were going to use TextFieldCounter (I'm not, currently), I'd prefer a block for handling when max length is reached.

textField.onMaxLengthCrossed { overLimit in
  submitButton.isEnabled = !overLimit
}

I don't love onMaxLengthCrossed as a name, but I couldn't think of anything better right away, so if you decide to add a block handler, maybe you can think of a better name.

On that note, it seems important to have a notification on the delegate if the max limit is "unreached" as well -- for instance in the block above, to re-enable the submit button.

Use of undeclared type 'TextFieldCounter'