A Compose Multiplatform library for capturing and exporting signatures as ImageBitmap with customizable options. Perfect for electronic signature, legal documents and more.
repositories {
mavenCentral()
}
kotlin {
sourceSets {
commonMain {
dependencies {
implementation("io.github.joelkanyi:sain:2.0.3")
}
}
}
}
dependencies {
implementation("io.github.joelkanyi:sain:2.0.3")
}
[versions]
sain = "2.0.3"
[libraries]
sain = { module = "io.github.joelkanyi:sain", version.ref = "sain" }
dependencies {
implementation(libs.sain)
}
Add the Sain
composable into your project and customize it according to your needs:
var imageBitmap: ImageBitmap? by remember {
mutableStateOf(null)
}
val state = remember {
SignatureState()
}
Sain(
state = state,
modifier = Modifier
.fillMaxWidth()
.height(250.dp)
.border(
BorderStroke(
width = .5.dp,
color = MaterialTheme.colorScheme.onSurface
),
shape = RoundedCornerShape(8.dp)
),
onComplete = { signatureBitmap ->
if (signatureBitmap != null) {
imageBitmap = signatureBitmap
} else {
println("Signature is empty")
}
},
) { action ->
Row(
modifier = Modifier
.padding(top = 16.dp)
.fillMaxWidth(),
horizontalArrangement = Arrangement.spacedBy(16.dp)
) {
Button(
modifier = Modifier.weight(1f),
onClick = {
imageBitmap = null
action(SignatureAction.CLEAR)
}) {
Text("Clear")
}
Button(
modifier = Modifier.weight(1f),
onClick = {
action(SignatureAction.COMPLETE)
}) {
Text("Complete")
}
}
}
The Sain
composable takes in an actions
parameter which is a lambda that takes in a SignatureAction
enum. The SignatureAction
enum has two values:
CLEAR
- Clears the signatureCOMPLETE
- Completes the signature and returns the signature as anImageBitmap
in theonComplete
lambda
signatureColor
- The color of the signaturesignatureThickness
- The thickness of the signaturemodifier
- The modifier for theSain
composable which allows you to customize the size, shape, background, border etc of the signature view
The library works well in one orientation. If you rotate the device, the signature will be lost. This is a known issue and will be fixed in the next release.
Note: The library is now hosted on Maven Central. If you were using the previous version hosted on Jitpack, please update your dependencies to the latest version.
Copyright 2023 Joel Kanyi
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.