Skip to content

Commit 2db3412

Browse files
committed
feat: add initial android support
1 parent 5775928 commit 2db3412

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+2022
-5596
lines changed

README.md

Lines changed: 52 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<h3 align="center">App Icon</h3>
33
<p align="center"><strong><code>@capacitor-community/app-icon</code></strong></p>
44
<p align="center">
5-
Capacitor community plugin for managing an iOS app's icon. The main feature being that you can programmatically change the app icon.
5+
Capacitor community plugin for managing an app's icon. The main feature being that you can programmatically change the app icon.
66
</p>
77

88
<p align="center">
@@ -24,9 +24,9 @@
2424

2525
## Before Starting
2626

27-
> This plugin only changes the main app icon on the device homescreen. The icon in springboard and in other areas of iOS will not change and continue to show the original.
27+
> This plugin only changes the main app icon on the device homescreen. The icon in springboard and in other areas will not change and continue to show the original. (iOS)
2828
29-
> Changing the app icon is only allowed when the app is in the foreground.
29+
> Changing the app icon is only allowed when the app is in the foreground (iOS).
3030
3131
## Installation
3232

@@ -37,9 +37,57 @@ npx cap sync
3737

3838
## Configuration
3939

40+
The alternate icons need to be included within the app bundle and referenced in the project prior to using this plugin. It is not possible to switch to any icon on the fly without adding it to the project first. Below are the configurations steps for each platform.
41+
42+
## Android Configuration
43+
4044
### Add Alternate Icons
4145

42-
The alternate icons need to be included within the app bundle and referenced in the iOS project `Info.plist` prior to using this plugin. It is not possible to switch to any icon on the fly without adding it to the iOS project first.
46+
Add the alternate icons directly to your android project in `app/src/main/res`.
47+
48+
### Setup ApplicationManifest.xml
49+
50+
Each alternate icon is represented by an [`<activity-alias>`](https://developer.android.com/guide/topics/manifest/activity-alias-element). Add all the alternative icons to the `ApplicationManifest.xml` as child elements under `<application>`. The `name` attribute on `<activity-alias>` must be prefixed with dot `.` See [ApplicationManifest.xml](https://github.com/capacitor-community/app-icon/blob/android-support/example/android/app/src/main/AndroidManifest.xml) for full example.
51+
52+
```xml
53+
<application>
54+
<!-- ... -->
55+
<activity
56+
android:name=".MainActivity"
57+
android:exported="true"
58+
android:launchMode="singleTask"
59+
android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|smallestScreenSize|screenLayout|uiMode"
60+
android:label="@string/title_activity_main"
61+
android:theme="@style/AppTheme.NoActionBarLaunch">
62+
63+
<intent-filter>
64+
<action android:name="android.intent.action.MAIN" />
65+
<!-- <category android:name="android.intent.category.LAUNCHER" /> -->
66+
</intent-filter>
67+
68+
</activity>
69+
<activity-alias
70+
android:label="Stencil"
71+
android:icon="@drawable/stencil"
72+
android:roundIcon="@drawable/stencil"
73+
android:name=".stencil"
74+
android:enabled="true"
75+
android:exported="true"
76+
android:targetActivity=".MainActivity">
77+
<intent-filter>
78+
<action android:name="android.intent.action.MAIN" />
79+
<category android:name="android.intent.category.LAUNCHER" />
80+
</intent-filter>
81+
</activity-alias>
82+
83+
<!-- additional <activity-alias> -->
84+
85+
<application>
86+
```
87+
88+
## iOS Configuration
89+
90+
### Add Alternate Icons
4391

4492
Add the alternate icons directly to your iOS project or in a subdirectory.
4593

android/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/build

android/build.gradle

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
ext {
2+
junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
3+
androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.4.2'
4+
androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.3'
5+
androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.4.0'
6+
}
7+
8+
buildscript {
9+
repositories {
10+
google()
11+
mavenCentral()
12+
}
13+
dependencies {
14+
classpath 'com.android.tools.build:gradle:7.2.1'
15+
}
16+
}
17+
18+
apply plugin: 'com.android.library'
19+
20+
android {
21+
compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 32
22+
defaultConfig {
23+
minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
24+
targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 32
25+
versionCode 1
26+
versionName "1.0"
27+
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
28+
}
29+
buildTypes {
30+
release {
31+
minifyEnabled false
32+
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
33+
}
34+
}
35+
lintOptions {
36+
abortOnError false
37+
}
38+
compileOptions {
39+
sourceCompatibility JavaVersion.VERSION_11
40+
targetCompatibility JavaVersion.VERSION_11
41+
}
42+
}
43+
44+
repositories {
45+
google()
46+
mavenCentral()
47+
}
48+
49+
50+
dependencies {
51+
implementation fileTree(dir: 'libs', include: ['*.jar'])
52+
implementation project(':capacitor-android')
53+
implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
54+
testImplementation "junit:junit:$junitVersion"
55+
androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
56+
androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
57+
}

android/gradle.properties

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Project-wide Gradle settings.
2+
3+
# IDE (e.g. Android Studio) users:
4+
# Gradle settings configured through the IDE *will override*
5+
# any settings specified in this file.
6+
7+
# For more details on how to configure your build environment visit
8+
# http://www.gradle.org/docs/current/userguide/build_environment.html
9+
10+
# Specifies the JVM arguments used for the daemon process.
11+
# The setting is particularly useful for tweaking memory settings.
12+
org.gradle.jvmargs=-Xmx1536m
13+
14+
# When configured, Gradle will run in incubating parallel mode.
15+
# This option should only be used with decoupled projects. More details, visit
16+
# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
17+
# org.gradle.parallel=true
18+
19+
# AndroidX package structure to make it clearer which packages are bundled with the
20+
# Android operating system, and which are packaged with your app's APK
21+
# https://developer.android.com/topic/libraries/support-library/androidx-rn
22+
android.useAndroidX=true
23+
# Automatically convert third-party libraries to use AndroidX
24+
android.enableJetifier=true
58.4 KB
Binary file not shown.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
distributionBase=GRADLE_USER_HOME
2+
distributionPath=wrapper/dists
3+
distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-all.zip
4+
zipStoreBase=GRADLE_USER_HOME
5+
zipStorePath=wrapper/dists

android/gradlew

Lines changed: 185 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)