Skip to main content
Language

From Remote URL

PhotoEditor SDK supports adding custom frames from a remote URL, this can be a resource hosted by a hosting provider or your servers. The frame tool is optimized for remote resources. This allows directly integrating a remote URL instead of downloading the asset before. For an example of how to download the remote resources in advance and use the local downloaded resources, see the font example.

Adding Frames#

Custom frames can be added by specifying them in the configuration.frame.items array. Each frame takes a unique identifier, a name, a relativeScale, an optional thumbnailURI as well as an optional layoutMode.

Image Groups#

To add the actual images for each frame tile, you can specify them inside the imageGroups property. Each frame consists of four groups corresponding to each side of the frame. In our example, we opt for the "horizontal inside" mode of arranging image tiles providing only a middle image for the left and right parts of the frame and a start, middle and end image for the top and bottom parts. Refer to the guide on frames for an in-depth explanation.

Image Modes#

By default, the midMode is set to FrameTileMode.REPEAT which repeats the middle image to fill out the entire space. For this example, it is set to FrameTileMode.STRETCH for all image groups to keep the correct pattern. In this mode, the middle image is stretched to fill out the entire space.

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


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


    // For the sake of readability, the base URL of all remote URLs is
    // extracted in this example.
    const baseURL = "https://www.img.ly/static/example-assets/";


    // Create a `Configuration` object.
    //
    // The frame tool is optimized for remote resources which allows to directly
    // integrate a remote URL instead of downloading the asset before. For an
    // example on how to download the remote resources in advance and use the local
    // downloaded resources, see: src/examples/text/addFonts/fromRemoteURL.
    //
    // By default the `midMode` is set to `FrameTileMode.REPEAT` which repeats
    // the middle image to fill out the entire space.
    // For this example it is set to `FrameTileMode.STRETCH` for all image groups
    // to keep the correct pattern. In this mode, the middle image is
    // stretched to fill out the entire space.
    const configuration: Configuration = {
      frame: {
        items: [
          {
            identifier: "custom_frame",
            name: "Custom",
            thumbnailURI: baseURL + "imgly_frame_lowpoly_thumbnail.png",
            relativeScale: 0.1,
            imageGroups: {
              top: {
                midURI: baseURL + "imgly_frame_lowpoly_top.png",
                startURI: baseURL + "imgly_frame_lowpoly_top_left.png",
                endURI: baseURL + "imgly_frame_lowpoly_top_right.png",
                midMode: FrameTileMode.STRETCH,
              },
              left: {
                midURI: baseURL + "imgly_frame_lowpoly_left.png",
                midMode: FrameTileMode.STRETCH,
              },
              right: {
                midURI: baseURL + "imgly_frame_lowpoly_right.png",
                midMode: FrameTileMode.STRETCH,
              },
              bottom: {
                midURI: baseURL + "imgly_frame_lowpoly_bottom.png",
                startURI: baseURL + "imgly_frame_lowpoly_bottom_left.png",
                endURI: baseURL + "imgly_frame_lowpoly_bottom_right.png",
                midMode: FrameTileMode.STRETCH,
              },
            },
          },
        ],
      },
    };


    // 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);
  }
};