custom-qr-generator
Android library for creating QR-codes with logo, custom pixel/eyes shapes, background image. Powerd by ZXing.
 |
 |
 |
Installation
To get a Git project into your build:
Step 1. Add the JitPack repository to your build file
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
Or for gradle 7+ to settings.gradle file:
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
...
maven {
url 'https://jitpack.io'
}
}
}
Step 2. Add the dependency.
dependencies {
implementation 'com.github.alexzhirkevich:custom-qr-generator:1.2.0'
}
Usage
Step 1. Create QR code data. There are multiple QR types support: Plain Text, Url, Wi-Fi, Email, GeoPos, Profile Cards, Phone, etc.
val data = QrData.Url("https://example.com")
Step 2. Define styling options:
val options = QrOptions.Builder(1024)
.setPadding(.3f)
.setBackground(
QrBackgroundImage(
drawable = ContextCompat
.getDrawable(this, R.drawable.frame)!!,
)
)
.setLogo(
QrLogo(
drawable = ContextCompat
.getDrawable(this, R.drawable.tg)!!,
size = .2f,
padding = .2f,
shape = QrLogoShape
.Circle
)
)
.setColors(
QrColors(
dark = QrColor
.Solid(Color.parseColor("#345288")),
bitmapBackground = QrColor.Solid(Color.WHITE),
codeBackground = QrColor
.Solid(Color.parseColor("#ddffffff")),
)
)
.setElementsShapes(
QrElementsShapes(
darkPixel = QrPixelShape
.RoundCorners(),
ball = QrBallShape
.RoundCorners(.25f),
frame = QrFrameShape
.RoundCorners(.25f),
background = QrBackgroundShape
.RoundCorners(.05f)
)
)
.build()
Step 2. Create a QR code generator and pass your data and options into it:
val generator: QrCodeGenerator = QrGenerator()
val bitmap = generator.generateQrCode(data, options)
It is better to perform QR codes generating in background thread. Generator supports cancellation with coroutines.
val bitmap = generator.generateQrCodeSuspend(data, options)
Customization
You can easily implement your own shapes and coloring for QR Code elements using math formulas. For example, this is implementation of Circle QR-pixels:
object Circle : QrPixelShape {
override fun invoke(
i: Int, j: Int, elementSize: Int,
qrPixelSize: Int, neighbors: Neighbors
): Boolean = {
val center = elementSize/2.0
return (sqrt((center-i)*(center-i) + (center-j)*(center-j)) < center)
}
}
7.7k Dec 29, 2022
5.3k Jan 4, 2023
1.4k Dec 31, 2022
12 Apr 23, 2022
3 Dec 6, 2022
99 Nov 30, 2022
5.4k Jan 3, 2023
1k Dec 16, 2022
39 Jan 8, 2023
0 Mar 14, 2022
430 Jan 2, 2023
3.9k Dec 30, 2022
251 Jan 6, 2023
2k Jan 1, 2023
395 Dec 22, 2022
2 Sep 28, 2022
186 Dec 13, 2022
27 Jul 22, 2022
1 Oct 5, 2022