Configure Overlays

PhotoEditor SDK supports several configuration options for the overlay tool allowing flexible adaptation to different needs and use cases. For a detailed explanation of how to configure different editor views, refer to this guide.

`blendModes`#

When selecting an overlay in the overlay tool, the user can switch between several blend modes. The allowed blend modes can be customized using the blendModes property. By default, the editor has all available blend modes for this tool enabled. For this example only a couple modes are enabled.


import { BlendMode, Configuration, PESDK } from "react-native-photoeditorsdk";

export const photoOverlayConfigurationExample = async (): Promise<void> => {
  // Add a photo from the assets directory.
  const photo = require("../../../../assets/pesdk/LA.jpg");

  // Create a `Configuration` object.
  const configuration: Configuration = {
    overlay: {
      // By default, all available blend modes are enabled.
      // For this example, only a couple are enabled for usage.
      blendModes: [
        BlendMode.COLOR_BURN,
        BlendMode.DARKEN,
        BlendMode.HARD_LIGHT,
        BlendMode.LIGHTEN,
      ],
    },
  };

  try {
    // Open the photo editor and handle the export as well as any occuring errors.
    const result = await PESDK.openEditor(photo, configuration);

    if (result != null) {
      // The user exported a new photo successfully and the newly generated photo is located at `result.image`.
      console.log(result.image);
    } else {
      // The user tapped on the cancel button within the editor.
      return;
    }
  } catch (error) {
    // There was an error generating the photo.
    console.log(error);
  }
};

Configure Overlays

blendModes#

`blendModes`#