ly.img:editor-core/ly.img.editor.core/EditorContext

EditorContext

interface EditorContext

An umbrella interface containing all the useful properties and functions of the current editor: Following can be found:

Properties that were provided when calling the Editor composable.
Engine, EditorEventHandler and Activity of the current editor.
CoroutineScope of the current editor.
Collectable EditorState of the editor.

Inheritors

MutableEditorContext

Properties

abstract val activity: Activity

The activity where the current editor is running.

abstract val baseUri: Uri

The baseUri provided via param when launching the editor.

abstract val configuration: StateFlow<EditorConfiguration?>

The configuration of the current editor.

abstract val coroutineScope: CoroutineScope

The coroutine scope that is always alive while editor is running. It also survives configuration changes.

currentLanguageCode

val EditorContext.currentLanguageCode: String

The current language code derived from the Activity's configuration (e.g., "en", "de").

abstract val engine: Engine

The engine of the current editor.

abstract val eventHandler: EditorEventHandler

The event handler of the current editor.

abstract val host: String

The integration context embedding the engine, used for license matching.

abstract val license: String?

The license provided via param when launching the editor.

abstract val state: StateFlow<EditorState>

The state flow of the EditorState.

abstract val userId: String?

The userId provided via param when launching the editor.

Functions

abstract fun <T> mutableStateOf(key: String, initial: T): MutableState<T>

MutableState provider for storing custom content in the editor scope. All state values will survive configuration changes and will be available until exiting the editor.

abstract fun <T> stateOf(key: String): State<T>

State provider to access the state, previously declared via mutableStateOf.