Interface: TextToImageAppConfig

Property

Type

Description

Inherited from

Property to pass analytics data to the host app

AppConfig.analyticsData

Flag to explicitly opt-in to use client authentication. When true, client access token will be fetched from the partner and used in the module. This is only relevant for Edit Image and Text to Image modules. Should not be passed for other workflows. Default false

AppConfig.useClientAuth

-

AppConfig.callbacks

Record<string, string>

Property to pass metadata to target application

AppConfig.metaData

Theming options for the TextToImage Editor header bar. Default ColorTheme.LIGHT

TextToImageAppConfig.headerBarColorTheme

Property to configure the title

TextToImageAppConfig.editorTitle

-

TextToImageAppConfig.promptText

Placeholder text for the prompt input field. This text will be displayed in the input field when it is empty, guiding users on what to enter.

TextToImageAppConfig.promptInputPlaceholder

The dimensions of the image that the user can generate. If provided, the user will be restricted to generating images of the specified dimensions.

TextToImageAppConfig.imageDimensions

Asset to be passed as style reference for generating images

TextToImageAppConfig.imageStyleReference

Asset to be passed as composition reference for generating images

TextToImageAppConfig.imageCompositionReference

Specifies the version of the Generate Image experience to be enabled. This setting allows the selection between the older and the newer interface version. When set to the latest version (V2), users will get access to the updated interface and features. By default, the older experience (V1) is displayed. Enabling the latest version introduces the following key features: - Enhanced User Interface: Redesigned with a new Carousel and Grid view. - Community Wall: An endless collection of generated images with prompts that users can select from to kickstart their image generation journey. - Fast Mode: Images can be generated faster with lesser details, great for simple topics, backgrounds, most illustrations, and close portraits. - Improved Prompt Bar: Includes prompt suggestions for a better user experience. - Rich Previews: Provides a more interactive and engaging preview experience. - And more! Default V1

TextToImageAppConfig.appVersion

EditDropdownOptionConfig[]

Options to be passed for Edit dropdown. NOTE: This property is supported only in the new Generate Image experience. Default [ { option: EditFurtherIntent.APPLY_ADJUSTMENT }, { option: EditFurtherIntent.APPLY_EFFECTS }, { option: EditFurtherIntent.REMOVE_BACKGROUND }, { option: EditFurtherIntent.REMOVE_OBJECT }, { option: EditFurtherIntent.INSERT_OBJECT } ]

TextToImageAppConfig.editDropdownOptions

Config to be set for Publish action. NOTE: This property is supported only in the new Generate Image experience. Default { * id: "saveToHostApp", * label: "Save", * outputType: "base64" * }

TextToImageAppConfig.publishConfig

ThumbnailOption[]

Options passed to be displayed on the thumbnail. NOTE: This property is supported only in the new Generate Image experience. Default [ ThumbnailOption.EDIT_DROPDOWN, ThumbnailOption.RICH_PREVIEW ]

TextToImageAppConfig.thumbnailOptions

Configuration for enabling or disabling fast mode in the Text to Image module. NOTE: This property is supported only in the new Generate Image experience and when FAST_MODE is set to true in featureConfig. Default { * defaultFastModeState: 'off' * }

TextToImageAppConfig.fastModeConfig

Partial<Record<TextToImageFeature, boolean>>

Configuration for enabling or disabling specific features in the Text to Image module. NOTE: This property is supported only in the new Generate Image experience. Default { * [TextToImageFeatureType.COMMUNITY_WALL]: false, * [TextToImageFeatureType.FAST_MODE]: false * }

TextToImageAppConfig.featureConfig

-

TextToImageAppConfig.communityWallConfig

(prompt) => Promise<PromptSafetyCheckResponse>

Callback to check if a prompt is safe for image generation. This allows partners to implement their own prompt moderation logic.

TextToImageAppConfig.isPromptSafe

Flag to hide feedback menu in the header bar. Default false

TextToImageAppConfig.hideFeedbackMenu

Configuration for panel settings. Allows users to customize various options that affect the image generation process.

TextToImageAppConfig.panelSettings