Skip to main content

Stickers

Stickers are PNG images that users can drag, scale, and position on top of the photo. You supply the image assets in your native project and pass the corresponding resource names to the editor at runtime.

How it works​

  1. You add PNG files to your native project resources.
  2. You pass the file name (without extension) in the stickers array.
  3. The editor looks up each name using the platform's native resource system.
  4. Images that can't be resolved are silently skipped.
ImageEditor.open({
path: imagePath,
stickers: ['sticker_heart', 'sticker_star', 'sticker_fire'],
onDone: (path) => console.log(path),
onCancel: () => {},
});

Adding sticker assets​

  1. In Xcode, open your project's navigator.
  2. Select the target's Resources group (or create one).
  3. Drag your .png files in. Make sure "Add to target" is checked for your app target.
  4. Pass the filename without extension in the stickers array:
stickers: ['heart', 'star'] // files: heart.png, star.png in Resources

:::tip Asset Catalog alternative You can also add stickers to an Assets.xcassets catalog. Use the image set name (without .imageset) as the sticker name. :::


Example — 11 stickers from the Example app​

The reference Example/ project ships 11 stickers named sticker0 through sticker10:

ImageEditor.open({
path: RNFS.DocumentDirectoryPath + '/photo.jpg',
stickers: [
'sticker0',
'sticker1',
'sticker2',
'sticker3',
'sticker4',
'sticker5',
'sticker6',
'sticker7',
'sticker8',
'sticker9',
'sticker10',
],
onDone: (path) => console.log('done', path),
onCancel: () => {},
});

Hiding the sticker panel​

If your app doesn't use stickers at all, pass 'sticker' in hiddenControls to remove the sticker button from the toolbar:

ImageEditor.open({
path: imagePath,
hiddenControls: ['sticker'],
onDone: (path) => {},
onCancel: () => {},
});

Troubleshooting​

Stickers don't appear in the picker

  • Confirm the file exists in the right resource location for the platform.
  • On Android, verify the filename is all lowercase and contains only valid characters.
  • On iOS, confirm the file is included in the correct target ("Add to target" was checked).

Tapping a sticker crashes on Android

  • This was a known bug prior to v1.0.3 caused by missing layout resources in the bundled photo-editor-android.jar. Update to v1.0.3 or later.

See Troubleshooting for more details.