PESDK/React Native/Guides
Configuration
The PhotoEditor SDK for React Native can easily be tailored to meet your business needs. Learn how to swiftly create the editor your use-case requires.
You can easily configure the editor to disable specific tools, hide buttons, add specific assets etc. by adding a configuration object to the PESDK.openEditor method.
Configuration options#
The configuration has two types of options:
1. Global#
Global configuration options are applied globally in the entire editor. The main options are:
| Key | Type | Description |
|---|---|---|
Key forceCrop | Type boolean | Description Defines whether the user is forced to crop the asset to one of the allowed crop ratios. |
Key mainCanvasActions | Type array | Description Defines all allowed actions for the main screen that are displayed as overlay buttons on the canvas. |
Key enableZoom | Type boolean | Description Defines if the user is able to use the zoom feature. |
Key snapping | Type object | Description Options to change the snapping behaviour of sprites in the Sticker, Text and Text Design tool. |
Key watermark | Type object | Description Define a watermark for each image. |
Key tools | Type array | Description Defines which tools are available and their order. |
Key export | Type object | Description Configure the image export. |
Key serialization | Type object | Description Configure the serialization behavior. |
Key theme | Type string | Description Defines which theme is used for the editor (iOS only). |
Key custom | Type object | Description Options to add custom themes (iOS only). |
2. Tool-specific#
Furthermore, you have the option to configure specific tools. The tool options are:
| Key | Type | Description |
|---|---|---|
Key transform | Type object | Description Configure the Transform tool. |
Key filter | Type object | Description Configure the Filter tool. |
Key adjustment | Type object | Description Configure the Adjustment tool. |
Key focus | Type object | Description Configure the Focus tool. |
Key sticker | Type object | Description Configure the Sticker tool. |
Key text | Type object | Description Configure the Text tool. |
Key textdesign | Type object | Description Configure the Text design tool. |
Key overlay | Type object | Description Configure the Overlay tool. |
Key frame | Type object | Description Configure the Frame tool. |
Key brush | Type object | Description Configure the Brush tool. |