https://github.com/aslanyanhaik/roundcode

Custom rounded QR code with lots of customization.
https://github.com/aslanyanhaik/roundcode

aztec-code barcode cocoapods ios qrcode qrcode-reader roundcode swift swift-package-manager xcode

Last synced: about 8 hours ago
JSON representation

Custom rounded QR code with lots of customization.

• Host: GitHub
• URL: https://github.com/aslanyanhaik/roundcode
• Owner: aslanyanhaik
• License: mit
• Created: 2019-04-21T12:32:23.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-06-23T17:41:59.000Z (over 4 years ago)
• Last Synced: 2024-10-31T16:30:41.778Z (14 days ago)
• Topics: aztec-code, barcode, cocoapods, ios, qrcode, qrcode-reader, roundcode, swift, swift-package-manager, xcode
• Language: Swift
• Homepage:
• Size: 3.44 MB
• Stars: 403
• Watchers: 19
• Forks: 54
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RoundCode for iOS

[![License](http://img.shields.io/badge/License-MIT-green.svg?style=flat)](https://github.com/aslanyanhaik/RoundCode/blob/master/LICENSE)

[![Swift 5](https://img.shields.io/badge/Swift-5.0-orange.svg?style=flat)](https://swift.org)

[![Twitter: @aslanyanhaik](https://img.shields.io/badge/Contact-Twitter-blue.svg?style=flat)](https://twitter.com/aslanyanhaik)

RoundCode is custom circular QR code with lots of customization. 

Similar to Facebook messenger and Apple's App Clip Codes the RoundCode includes convenient camera scanner and decoder.







## Installation

### Cocoapods:

```curl

pod 'RoundCode'

```

### Swift Package Manager:

File > Swift Packages > Add Package Dependency

```swift

https://github.com/aslanyanhaik/RoundCode

```

## Usage example

import framework

```swift

import RoundCode

```

### Encoding

create coder and encode

```swift

let image = RCImage(message: "Hello World")

let coder = RCCoder()

do {

  imageView.image = try coder.encode(image)

} catch {

  //handle errors

}

```

You can also validate the messsage before encoding

```swift

let coder = RCCoder()

let isValidText = coder.validate("Hello world")

```

### Decoding

Create instane of RCCameraViewController and handle the delegate

```swift

class ViewController: UIViewController, RCCameraViewControllerDelegate {

  

  func scan() {

    let cameraController = RCCameraViewController()

    cameraController.delegate = self

    present(cameraController, animated: true)

  }

  

  func cameraViewController(didFinishScanning message: String) {

    messageLabel.text = message

  }

}

``` 

You can also decode a UIImage like this

```swift

let coder = RCCoder()

do {

  messageLabel.text = try coder.decode(UIImage(named: code)!)

} catch {

  //handle errors

}

```

## Appearance

You can change the appearance like this

```swift

var image = RCImage(message: "Hello world")

image.contentInsets = UIEdgeInsets(top: 8, left: 10, bottom: 4, right: 10)

image.attachmentImage = UIImage(named: "Profile")

image.size = 300

image.gradientType = .linear(angle: CGFloat.pi)

image.tintColors = [.red, .black]

```

If image is on dark background you should change scanning mode to `darkBackground`

```swift

let coder = RCCoder()

coder.scanningMode = .darkBackground

```

## Advanced coding configuration

You can provide custom coding configuration in order to encode long text by reducing number of characters

```swift

let configuration = RCCoderConfiguration.shortConfiguration

let coder = RCCoder(configuration: configuration)

```

```swift

let configuration = RCCoderConfiguration(characters: " -abcdefghijklmnopqrstuvwxyz0123456789")

let coder = RCCoder(configuration: configuration)

```

⚠️ If you are encoding with custom configuration, then you should change the RCCameraViewController configuration ⚠️

```swift

let configuration = RCCoderConfiguration(characters: " -abcdefghijklmnopqrstuvwxyz0123456789")

let coder = RCCoder(configuration: configuration)

let camera = RCCameraViewController()

camera.coder = coder

```

## Compatibility

Written in Swift 5 and requires Xcode 11.0

RoundCode is compatible with iOS 13.0+.







## Author

* [Haik Aslanyan](https://twitter.com/aslanyanhaik)

## License

Copyright 2020 Haik Aslanyan.

Licensed under MIT License: https://opensource.org/licenses/MIT