Skip to content

A light-weight, customizable Android signature / drawing library.

License

Notifications You must be signed in to change notification settings

nak5ive/ink-android

 
 

Repository files navigation

Ink

A light-weight, customizable view for capturing a signature or drawing in an Android app.

screenshot

Import the Dependency

Include the JitPack repository in your project's build.gradle file

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

Import the library dependency

implementation 'com.github.nak5ive:ink-android:X.X.X'

Usage

To use the library, you must include the InkView class in your project. A simple solution is to reference it directly into your layout:

<com.simplify.ink.InkView
    android:id="@+id/ink"
    android:layout_width="match_parent"
    android:layout_height="match_parent"/>

Then, within your code, fetch the view and initialize it:

InkView ink = (InkView) findViewById(R.id.ink);
    ink.setColor(getResources().getColor(android.R.color.black));
    ink.setMinStrokeWidth(1.5f);
    ink.setMaxStrokeWidth(6f);

Features can be toggled on and off by using the custom attributes on the xml tag:

// add this to the root element in your layout
xmlns:app="http://schemas.android.com/apk/res-auto"

<com.simplify.ink.InkView
    android:id="@+id/ink"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:inkFlags="interpolation|responsiveWeight"/>

or by setting the flags manually in code:

InkView ink = (InkView) findViewById(R.id.ink);
ink.setFlags(InkView.FLAG_INTERPOLATION | InkView.FLAG_RESPONSIVE_WEIGHT);

By default, interpolation and responsive weight flags are on.

You can capture the drawing in the form of a bitmap by calling:

Bitmap drawing = ink.getBitmap();

or you can also include a background color:

Bitmap drawing = ink.getBitmap(getResources().getColor(R.color.my_background_color));

About

A light-weight, customizable Android signature / drawing library.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 100.0%