Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@capacitor-community/app-icon
Advanced tools
Readme
@capacitor-community/app-icon
Capacitor community plugin for managing an app's icon. The main feature being that you can programmatically change the app icon.
Maintainer | GitHub | Social |
---|---|---|
John Borges | johnborges | @johnborges |
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)
Changing the app icon is only allowed when the app is in the foreground (iOS).
Android support is currently in beta. See the android-support branch for more info.
npm install @capacitor-community/app-icon
npx cap sync
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.
Add the alternate icons directly to your android project in app/src/main/res
.
Each alternate icon is represented by an <activity-alias>
. 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 for full example.
<application>
<!-- ... -->
<activity
android:name=".MainActivity"
android:exported="true"
android:launchMode="singleTask"
android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|smallestScreenSize|screenLayout|uiMode"
android:label="@string/title_activity_main"
android:theme="@style/AppTheme.NoActionBarLaunch">
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<!-- <category android:name="android.intent.category.LAUNCHER" /> -->
</intent-filter>
</activity>
<activity-alias
android:label="Stencil"
android:icon="@drawable/stencil"
android:roundIcon="@drawable/stencil"
android:name=".stencil"
android:enabled="true"
android:exported="true"
android:targetActivity=".MainActivity">
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity-alias>
<!-- additional <activity-alias> -->
<application>
Taken from https://www.youtube.com/watch?v=AT89ofYpWTU
In XCode go to Assets and create the App Icons.
Then fill with images 1024x1024px
The name of the asset should correspond to the name used in the code
Include All App Icon Assets
Alternate App Icon Sets
) with precise names of the app icons in the Assets Catalogue.import { AppIcon } from '@capacitor-community/app-icon';
const changeIcon = async (iconName) => {
await AppIcon.change({name: iconName, suppressNotification: true});
}
const getName = async () => {
const { value } = await AppIcon.getName();
console.log(value);
}
const resetIcon = async () => {
const disable: string[] = ['stencil']; // all added aliaces names
await AppIcon.reset({ suppressNotification: true, disable });
}
isSupported() => Promise<{ value: boolean; }>
Checks if changing the app icon is supported. (iOS only)
Returns: Promise<{ value: boolean; }>
Since: 1.0.0
getName() => Promise<{ value: string | null; }>
Gets the name of currently set alternate icon. If original icon is set, returns null.
Returns: Promise<{ value: string | null; }>
Since: 1.0.0
change(options: IconOptions) => Promise<void>
Changes app icon to specified alternate.
Param | Type |
---|---|
options | IconOptions |
Since: 1.0.0
reset(options: ResetOptions) => Promise<void>
Reverts app icon to original.
Param | Type |
---|---|
options | ResetOptions |
Since: 1.0.0
Prop | Type | Description | Since |
---|---|---|---|
name | string | Name of alternate icon to set | |
disable | string[] | Name of icons to disable. This is not used for iOS, but required for Android. | 3.1.0 |
suppressNotification | boolean | Flag controlling the in app notification which shows after icon is changed. (iOS) |
Prop | Type | Description | Since |
---|---|---|---|
suppressNotification | boolean | Flag controlling the in app notification which shows after icon is changed (iOS). | |
disable | string[] | Name of icons to disable. This is not used for iOS, but required for Android. | 3.1.1 |
Thanks goes to these wonderful people (emoji key):
John Borges 💻 | Simon Grimm 💻 | Christian von Rohr 💻 | QliQ.dev 💻 | Hadouin 📖 |
This project follows the all-contributors specification. Contributions of any kind welcome!
FAQs
Capacitor community plugin for changing an iOS app icon.
The npm package @capacitor-community/app-icon receives a total of 1,717 weekly downloads. As such, @capacitor-community/app-icon popularity was classified as popular.
We found that @capacitor-community/app-icon demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 43 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.