Merged in task/add-example (pull request #1)

Task/add example

Approved-by: Tim Gortworst
Approved-by: Jelle Heemskerk

Author: mennovogel

.gitignore

@@ -1,2 +1,6 @@
+.gradle
+local.properties
 /build
-*.iml
+*.iml
+.idea
+gradle/local.properties

README.md

@@ -0,0 +1,47 @@
+# Imagin
+
+Imagin is an Android library, written in Kotlin. It attaches to an ImageView and allows you to add 'pinch to zoom', 'swipe to close', 'double tap to zoom' and dragging functionality. Because it attaches to a regular ImageView, it allows you to use all existing functionality of the ImageView or extend the ImageView to add extra functionality. Keep in mind that Imagin sets an OnTouchListener on the ImageView.
+
+This library is currently supported on Android 5.1 Lollipop (22) and higher. 
+
+![](https://github.com/nos-digital/imagin/preview.gif)
+
+## Usage
+
+1. Add the Imagin library to your `build.gradle` file:
+
+```gradle
+dependencies {
+    implementation("nl.nos.imagin:${imagin.version}")
+}
+```
+
+2. Usage in your project:
+
+    Load an image into an ImageView like usual.
+
+```kotlin
+Imagin.with(imageWrapper, imageView)
+    // enable double tap to zoom functionality
+    .enableDoubleTapToZoom()
+    // enable pinch to zoom functionality
+    .enablePinchToZoom()
+    // add an event listener when the user does a single tap
+    .enableSingleTap(object : SingleTapHandler.OnSingleTapListener {
+        override fun onSingleTap() {
+            Toast.makeText(imageView.context, picture.name, Toast.LENGTH_SHORT).show()
+        }
+    })
+    // this allows us to do an action when the user swipes the ImageView vertically and/or horizontally
+    .enableScroll(
+        allowScrollOutOfBoundsHorizontally = false,
+        allowScrollOutOfBoundsVertically = true,
+        scrollDistanceToCloseInPx = distanceToClose
+    ) {
+        onSwipedToCloseListener?.onSwipeToClose()
+    }
+```
+
+## Licence
+
+Imagin is available under the MIT license.

build.gradle

@@ -1,43 +1,28 @@
+// Top-level build file where you can add configuration options common to all sub-projects/modules.
+
 buildscript {
+    ext.kotlin_version = '1.3.50'
     repositories {
-        mavenCentral()
+        google()
+        jcenter()
+
     }
     dependencies {
+        classpath 'com.android.tools.build:gradle:3.5.1'
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+        // NOTE: Do not place your application dependencies here; they belong
+        // in the individual module build.gradle files
     }
 }
 
-apply plugin: 'com.android.library'
-apply plugin: 'kotlin-android'
-apply plugin: 'kotlin-android-extensions'
-
-android {
-    compileSdkVersion compileVersion
-
-    defaultConfig {
-        minSdkVersion minVersion
-        targetSdkVersion targetVersion
-        versionCode 1
-        versionName "1.0"
-    }
-
-    compileOptions {
-        sourceCompatibility JavaVersion.VERSION_1_8
-        targetCompatibility JavaVersion.VERSION_1_8
-    }
+allprojects {
+    repositories {
+        google()
+        jcenter()
 
-    buildTypes {
-        debug {}
-        staging {
-            matchingFallbacks = ['release']
-        }
-        release {}
     }
 }
 
-dependencies {
-    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
-
-    // Test dependencies
-    testImplementation 'junit:junit:4.12'
-    testImplementation 'org.mockito:mockito-core:2.8.9'
-}
+task clean(type: Delete) {
+    delete rootProject.buildDir
+}

example/.gitignore

@@ -0,0 +1 @@
+/build

example/build.gradle

@@ -0,0 +1,33 @@
+apply plugin: 'com.android.application'
+
+apply plugin: 'kotlin-android'
+
+apply plugin: 'kotlin-android-extensions'
+
+android {
+    compileSdkVersion 28
+    defaultConfig {
+        applicationId "nl.nos.imagin.demo"
+        minSdkVersion 22
+        targetSdkVersion 28
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+        }
+    }
+}
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation"org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
+    implementation 'com.android.support:appcompat-v7:28.0.0'
+    implementation 'com.android.support:recyclerview-v7:28.0.0'
+    implementation 'com.android.support.constraint:constraint-layout:1.1.3'
+
+    implementation project(path: ':library')
+}

example/proguard-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

example/src/main/AndroidManifest.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="nl.nos.imagin.example">
+
+    <application
+        android:allowBackup="true"
+        android:icon="@mipmap/ic_launcher"
+        android:label="@string/app_name"
+        android:roundIcon="@mipmap/ic_launcher_round"
+        android:supportsRtl="true"
+        android:theme="@style/AppTheme">
+
+        <activity android:name=".overview.OverviewActivity">
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+
+                <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+        </activity>
+
+        <activity android:name=".gallery.GalleryActivity" />
+
+    </application>
+
+</manifest>