Skip to content

Lightweight set of text fields with nice animation and functionality πŸš€

License

Notifications You must be signed in to change notification settings

oleghnidets/TweeTextField

Repository files navigation

TweeTextField

Swift Version Build Platform Documentation SPM Pod Carthage License

This is lightweight library that provides different types of Text Fields based on your needs.

Preview

Features

  • Customizable placeholder
  • Customizable label under text field
  • Customizable via Attributes Inspector
  • Nice animation for placeholder
  • Nice animation for bottom line
  • No override of UITextField' behaviors
  • Clean code with divided functionalities
  • Easy to use and extend
  • Right-to-Left support
  • Complete documentation and support

Requirements

  • iOS 11.0+
  • Xcode 11.0+
  • Swift 5.0+

Installation

CocoaPods

To integrate TweeTextField into your Xcode project using CocoaPods, specify it in your Podfile:

pod 'TweeTextField'

Then run pod install to integrate the library in your project.

Swift Package Manager

Adding TweeTextField to the dependencies value of your Package.swift file.

// swift-tools-version:5.0

import PackageDescription

let package = Package(
    name: "YOUR_PROJECT_NAME",
    dependencies: [
        .package(url: "https://github.com/oleghnidets/TweeTextField.git", from: "1.6.1"),
    ]
)

Or you may use Xcode. File->Swift Packages->Add Package Dependency. Then put link to the repository.

Carthage

To integrate TweeTextField into your Xcode project using Carthage, specify it in your Cartfile:

github "oleghnidets/TweeTextField"

Run carthage update to build the framework and drag the built TweeTextField.framework into your Xcode project. More info you can find on official page.

Manually

  1. Download the code.
  2. Drag and drop sources in your project.
  3. Import the library in code by import TweeTextField.

Usage

Check out the documentation for more details. Select one of the text fields provided based on your requirements. In general, you can use TweeAttributedTextField. It is a main class with aggregated functionalities of other text fields.

Look at class diagram:

Class-diagram

  • TweePlaceholderTextField has a customized placeholder label which has animations on the beginning and ending editing.
  • TweeBorderedTextField shows a bottom line permanently.
  • TweeActiveTextField shows animated bottom line when a user begins editing.
  • TweeAttributedTextField shows the custom info label under text field.

You can set up text field based on your preferences via Attributes Inspector. Also the library has some properties accessible for you. Check out sample project for more information.

Attributes Inspector

emailTextField.infoAnimationDuration = 0.7
emailTextField.infoTextColor = .systemRed
emailTextField.infoFontSize = 13
        
emailTextField.activeLineColor = .systemBlue
emailTextField.activeLineWidth = 1
emailTextField.animationDuration = 0.3
        
emailTextField.lineColor = .lightGray
emailTextField.lineWidth = 1
        
emailTextField.minimumPlaceholderFontSize = 10
emailTextField.originalPlaceholderFontSize = 13
emailTextField.placeholderDuration = 0.3
emailTextField.placeholderColor = .systemGray2
emailTextField.tweePlaceholder = "Email address"
emailTextField.placeholderLabel.font = UIFont.preferredFont(forTextStyle: .largeTitle)

Contributing and support

License

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