Skip to content

Latest commit

 

History

History
190 lines (146 loc) · 4.97 KB

README.md

File metadata and controls

190 lines (146 loc) · 4.97 KB
Raw

Twitter Follow Carthage Carthage

🎬 Preview

🌟 Features

  • Easily usable
  • Simple Swift syntax
  • Cool flip animation
  • Compatible with Carthage
  • Compatible with CocoaPods
  • Customizable
  • Universal (iPhone & iPad)
  • Lightweight readable codebase
  • And More...

📲 Installation

Using CocoaPods

Edit your Podfile and specify the dependency:

pod "YRPayment"

Using Carthage

Edit your Cartfile and specify the dependency:

github "yassram/YRPayment"

🐒 How to use

In 4 steps:

1. Import YRPayment.

import YRPayment

2. Create a YRPaymentCreditCard instance and link it to a YRPayement instances:

let card = YRPaymentCreditCard()
let payment = YRPayment(creditCard: card)

3. Add your card to a view and set its position:

view.addSubview(card)
card.centerXAnchor.constraint(equalTo: view.centerXAnchor).isActive = true
card.centerYAnchor.constraint(equalTo: view.centerYAnchor).isActive = true

4. link your textFields to the payment object:

payment.numberTextField = NumberTF
payment.holderNameTextField = NameTF
payment.validityTextField = ValidityTF
payment.cryptogramTextField = cryptoTF

(Assuming that NumberTF, NameTF, ValidityTF, cryptoTF are textField alrready created)

5. Enjoooooooy !

🔍 Extracting data from the credit card

To extract data from the credit card :

  1. Credit card number :
payment.getCardNumber()
  1. Credit card holder name :
payment.getCardHolderName()
  1. Credit card validity :
payment.getCardValidity()
  1. Credit card cryptogram
payment.getCardCryptogram()

🎨 Customization : (more features are coming soon)

💳 Customizing the credit card type (Symbole):

When creating your creditCard instance (as seen before 👆) MasterCard is default:

let card = YRPaymentCreditCard()

you can specify the symbole you want from the available types:

let card = YRPaymentCreditCard(type: .masterCard)

or specify a custom one by uploading your own image symbole:

let image = UIImage(named: "mySymboleImage")!
let card = YRPaymentCreditCard(type: .custom(image))

More types are coming soon

🕹 Enable/Disable flip on user tap:

// Enable
payment.flipOnClick = true

// Disable
payment.flipOnClick = false

🙏 Contributing

This is an open source project, so feel free to contribute. How?

  • Open an issue.
  • Send feedback via email.
  • Propose your own fixes, suggestions and open a pull request with the changes.

📢 Mentions

Did you mention YRPayment in your website, do you use it in your app ? send me a message to be added in this section!


💻 Author

  • Yassir Ramdani

📝 License

MIT License

Copyright (c) 2019 yassir RAMDANI

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.