|
| 1 | +<div id="top"></div> |
1 | 2 |
|
| 3 | +<!-- PROJECT LOGO --> |
| 4 | +<br /> |
| 5 | +<div align="center"> |
| 6 | + |
| 7 | + <h1 align="center">InteractiveTextField</h1> |
| 8 | + |
| 9 | + <p align="center"> |
| 10 | + A customized UITextField including validation and inline message with regular expression. |
| 11 | + <br /> |
| 12 | + <br /> |
| 13 | + <a href="https://github.com/sengthaite/InteractiveTextFieldDemo">View Demo</a> |
| 14 | + · |
| 15 | + <a href="https://github.com/sengthaite/InteractiveTextField/issues">Report Bug</a> |
| 16 | + · |
| 17 | + <a href="https://github.com/sengthaite/InteractiveTextField/issues">Request Feature</a> |
| 18 | + </p> |
| 19 | +</div> |
| 20 | + |
| 21 | + |
| 22 | +<!-- TABLE OF CONTENTS --> |
| 23 | +<details> |
| 24 | + <summary>Table of Contents</summary> |
| 25 | + <ol> |
| 26 | + <li> |
| 27 | + <a href="#about-the-package">About The Package</a> |
| 28 | + </li> |
| 29 | + <li> |
| 30 | + <a href="#getting-started">Getting Started</a> |
| 31 | + <ul> |
| 32 | + <li><a href="#prerequisites">Prerequisites</a></li> |
| 33 | + <li><a href="#installation">Installation</a></li> |
| 34 | + </ul> |
| 35 | + </li> |
| 36 | + <li><a href="#license">License</a></li> |
| 37 | + <li><a href="#contact">Contact</a></li> |
| 38 | + </ol> |
| 39 | +</details> |
| 40 | + |
| 41 | + |
| 42 | + |
| 43 | +<!-- ABOUT THE PROJECT --> |
| 44 | +## About The Package |
| 45 | + |
| 46 | +Constructing TextField with customizations such as <i>interactive border color and width</i>, <i>validations</i>, and <i>material styling</i> is such a complicated process while developing an iOS application. That's why this package is created to support and speed up the development. |
| 47 | + |
| 48 | +Some Features: |
| 49 | +* Pre-defined style: <b>material(placeholder-title movement)</b>, <b>normal</b> |
| 50 | +* Additional customized UIElement: InteractiveTextFieldWithInline, InteractiveTextView, InlineLabel |
| 51 | +* Statically define config which assist on customizing some properties of the textfield |
| 52 | +* Validation logic with regular expression |
| 53 | + |
| 54 | + |
| 55 | +<!-- GETTING STARTED --> |
| 56 | +## Getting Started |
| 57 | + |
| 58 | +Before using the package, please check this demo <a href="https://github.com/sengthaite/InteractiveTextFieldDemo">InteractiveTextFieldDemo</a> to have a look at some examples. |
| 59 | +This package supports installation with: Cocopods (github), or SPM (Swift Package Manager). |
| 60 | + |
| 61 | +### Prerequisites |
| 62 | + |
| 63 | +If using pod for the project, please check this link <a href="https://guides.cocoapods.org/using/getting-started.html">Cocoapods</a> and install it. |
| 64 | + |
| 65 | +### Installation |
| 66 | + |
| 67 | +_Below is the installation of the package._ |
| 68 | + |
| 69 | +1. Pod |
| 70 | + ```ruby |
| 71 | + pod 'InteractiveTextField', :git => 'https://github.com/sengthaite/InteractiveTextField.git', :tag => 'v1.0.2' |
| 72 | + ``` |
| 73 | + ```sh |
| 74 | + pod install |
| 75 | + ``` |
| 76 | +3. SPM |
| 77 | + * Add Package |
| 78 | + * Search with: https://github.com/sengthaite/InteractiveTextField.git |
| 79 | + * Add to Project: Select project |
| 80 | + |
| 81 | +## License |
| 82 | + |
| 83 | +Distributed under the MIT License. See `LICENSE.md` for more information. |
| 84 | + |
| 85 | + |
| 86 | +<!-- CONTACT --> |
| 87 | +## Contact |
| 88 | + |
| 89 | +Sengthai Te - (https://twitter.com/SengthaiTe) - sengthaite@gmail.com |
| 90 | + |
| 91 | +<p align="right"><a href="#top">back to top</a></p> |
0 commit comments