,
45 | modifier: Modifier = Modifier,
46 | textStyle: TextStyle = TextStyle(),
47 | cursorColor: Color = Color.Black,
48 | typistSpeed: TypistSpeed = TypistSpeed.NORMAL,
49 | isInfiniteCursor: Boolean = true,
50 | isBlinkingCursor: Boolean = true,
51 | isCursorVisible: Boolean = true,
52 | isInfinite: Boolean = false,
53 | cursorSymbol: String = "|",
54 | onAnimationEnd: (() -> Unit)? = null,
55 | onAnimationStart: (() -> Unit)? = null,
56 | ) {
57 | if (textList.isEmpty()){
58 | throw InvalidTextListException()
59 | }
60 | TypistImpl(
61 | textList,
62 | modifier,
63 | textStyle,
64 | cursorColor,
65 | typistSpeed,
66 | isInfiniteCursor,
67 | isBlinkingCursor,
68 | isCursorVisible,
69 | isInfinite,
70 | cursorSymbol,
71 | onAnimationEnd,
72 | onAnimationStart,
73 | )
74 | }
--------------------------------------------------------------------------------
/gradle.properties:
--------------------------------------------------------------------------------
1 | # Project-wide Gradle settings.
2 | # IDE (e.g. Android Studio) users:
3 | # Gradle settings configured through the IDE *will override*
4 | # any settings specified in this file.
5 | # For more details on how to configure your build environment visit
6 | # http://www.gradle.org/docs/current/userguide/build_environment.html
7 | # Specifies the JVM arguments used for the daemon process.
8 | # The setting is particularly useful for tweaking memory settings.
9 | org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
10 | # When configured, Gradle will run in incubating parallel mode.
11 | # This option should only be used with decoupled projects. More details, visit
12 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
13 | # org.gradle.parallel=true
14 | # AndroidX package structure to make it clearer which packages are bundled with the
15 | # Android operating system, and which are packaged with your app's APK
16 | # https://developer.android.com/topic/libraries/support-library/androidx-rn
17 | android.useAndroidX=true
18 | # Kotlin code style for this project: "official" or "obsolete":
19 | kotlin.code.style=official
20 | # Enables namespacing of each library's R class so that its R class includes only the
21 | # resources declared in the library itself and none from the library's dependencies,
22 | # thereby reducing the size of the R class for that library
23 | android.nonTransitiveRClass=true
24 |
25 |
26 | GROUP=tech.dev-scion
27 | POM_ARTIFACT_ID=typist
28 | VERSION_NAME=1.3.0
29 | SONATYPE_AUTOMATIC_RELEASE=true
30 |
31 | POM_NAME=Typist
32 | POM_DESCRIPTION=Android Jetpack Compose Typing Animation Library
33 | POM_INCEPTION_YEAR=2022
34 | POM_URL=https://github.com/zeeshanali-k/Typist/
35 |
36 | POM_LICENSE_NAME=The Apache Software License, Version 2.0
37 | POM_LICENSE_URL=https://www.apache.org/licenses/LICENSE-2.0.txt
38 | POM_LICENSE_DIST=repo
39 |
40 | POM_SCM_URL=https://github.com/zeeshanali-k/Typist/
41 | POM_SCM_CONNECTION=scm:git:git://github.com/zeeshanali-k/Typist.git
42 | POM_SCM_DEV_CONNECTION=scm:git:ssh://git@github.com/zeeshanali-k/Typist.git
43 |
44 | POM_DEVELOPER_ID=zeeshanali-k
45 | POM_DEVELOPER_NAME=Zeeshan Ali
46 | POM_DEVELOPER_URL=https://github.com/zeeshanali-k/
47 |
48 | SONATYPE_HOST=S01
49 |
50 | RELEASE_SIGNING_ENABLED=true
--------------------------------------------------------------------------------
/app/build.gradle.kts:
--------------------------------------------------------------------------------
1 | plugins {
2 | id("com.android.application")
3 | id("org.jetbrains.kotlin.android")
4 | }
5 |
6 | val composeVersion = "1.5.0"
7 | val composeMaterial3Version = "1.1.1"
8 | val composeCompilerVersion = "1.5.3"
9 | android {
10 | namespace = "tech.devscion.typistdemo"
11 | compileSdk = 34
12 |
13 | defaultConfig {
14 | applicationId = "tech.devscion.typistdemo"
15 | minSdk = 21
16 | targetSdk = 34
17 | versionCode = 1
18 | versionName = "1.3"
19 |
20 | testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
21 | vectorDrawables {
22 | useSupportLibrary = true
23 | }
24 | }
25 |
26 | buildTypes {
27 | release {
28 | isMinifyEnabled = false
29 | // proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
30 | }
31 | }
32 | compileOptions {
33 | sourceCompatibility = JavaVersion.VERSION_18
34 | targetCompatibility = JavaVersion.VERSION_18
35 | }
36 | kotlinOptions {
37 | jvmTarget = "18"
38 | }
39 | buildFeatures {
40 | compose = true
41 | }
42 | composeOptions {
43 | kotlinCompilerExtensionVersion = composeCompilerVersion
44 | }
45 | packagingOptions {
46 | resources {
47 | excludes += "/META-INF/{AL2.0,LGPL2.1}"
48 | }
49 | }
50 | }
51 |
52 |
53 | dependencies {
54 |
55 | implementation("androidx.core:core-ktx:1.10.1")
56 | implementation("androidx.lifecycle:lifecycle-runtime-ktx:2.5.1")
57 | implementation("androidx.activity:activity-compose:1.6.1")
58 | implementation("androidx.compose.ui:ui:$composeVersion")
59 | implementation("androidx.compose.ui:ui-tooling-preview:$composeVersion")
60 | implementation("androidx.compose.material3:material3:$composeMaterial3Version")
61 | implementation(project(":typist"))
62 | testImplementation("junit:junit:4.13.2")
63 | androidTestImplementation("androidx.test.ext:junit:1.1.4")
64 | androidTestImplementation("androidx.test.espresso:espresso-core:3.5.0")
65 | androidTestImplementation("androidx.compose.ui:ui-test-junit4:$composeVersion")
66 | debugImplementation("androidx.compose.ui:ui-tooling:$composeVersion")
67 | debugImplementation("androidx.compose.ui:ui-test-manifest:$composeVersion")
68 |
69 | }
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | [](https://search.maven.org/search?q=g:%22tech.dev-scion%22%20AND%20a:%22typist%22)
2 |
3 | This library is longer maintained, instead use Typist-CMP
4 |
5 | # Typist
6 | A Jetpack Compose Text Typing Animation Library for Android.
7 | For Compose Multiplatform Check this.
8 |
9 | 
10 |
11 | ## Usage
12 | Add this to your project level "build.gradle" or in newer versions of gradle in "settings.gradle" under repositories section:
13 |
14 | ```groovy
15 | repositories {
16 | mavenCentral()
17 | }
18 | ```
19 | Add this to your module level build.gradle file:
20 |
21 | ```groovy/kotlin
22 | implementation 'tech.dev-scion:typist:TAG'
23 |
24 | or for kotlin
25 |
26 | implementation("tech.dev-scion:typist:TAG")
27 | ```
28 | Replace TAG with library version
29 |
30 | Add Typist Composable to your app and configure accordingly:
31 |
32 | ```kotlin
33 | Typist(
34 | text = "Hi! I am Typist.",
35 | modifier = Modifier
36 | .align(Alignment.Center),
37 | typistSpeed = TypistSpeed.NORMAL,
38 | textStyle = TextStyle(
39 | color = Color.Red,
40 | fontWeight = FontWeight.Bold,
41 | fontSize = 28.sp,
42 | textAlign = TextAlign.Center,
43 | isBlinkingCursor = true, // if true the cursor will keep blinking
44 | isInfiniteCursor = false, // if true the cursor will not hide even after the text has been written
45 | isCursorVisible = true, // if true the cursor will not be visible at all
46 | ),
47 |
48 | isInfinite = true, // This can make the typing animation repeat infinitely
49 | onAnimationStart = {},
50 | onAnimationEnd = {}
51 | )
52 | ```
53 | You can now add multiple strings as follows:
54 |
55 | ```kotlin
56 | Typist(
57 | textList = listOf("Hi! I am Typist.","And I can type multiple times"),//These strings will be typed in the specified order
58 | typistSpeed = TypistSpeed.NORMAL,
59 | textStyle = TextStyle(
60 | color = Color.Red,
61 | fontWeight = FontWeight.Bold,
62 | fontSize = 28.sp,
63 | textAlign = TextAlign.Center
64 | ),
65 | isInfinite = true, // This can make the typing animation repeat infinitely
66 | isBlinkingCursor = false,
67 | isInfiniteCursor = true,
68 | isCursorVisible = true,
69 | onAnimationStart = {},
70 | onAnimationEnd = {}
71 | )
72 | ```
73 |
74 |
75 | 
76 |
77 |
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @rem
2 | @rem Copyright 2015 the original author or authors.
3 | @rem
4 | @rem Licensed under the Apache License, Version 2.0 (the "License");
5 | @rem you may not use this file except in compliance with the License.
6 | @rem You may obtain a copy of the License at
7 | @rem
8 | @rem https://www.apache.org/licenses/LICENSE-2.0
9 | @rem
10 | @rem Unless required by applicable law or agreed to in writing, software
11 | @rem distributed under the License is distributed on an "AS IS" BASIS,
12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | @rem See the License for the specific language governing permissions and
14 | @rem limitations under the License.
15 | @rem
16 |
17 | @if "%DEBUG%" == "" @echo off
18 | @rem ##########################################################################
19 | @rem
20 | @rem Gradle startup script for Windows
21 | @rem
22 | @rem ##########################################################################
23 |
24 | @rem Set local scope for the variables with windows NT shell
25 | if "%OS%"=="Windows_NT" setlocal
26 |
27 | set DIRNAME=%~dp0
28 | if "%DIRNAME%" == "" set DIRNAME=.
29 | set APP_BASE_NAME=%~n0
30 | set APP_HOME=%DIRNAME%
31 |
32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter.
33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
34 |
35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
37 |
38 | @rem Find java.exe
39 | if defined JAVA_HOME goto findJavaFromJavaHome
40 |
41 | set JAVA_EXE=java.exe
42 | %JAVA_EXE% -version >NUL 2>&1
43 | if "%ERRORLEVEL%" == "0" goto execute
44 |
45 | echo.
46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
47 | echo.
48 | echo Please set the JAVA_HOME variable in your environment to match the
49 | echo location of your Java installation.
50 |
51 | goto fail
52 |
53 | :findJavaFromJavaHome
54 | set JAVA_HOME=%JAVA_HOME:"=%
55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
56 |
57 | if exist "%JAVA_EXE%" goto execute
58 |
59 | echo.
60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
61 | echo.
62 | echo Please set the JAVA_HOME variable in your environment to match the
63 | echo location of your Java installation.
64 |
65 | goto fail
66 |
67 | :execute
68 | @rem Setup the command line
69 |
70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
71 |
72 |
73 | @rem Execute Gradle
74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
75 |
76 | :end
77 | @rem End local scope for the variables with windows NT shell
78 | if "%ERRORLEVEL%"=="0" goto mainEnd
79 |
80 | :fail
81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
82 | rem the _cmd.exe /c_ return code!
83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
84 | exit /b 1
85 |
86 | :mainEnd
87 | if "%OS%"=="Windows_NT" endlocal
88 |
89 | :omega
90 |
--------------------------------------------------------------------------------
/typist/src/main/java/tech/devscion/typist/TypistImpl.kt:
--------------------------------------------------------------------------------
1 | package tech.devscion.typist
2 |
3 | import androidx.compose.animation.animateContentSize
4 | import androidx.compose.foundation.layout.*
5 | import androidx.compose.material3.Text
6 | import androidx.compose.runtime.Composable
7 | import androidx.compose.runtime.LaunchedEffect
8 | import androidx.compose.runtime.MutableState
9 | import androidx.compose.runtime.mutableIntStateOf
10 | import androidx.compose.runtime.mutableLongStateOf
11 | import androidx.compose.runtime.mutableStateOf
12 | import androidx.compose.runtime.remember
13 | import androidx.compose.ui.Alignment
14 | import androidx.compose.ui.Modifier
15 | import androidx.compose.ui.graphics.Color
16 | import androidx.compose.ui.text.TextStyle
17 | import androidx.compose.ui.unit.dp
18 | import kotlinx.coroutines.delay
19 |
20 |
21 | @Composable
22 | internal fun TypistImpl(
23 | textList: List,
24 | modifier: Modifier = Modifier,
25 | textStyle: TextStyle = TextStyle(),
26 | cursorColor: Color = Color.Black,
27 | typistSpeed: TypistSpeed = TypistSpeed.NORMAL,
28 | isInfiniteCursor: Boolean = true,
29 | isBlinkingCursor: Boolean = true,
30 | isCursorVisible: Boolean = true,
31 | isInfinite: Boolean = false,
32 | cursorSymbol: String = "|",
33 | onAnimationEnd: (() -> Unit)? = null,
34 | onAnimationStart: (() -> Unit)? = null,
35 | ) {
36 |
37 | val currentTextIndex = remember {
38 | mutableIntStateOf(0)
39 | }
40 | val currentText = remember {
41 | mutableStateOf("")
42 | }
43 |
44 | val textChanges = remember {
45 | mutableLongStateOf(1L)
46 | }
47 |
48 | val remainingText = remember {
49 | mutableStateOf(textList[currentTextIndex.intValue])
50 | }
51 |
52 | LaunchedEffect(textList) {
53 | resetTextHandlers(currentText, remainingText, textList[currentTextIndex.intValue])
54 | textChanges.longValue = System.currentTimeMillis()
55 | }
56 |
57 | LaunchedEffect(key1 = textChanges.longValue) {
58 | onAnimationStart?.invoke()
59 | while (remainingText.value.isNotEmpty()) {
60 | currentText.value += remainingText.value.first()
61 | remainingText.value = remainingText.value
62 | .removePrefix("${remainingText.value.first()}")
63 | delay(typistSpeed.value)
64 | }
65 | if (remainingText.value.isEmpty()) {
66 | onAnimationEnd?.invoke()
67 | }
68 | if (textList.size > 1 && currentTextIndex.intValue != textList.size - 1) {
69 | currentTextIndex.intValue++
70 | resetTextHandlers(
71 | currentText, remainingText,
72 | textList[currentTextIndex.intValue]
73 | )
74 | if (isInfinite.not())
75 | textChanges.longValue = System.currentTimeMillis()
76 | } else if (isInfinite && textList.size > 1 && currentTextIndex.intValue == textList.size - 1) {
77 | currentTextIndex.intValue = 0
78 | resetTextHandlers(
79 | currentText, remainingText,
80 | textList[currentTextIndex.intValue]
81 | )
82 | }
83 | if (isInfinite) {
84 | if (textList.size == 1) {
85 | resetTextHandlers(
86 | currentText, remainingText,
87 | textList[currentTextIndex.intValue]
88 | )
89 | }
90 | textChanges.longValue = System.currentTimeMillis()
91 | }
92 | }
93 |
94 | Row(
95 | modifier = modifier
96 | .animateContentSize()
97 | .padding(end = 5.dp),
98 | horizontalArrangement = Arrangement.Start,
99 | verticalAlignment = Alignment.CenterVertically
100 | ) {
101 | Text(
102 | text = currentText.value,
103 | style = textStyle,
104 | )
105 | Spacer(modifier = Modifier.width(2.dp))
106 | if (isCursorVisible) {
107 | val isCursorActive = remainingText.value.isNotEmpty() || isInfiniteCursor
108 | if (isBlinkingCursor && isCursorActive)
109 | BlinkingCursor(
110 | style = textStyle.copy(color = cursorColor),
111 | cursorSymbol = cursorSymbol
112 | )
113 | else if (isCursorActive)
114 | Text(
115 | text = cursorSymbol,
116 | style = textStyle.copy(color = cursorColor),
117 | )
118 | }
119 | }
120 | }
121 |
122 | fun resetTextHandlers(
123 | currentText: MutableState,
124 | remainingText: MutableState,
125 | text: String
126 | ) {
127 | remainingText.value = text
128 | currentText.value = ""
129 | }
130 |
131 |
132 | enum class TypistSpeed(val value: Long) {
133 | NORMAL(200L), SLOW(500L), EXTRA_SLOW(800L),
134 | FAST(100L), EXTRA_FAST(10L)
135 | }
--------------------------------------------------------------------------------
/app/src/main/java/tech/devscion/typistdemo/MainActivity.kt:
--------------------------------------------------------------------------------
1 | package tech.devscion.typistdemo
2 |
3 | import android.os.Bundle
4 | import android.widget.Toast
5 | import androidx.activity.ComponentActivity
6 | import androidx.activity.compose.setContent
7 | import androidx.compose.foundation.layout.Arrangement
8 | import androidx.compose.foundation.layout.Column
9 | import androidx.compose.foundation.layout.Spacer
10 | import androidx.compose.foundation.layout.fillMaxSize
11 | import androidx.compose.foundation.layout.height
12 | import androidx.compose.material3.MaterialTheme
13 | import androidx.compose.material3.Surface
14 | import androidx.compose.ui.Modifier
15 | import androidx.compose.ui.graphics.Color
16 | import androidx.compose.ui.text.TextStyle
17 | import androidx.compose.ui.text.font.FontWeight
18 | import androidx.compose.ui.text.style.TextAlign
19 | import androidx.compose.ui.unit.dp
20 | import androidx.compose.ui.unit.sp
21 | import tech.devscion.typist.Typist
22 | import tech.devscion.typist.TypistSpeed
23 | import tech.devscion.typistdemo.ui.theme.TypistTheme
24 |
25 | class MainActivity : ComponentActivity() {
26 |
27 | override fun onCreate(savedInstanceState: Bundle?) {
28 | super.onCreate(savedInstanceState)
29 | setContent {
30 | TypistTheme {
31 | // A surface container using the 'background' color from the theme
32 | Surface(
33 | modifier = Modifier.fillMaxSize(),
34 | color = MaterialTheme.colorScheme.background
35 | ) {
36 | Column(verticalArrangement = Arrangement.Center,
37 | modifier = Modifier.fillMaxSize()) {
38 | Typist(
39 | text = "Hi! I am Typist.",
40 | typistSpeed = TypistSpeed.FAST,
41 | textStyle = TextStyle(
42 | color = Color.Red,
43 | fontWeight = FontWeight.Bold,
44 | fontSize = 28.sp,
45 | textAlign = TextAlign.Center
46 | ),
47 | isBlinkingCursor = true,
48 | isInfiniteCursor = false,
49 | isCursorVisible = true,
50 | onAnimationEnd = {
51 | Toast.makeText(
52 | applicationContext, "Typed!",
53 | Toast.LENGTH_LONG
54 | )
55 | .show()
56 | }
57 | )
58 | Spacer(modifier = Modifier.height(15.dp))
59 | Typist(
60 | text = "Hi! I am Typist.",
61 | typistSpeed = TypistSpeed.NORMAL,
62 | textStyle = TextStyle(
63 | color = Color.Red,
64 | fontWeight = FontWeight.Bold,
65 | fontSize = 28.sp,
66 | textAlign = TextAlign.Center
67 | ),
68 | isBlinkingCursor = true,
69 | isInfiniteCursor = false,
70 | isCursorVisible = true,
71 | isInfinite = true
72 | )
73 | Spacer(modifier = Modifier.height(15.dp))
74 | Typist(
75 | textList = listOf("Hi! I am Typist.","And I can type multiple times"),
76 | typistSpeed = TypistSpeed.NORMAL,
77 | textStyle = TextStyle(
78 | color = Color.Red,
79 | fontWeight = FontWeight.Bold,
80 | fontSize = 28.sp,
81 | textAlign = TextAlign.Center
82 | ),
83 | isInfinite = true,
84 | isBlinkingCursor = false,
85 | isInfiniteCursor = true,
86 | isCursorVisible = true,
87 | )
88 | Spacer(modifier = Modifier.height(15.dp))
89 | Typist(
90 | textList = listOf("Hi! I am Typist.","And I can type multiple times"),
91 | typistSpeed = TypistSpeed.FAST,
92 | textStyle = TextStyle(
93 | color = Color.Red,
94 | fontWeight = FontWeight.Bold,
95 | fontSize = 28.sp,
96 | textAlign = TextAlign.Center
97 | ),
98 | isBlinkingCursor = true,
99 | isInfiniteCursor = true,
100 | isCursorVisible = true,
101 | )
102 | }
103 | }
104 | }
105 | }
106 | }
107 | }
108 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | We as members, contributors, and leaders pledge to make participation in our
6 | community a harassment-free experience for everyone, regardless of age, body
7 | size, visible or invisible disability, ethnicity, sex characteristics, gender
8 | identity and expression, level of experience, education, socio-economic status,
9 | nationality, personal appearance, race, religion, or sexual identity
10 | and orientation.
11 |
12 | We pledge to act and interact in ways that contribute to an open, welcoming,
13 | diverse, inclusive, and healthy community.
14 |
15 | ## Our Standards
16 |
17 | Examples of behavior that contributes to a positive environment for our
18 | community include:
19 |
20 | * Demonstrating empathy and kindness toward other people
21 | * Being respectful of differing opinions, viewpoints, and experiences
22 | * Giving and gracefully accepting constructive feedback
23 | * Accepting responsibility and apologizing to those affected by our mistakes,
24 | and learning from the experience
25 | * Focusing on what is best not just for us as individuals, but for the
26 | overall community
27 |
28 | Examples of unacceptable behavior include:
29 |
30 | * The use of sexualized language or imagery, and sexual attention or
31 | advances of any kind
32 | * Trolling, insulting or derogatory comments, and personal or political attacks
33 | * Public or private harassment
34 | * Publishing others' private information, such as a physical or email
35 | address, without their explicit permission
36 | * Other conduct which could reasonably be considered inappropriate in a
37 | professional setting
38 |
39 | ## Enforcement Responsibilities
40 |
41 | Community leaders are responsible for clarifying and enforcing our standards of
42 | acceptable behavior and will take appropriate and fair corrective action in
43 | response to any behavior that they deem inappropriate, threatening, offensive,
44 | or harmful.
45 |
46 | Community leaders have the right and responsibility to remove, edit, or reject
47 | comments, commits, code, wiki edits, issues, and other contributions that are
48 | not aligned to this Code of Conduct, and will communicate reasons for moderation
49 | decisions when appropriate.
50 |
51 | ## Scope
52 |
53 | This Code of Conduct applies within all community spaces, and also applies when
54 | an individual is officially representing the community in public spaces.
55 | Examples of representing our community include using an official e-mail address,
56 | posting via an official social media account, or acting as an appointed
57 | representative at an online or offline event.
58 |
59 | ## Enforcement
60 |
61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
62 | reported to the community leaders responsible for enforcement at
63 | .
64 | All complaints will be reviewed and investigated promptly and fairly.
65 |
66 | All community leaders are obligated to respect the privacy and security of the
67 | reporter of any incident.
68 |
69 | ## Enforcement Guidelines
70 |
71 | Community leaders will follow these Community Impact Guidelines in determining
72 | the consequences for any action they deem in violation of this Code of Conduct:
73 |
74 | ### 1. Correction
75 |
76 | **Community Impact**: Use of inappropriate language or other behavior deemed
77 | unprofessional or unwelcome in the community.
78 |
79 | **Consequence**: A private, written warning from community leaders, providing
80 | clarity around the nature of the violation and an explanation of why the
81 | behavior was inappropriate. A public apology may be requested.
82 |
83 | ### 2. Warning
84 |
85 | **Community Impact**: A violation through a single incident or series
86 | of actions.
87 |
88 | **Consequence**: A warning with consequences for continued behavior. No
89 | interaction with the people involved, including unsolicited interaction with
90 | those enforcing the Code of Conduct, for a specified period of time. This
91 | includes avoiding interactions in community spaces as well as external channels
92 | like social media. Violating these terms may lead to a temporary or
93 | permanent ban.
94 |
95 | ### 3. Temporary Ban
96 |
97 | **Community Impact**: A serious violation of community standards, including
98 | sustained inappropriate behavior.
99 |
100 | **Consequence**: A temporary ban from any sort of interaction or public
101 | communication with the community for a specified period of time. No public or
102 | private interaction with the people involved, including unsolicited interaction
103 | with those enforcing the Code of Conduct, is allowed during this period.
104 | Violating these terms may lead to a permanent ban.
105 |
106 | ### 4. Permanent Ban
107 |
108 | **Community Impact**: Demonstrating a pattern of violation of community
109 | standards, including sustained inappropriate behavior, harassment of an
110 | individual, or aggression toward or disparagement of classes of individuals.
111 |
112 | **Consequence**: A permanent ban from any sort of public interaction within
113 | the community.
114 |
115 | ## Attribution
116 |
117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118 | version 2.0, available at
119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120 |
121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct
122 | enforcement ladder](https://github.com/mozilla/diversity).
123 |
124 | [homepage]: https://www.contributor-covenant.org
125 |
126 | For answers to common questions about this code of conduct, see the FAQ at
127 | https://www.contributor-covenant.org/faq. Translations are available at
128 | https://www.contributor-covenant.org/translations.
129 |
--------------------------------------------------------------------------------
/app/src/main/res/drawable/ic_launcher_background.xml:
--------------------------------------------------------------------------------
1 |
2 |
7 |
10 |
15 |
20 |
25 |
30 |
35 |
40 |
45 |
50 |
55 |
60 |
65 |
70 |
75 |
80 |
85 |
90 |
95 |
100 |
105 |
110 |
115 |
120 |
125 |
130 |
135 |
140 |
145 |
150 |
155 |
160 |
165 |
170 |
171 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 |
3 | #
4 | # Copyright 2015 the original author or authors.
5 | #
6 | # Licensed under the Apache License, Version 2.0 (the "License");
7 | # you may not use this file except in compliance with the License.
8 | # You may obtain a copy of the License at
9 | #
10 | # https://www.apache.org/licenses/LICENSE-2.0
11 | #
12 | # Unless required by applicable law or agreed to in writing, software
13 | # distributed under the License is distributed on an "AS IS" BASIS,
14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | # See the License for the specific language governing permissions and
16 | # limitations under the License.
17 | #
18 |
19 | ##############################################################################
20 | ##
21 | ## Gradle start up script for UN*X
22 | ##
23 | ##############################################################################
24 |
25 | # Attempt to set APP_HOME
26 | # Resolve links: $0 may be a link
27 | PRG="$0"
28 | # Need this for relative symlinks.
29 | while [ -h "$PRG" ] ; do
30 | ls=`ls -ld "$PRG"`
31 | link=`expr "$ls" : '.*-> \(.*\)$'`
32 | if expr "$link" : '/.*' > /dev/null; then
33 | PRG="$link"
34 | else
35 | PRG=`dirname "$PRG"`"/$link"
36 | fi
37 | done
38 | SAVED="`pwd`"
39 | cd "`dirname \"$PRG\"`/" >/dev/null
40 | APP_HOME="`pwd -P`"
41 | cd "$SAVED" >/dev/null
42 |
43 | APP_NAME="Gradle"
44 | APP_BASE_NAME=`basename "$0"`
45 |
46 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
47 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
48 |
49 | # Use the maximum available, or set MAX_FD != -1 to use that value.
50 | MAX_FD="maximum"
51 |
52 | warn () {
53 | echo "$*"
54 | }
55 |
56 | die () {
57 | echo
58 | echo "$*"
59 | echo
60 | exit 1
61 | }
62 |
63 | # OS specific support (must be 'true' or 'false').
64 | cygwin=false
65 | msys=false
66 | darwin=false
67 | nonstop=false
68 | case "`uname`" in
69 | CYGWIN* )
70 | cygwin=true
71 | ;;
72 | Darwin* )
73 | darwin=true
74 | ;;
75 | MINGW* )
76 | msys=true
77 | ;;
78 | NONSTOP* )
79 | nonstop=true
80 | ;;
81 | esac
82 |
83 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
84 |
85 |
86 | # Determine the Java command to use to start the JVM.
87 | if [ -n "$JAVA_HOME" ] ; then
88 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
89 | # IBM's JDK on AIX uses strange locations for the executables
90 | JAVACMD="$JAVA_HOME/jre/sh/java"
91 | else
92 | JAVACMD="$JAVA_HOME/bin/java"
93 | fi
94 | if [ ! -x "$JAVACMD" ] ; then
95 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
96 |
97 | Please set the JAVA_HOME variable in your environment to match the
98 | location of your Java installation."
99 | fi
100 | else
101 | JAVACMD="java"
102 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
103 |
104 | Please set the JAVA_HOME variable in your environment to match the
105 | location of your Java installation."
106 | fi
107 |
108 | # Increase the maximum file descriptors if we can.
109 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
110 | MAX_FD_LIMIT=`ulimit -H -n`
111 | if [ $? -eq 0 ] ; then
112 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
113 | MAX_FD="$MAX_FD_LIMIT"
114 | fi
115 | ulimit -n $MAX_FD
116 | if [ $? -ne 0 ] ; then
117 | warn "Could not set maximum file descriptor limit: $MAX_FD"
118 | fi
119 | else
120 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
121 | fi
122 | fi
123 |
124 | # For Darwin, add options to specify how the application appears in the dock
125 | if $darwin; then
126 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
127 | fi
128 |
129 | # For Cygwin or MSYS, switch paths to Windows format before running java
130 | if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
131 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
132 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
133 |
134 | JAVACMD=`cygpath --unix "$JAVACMD"`
135 |
136 | # We build the pattern for arguments to be converted via cygpath
137 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
138 | SEP=""
139 | for dir in $ROOTDIRSRAW ; do
140 | ROOTDIRS="$ROOTDIRS$SEP$dir"
141 | SEP="|"
142 | done
143 | OURCYGPATTERN="(^($ROOTDIRS))"
144 | # Add a user-defined pattern to the cygpath arguments
145 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
146 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
147 | fi
148 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
149 | i=0
150 | for arg in "$@" ; do
151 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
152 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
153 |
154 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
155 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
156 | else
157 | eval `echo args$i`="\"$arg\""
158 | fi
159 | i=`expr $i + 1`
160 | done
161 | case $i in
162 | 0) set -- ;;
163 | 1) set -- "$args0" ;;
164 | 2) set -- "$args0" "$args1" ;;
165 | 3) set -- "$args0" "$args1" "$args2" ;;
166 | 4) set -- "$args0" "$args1" "$args2" "$args3" ;;
167 | 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
168 | 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
169 | 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
170 | 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
171 | 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
172 | esac
173 | fi
174 |
175 | # Escape application args
176 | save () {
177 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
178 | echo " "
179 | }
180 | APP_ARGS=`save "$@"`
181 |
182 | # Collect all arguments for the java command, following the shell quoting and substitution rules
183 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
184 |
185 | exec "$JAVACMD" "$@"
186 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------