Skip to content

Latest commit

 

History

History
192 lines (162 loc) · 9.03 KB

README.md

File metadata and controls

192 lines (162 loc) · 9.03 KB
Raw

New in the EasyValidation  The article on how this library was created is now published. You can read it on this link here. →.


Built with ❤︎ by Wajahat Karim and contributors


✔️ Changelog

Changes exist in the releases tab.

💻 Installation

Add this in app's build.gradle file:

   def ev_version = "1.0.4"
   implementation "com.wajahatkarim:easyvalidation-core:$ev_version"

   // Shows Toasts by default for every validation error
   implementation "com.wajahatkarim:easyvalidation-toast:$ev_version"

📄 Documentation

Full documentation is available at Gitbook.

⭐️ Features

  • The Validator way validation support. - Details
  • 30+ built-in validation rules like empty, email, credit cards, etc. - Rules List
  • Extension methods for String, EditText, TextView, AutoCompleteTextView, TextInputLayout, and Spinner. - Details
  • Multiple Validations and Checks - Details
  • Collection Extension Methods for validations on multiple texts and views - Details
  • Create your own custom rules - Details

❓ Quick Usage

For example, you can validate any email String like this:

   var myEmailStr = "[email protected]"
   var isValid = myEmailStr.validEmail()  // isValid will be true or false
   
   // Or you can also validate with an error callback method
   myEmailStr.validEmail() {
       // This method will be called when myEmailStr is not a valid email.
       Toast.makeText(contex, it, Toast.LENGTH_SHORT).show()
   }

These extension methods are also available for String, EditText, TextView, AutoCompleteTextView, TextInputLayout, and Spinner.

   var myEditText = findViewById<EditText>(R.id.myEditText)
   var isValid = myEditText.nonEmpty()        // Checks if edit text is empty or not

   // Or with error callback method like this
   myEditText.nonEmpty() {
       // This method will be called when myEditText is empty.
       myEditText.error = it
   }

There are around 30+ built-in rules in the core module library. You can check all these in Rules page. EasyValidation also supports multiple validation checks at same time using Validator class like this:

// This example will check that whether user entered password has
// atleast one number, one spcial character, and one upper case.
var txtPassword = findViewById<EditText>(R.id.txtPassword)
txtPassword.validator()
     .nonEmpty()
     .atleastOneNumber()
     .atleastOneSpecialCharacters()
     .atleastOneUpperCase()
     .addErrorCallback { 
          txtPassword.error = it
          // it will contain the right message. 
          // For example, if edit text is empty, 
          // then 'it' will show "Can't be Empty" message
     }
     .check()

For more advanced usage, checkout the full documentation at GitBook page.

💰 Donations

This project needs you! If you would like to support this project's further development, the creator of this project or the continuous maintenance of this project, feel free to donate. Your donation is highly appreciated (and I love food, coffee and beer). Thank you!

PayPal

  • Donate $5: Thank's for creating this project, here's a tea (or some juice) for you!
  • Donate $10: Wow, I am stunned. Let me take you to the movies!
  • Donate $15: I really appreciate your work, let's grab some lunch!
  • Donate $25: That's some awesome stuff you did right there, dinner is on me!
  • Donate $50: I really really want to support this project, great job!
  • Donate $100: You are the man! This project saved me hours (if not days) of struggle and hard work, simply awesome!
  • Donate $2799: Go buddy, buy Macbook Pro for yourself!

Of course, you can also choose what you want to donate, all donations are awesome!

👨 Developed By

Wajahat Karim

👍 How to Contribute

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

📃 License

Copyright 2018 Wajahat Karim

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.