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

Package-level declarations

Types

data class EditorConfiguration(val onCreate: suspend EditorScope.() -> Unit?, val onLoaded: suspend EditorScope.() -> Unit?, val onExport: suspend EditorScope.() -> Unit?, val onClose: suspend EditorScope.() -> Unit?, val onEvent: EditorScope.(EditorEvent) -> Unit?, val onUpload: suspend EditorScope.(AssetDefinition, UploadAssetSourceType) -> AssetDefinition?, val onError: suspend EditorScope.(Throwable) -> Unit?, val colorPalette: List<Color>?, val assetLibrary: AssetLibrary?, val dock: EditorComponent<*>?, val navigationBar: EditorComponent<*>?, val inspectorBar: EditorComponent<*>?, val canvasMenu: EditorComponent<*>?, val bottomPanel: EditorComponent<*>?, val overlay: EditorComponent<*>?)

Configuration class of the editor.

EditorConfigurationBuilder

@Stable

open class EditorConfigurationBuilder

Basic builder class for EditorConfiguration.

Functions

remember

@Composable

fun EditorConfiguration.Companion.remember(builder: EditorConfigurationBuilder.() -> Unit = {}): EditorConfiguration

A composable overload for EditorConfiguration.Companion.remember that uses EditorConfigurationBuilder to create and remember an EditorConfiguration instance. Check the documentation of overloaded EditorConfiguration.Companion.remember function below for more details. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions:

@Composable

fun <Builder : EditorConfigurationBuilder> EditorConfiguration.Companion.remember(builderFactory: () -> Builder, builder: Builder.() -> Unit = {}): EditorConfiguration

A composable function that creates and remembers an EditorConfiguration instance. Check the documentation of overloaded EditorConfiguration.Companion.remember function below for more details. Note that both builderFactory and builder lambdas run only once, therefore you should not have builder property reassignments based on conditions:

then

@Composable

fun EditorConfiguration.then(builder: EditorConfigurationBuilder.() -> Unit = {}): EditorConfiguration

A composable overload for EditorConfiguration.then that uses EditorConfigurationBuilder to create and remember an EditorConfiguration instance. Check the documentation of overloaded EditorConfiguration.then function below for more details. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions:

@Composable

fun <Builder : EditorConfigurationBuilder> EditorConfiguration.then(builderFactory: () -> Builder, builder: Builder.() -> Unit = {}): EditorConfiguration

A composable function that creates and remembers an EditorConfiguration instance on top of an existing EditorConfiguration. Existing configuration effectively becomes the parent configuration for the newly created EditorConfiguration. It is useful to use this function when you want to extend the editor configuration by preexisting EditorConfigurationBuilders, such as plugins provided by IMG.LY.