Single tool use

View on GitHub

When you want customers to perform only one action on the photo, you can use single tool mode on PhotoEditor SDK. Single tool mode supported tools are Transform, Filters, Adjustments, Focus, Overlays, and Brush.

To open the editor in single tool mode, two constraints need to be satisfied. You need to set singleToolUsage to true (set by default) and make sure you only set one tool to be available in tools.

The tool menu items displayed in the main menu can be configured through the configuration.tools option and takes an array of Tools, so we will set the array to only include the tool item we want to use.

Make sure your license includes the tool you want to use. For further information on the configuration.tools option please refer to our dedicated section.


import 'package:catalog/models/code_example.dart';
import 'package:imgly_sdk/imgly_sdk.dart';
import 'package:photo_editor_sdk/photo_editor_sdk.dart';

class PhotoSingleToolExample extends CodeExample {
  @override
  void invoke() async {
    // Create a [Configuration] instance.
    final configuration = Configuration(
        // In this example, the single tool mode is enabled.
        singleToolMode: true,
        // To determine which tool is used, we need to assign it.
        // For this example, we only use the transform tool.
        tools: [Tool.transform]
        );
    try {
      // Open the photo editor and handle the export as well as any occurring errors.
      final result = await PESDK.openEditor(
          image: "assets/LA.jpg", configuration: configuration);

      if (result != null) {
        // The user exported a new photo successfully and the newly generated photo is located at `result.image`.
        print(result.image);
      } else {
        // The user exported a new photo successfully and the newly generated photo is located at `result.image`.
        return;
      }
    } catch (error) {
      // The user exported a new photo successfully and the newly generated photo is located at `result.image`.
      print(error);
    }
  }
}

Single tool use

Configure menu items#