/AztecEditor-Android

A reusable native Android rich text editor component.

Primary LanguageKotlinGNU General Public License v2.0GPL-2.0

Aztec Logo' Aztec: Native HTML Editor for Android

Build Status BuddyBuild

Aztec (which extends EditText) is a rich-text editor component for writing HTML documents in Android.

Supports Android 4.1+ (API 16 - Jelly Bean)

Build and test

Build the library, build the example project and run unit tests:

$ ./gradlew build

Run unit tests only:

$ ./gradlew test

Before running instrumentation tests

Espresso advises disabling system animations on devices used for testing:

On your device, under Settings->Developer options disable the following 3 settings:

  • Window animation scale
  • Transition animation scale
  • Animator duration scale

One additional setup step is also required to handle an Espresso issue with clicks (see the caveats below):

On your device, under Settings -> Accessibility -> Touch & hold delay, set the delay to Long.

Run the instrumentation tests:

$ adb shell am instrument -w -r -e package org.wordpress.aztec.demo -e debug false org.wordpress.aztec.test/android.support.test.runner.AndroidJUnitRunner

Integrating Aztec in your project

The library is not ready for prime time yet, so it's not published on Maven Central. Currently the library is distributed as an alpha build.

Brave developers can either use the project as a source distribution or have fun with JitPack at their own risk:

compile ('com.github.wordpress-mobile.WordPress-Aztec-Android:aztec:develop-SNAPSHOT')

When Aztec is ready, we'll publish the artifact in Maven.

Reference

License

Aztec is an Open Source project covered by the GNU General Public License version 2.