This tool will crop and resize JPEG and PNG source images to generate images for modern iOS and Android devices.
bridge-res
must run at the root of a Cordova project, such as:
resources/
├── icon.png
└── splash.png
config.xml
resources/icon.png
must be at least 1024×1024pxresources/splash.png
must be at least 2732×2732px
Android Adaptive Icons are also supported. If you choose to use them, create the following additional file(s):
resources/android/icon-foreground.png
must be at least 432×432pxresources/android/icon-background.png
must be at least 432×432px
If adaptive icons are used, regular Android icons are not generated.
A color may also be used for the icon background by specifying the --icon-background-source
option with a hex color code, e.g. --icon-background-source '#FFFFFF'
.
$ npm install -g bridge-res
See the help documentation on the command line with the --help
option.
$ bridge-res --help
bridge-res
can be used programmatically.
const run = require('bridge-res');
await run();
run()
takes an options object described by the interface Options
. If options are provided, resources are generated in an explicit, opt-in manner. In the following example, only Android icons and iOS splash screens are generated.
import { Options, run } from 'bridge-res';
const options: Options = {
directory: '/path/to/project',
resourcesDirectory: 'resources',
logstream: process.stdout, // Any WritableStream
platforms: {
android: { icon: { sources: ['resources/icon.png'] } },
ios: { splash: { sources: ['resources/splash.png'] } },
},
};
await run(options);