Home

Awesome

AwesomeQRCode-Kotlin

license release

AwesomeQRCode in this repository was written in Kotlin.

Take a look at original version written in Java.

切换至中文(简体)版本?

<img alt="Special, thus awesome." src="art/banner.png" style="max-width: 600px;">

Add dependency into your project

Add below lines in build.gradle of your project:

allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}

Then, add below lines in build.gradle of your app module:

dependencies {
        compile 'com.github.SumiMakito:AwesomeQRCode-Kotlin:1.0.5'
}

Quick start

"I just wanna get a Bitmap":

In this case, QR code will be generated synchronously. Thus it means you may take a risk blocking the UI thread, which would lead to Application Not Responding (ANR). I strongly recommend you to use it in a non-UI thread.

Thread{
 kotlin.run {
  var qrCode: Bitmap = AwesomeQRCode.Renderer().contents(contents).size(800).margin(20).render()
  }
}.start()

Generate a QR code asynchronously and show the QR code in an ImageView:

AwesomeQRCode.Renderer().contents(contents)
 .size(800).margin(20)
 .renderAsync(object : AwesomeQRCode.Callback {
  override fun onRendered(renderer: AwesomeQRCode.Renderer, bitmap: Bitmap) {
   // Tip: here we use runOnUiThread {...} to avoid the problems caused by operating UI elements from a non-UI thread.
   runOnUiThread {
    imageView!!.setImageBitmap(bitmap)
   }
   override fun onError(renderer: AwesomeQRCode.Renderer, e: Exception) {
    e.printStackTrace()   
   }
})

Parameters

ParameterTypeExplanationDefault ValueMisc.
contentsStringContents to encode.nullRequired
sizeint-pxWidth as well as the height of the output QR code, includes margin.800Required
marginint-pxMargin to add around the QR code.20Required
dataDotScalefloatValue used to scale down the data dots' size.0.3f(0, 1.0f)
colorDarkint-colorColor of "true" blocks. Works only when both colorDark and colorLight are set.Color.BLACK
colorLightint-colorColor of empty space, or "false" blocks. Works only when both colorDark and colorLight are set.Color.WHITE
backgroundBitmapBackground image to embed in the QR code. Leave null to disable.null
whiteMarginint-pxIf set to true, a white border will appear around the background image.true
autoColorbooleanIf set to true, the dominant color of backgroundImage will be used as colorDark.true
binarizebooleanIf set to true, the whole image will be binarized with the given threshold, or default threshold if not specified.fasle
binarizeThresholdintThreshold used to binarize the whole image.128(0, 255)
roundedDataDotsbooleanIf set to true, data dots will appear as solid dots instead of blocks.false
logoBitmapLogo image to embed at the center of generated QR code. Leave null to disable.null
logoMarginint-pxWhite margin that appears around the logo image. Leave 0 to disable. LOGO10
logoCornerRadiusint-pxRadius of the logo's corners. Leave 0 to disable.8
logoScalefloatValue used to scale the logo image. Larger value may result in decode failure.0.2f(0, 1.0f)

Changelog

Version 1.0.5

Version 1.0.4

Version 1.0.3

Version 1.0.2

Version 1.0.1

Version 1.0.0

Alternatives

EFQRCode written in Swift

EFQRCode is a tool to generate QRCode image or recognize QRCode from image, in Swift.

AwesomeQRCode is inspired by EFQRCode by EyreFree.

If your application is in need of generating pretty QR codes in Swift, take a look at EFQRCode. It should help.

Awesome-qr.js written in JavaScript

Redirect to Awesome-qr.js

Would you like to buy me a cup of cappuccino?

PayPalAlipay
PayPalAlipay

Copyright & License

Copyright © 2017 Sumi Makito

Licensed under Apache License 2.0 License.

Copyright 2017 Sumi Makito

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.