Package-level declarations

Types

Link copied to clipboard

Abstract builder class for Button.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Abstract builder class for Dock.

Link copied to clipboard
data class Button<Scope : EditorScope>(val scope: Scope, val id: EditorComponentId, val modifier: Modifier, val visible: Boolean, val enterTransition: EnterTransition, val exitTransition: ExitTransition, val decoration: ScopedDecoration<Scope>, val onClick: Scope.() -> Unit, val icon: @Composable Scope.() -> Unit?, val text: @Composable Scope.() -> Unit?, val tint: Color, val enabled: Boolean, val contentPadding: PaddingValues, val containerColor: Color) : EditorComponent<Scope>

A component for rendering an icon button. Check AbstractButtonBuilder and its superclasses to see what each property does.

Link copied to clipboard
data class CanvasMenu<Scope : CanvasMenu.Scope>(val scope: Scope, val id: EditorComponentId, val modifier: Modifier, val visible: Boolean, val enterTransition: EnterTransition, val exitTransition: ExitTransition, val decoration: ScopedDecoration<Scope>, val listBuilder: HorizontalListBuilder<EditorComponent<*>>, val itemDecoration: ScopedDecoration<Scope>) : EditorComponent<Scope>

A component for rendering the canvas menu next to a design block when it is selected. Use CanvasMenu.Companion.remember composable function to create an instance of this class. Check AbstractCanvasMenuBuilder and its superclasses to see what each property does.

Link copied to clipboard
Link copied to clipboard
data class Divider<Scope : EditorScope>(val scope: Scope, val id: EditorComponentId, val modifier: Modifier, val visible: Boolean, val enterTransition: EnterTransition, val exitTransition: ExitTransition, val decoration: ScopedDecoration<Scope>) : EditorComponent<Scope>

A component that represents a divider.

Link copied to clipboard
data class Dock<Scope : Dock.Scope>(val scope: Scope, val id: EditorComponentId, val modifier: Modifier, val visible: Boolean, val enterTransition: EnterTransition, val exitTransition: ExitTransition, val decoration: ScopedDecoration<Scope>, val listBuilder: HorizontalListBuilder<EditorComponent<*>>, val horizontalArrangement: Arrangement.Horizontal, val itemDecoration: ScopedDecoration<Scope>) : EditorComponent<Scope>

A component for rendering the dock at the bottom of the editor. Use Dock.Companion.remember composable function to create an instance of this class. Check AbstractDockBuilder and its superclasses to see what each property does.

Link copied to clipboard

Builder class for Dock where the scope is Dock.Scope.

Link copied to clipboard

A class that represents a component that can be rendered in the editor.

Link copied to clipboard
Link copied to clipboard

A class that is used as an identifier for class EditorComponent. Note that it is highly recommended that every unique EditorComponent has a unique id.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Scope of the InspectorBar.Button.rememberFillStroke button in the inspector bar.

Link copied to clipboard
data class InspectorBar<Scope : InspectorBar.Scope>(val scope: Scope, val id: EditorComponentId, val modifier: Modifier, val visible: Boolean, val enterTransition: EnterTransition, val exitTransition: ExitTransition, val decoration: ScopedDecoration<Scope>, val listBuilder: HorizontalListBuilder<EditorComponent<*>>, val horizontalArrangement: Arrangement.Horizontal, val itemsRowEnterTransition: EnterTransition, val itemsRowExitTransition: ExitTransition, val itemDecoration: ScopedDecoration<Scope>) : EditorComponent<Scope>

A component for rendering the inspector bar at the bottom of the editor. Use InspectorBar.Companion.remember composable function to create an instance of this class. Check AbstractInspectorBarBuilder and its superclasses to see what each property does.

Link copied to clipboard
Link copied to clipboard
data class NavigationBar<Scope : NavigationBar.Scope>(val scope: Scope, val id: EditorComponentId, val modifier: Modifier, val visible: Boolean, val enterTransition: EnterTransition, val exitTransition: ExitTransition, val decoration: ScopedDecoration<Scope>, val listBuilder: HorizontalListBuilder<EditorComponent<*>>, val horizontalArrangement: Arrangement.Horizontal, val itemDecoration: ScopedDecoration<Scope>) : EditorComponent<Scope>

A component for rendering the navigation bar at the top of the editor. Use NavigationBar.Companion.remember composable function to create an instance of this class. Check AbstractNavigationBarBuilder and its superclasses to see what each property does.

Link copied to clipboard
Link copied to clipboard

Implementation of EditorComponentBuilder where content is empty. Useful when component does not need to have any special structure and UI can be provided via decoration.

Link copied to clipboard

Scope of the rememberTextBackground button in the inspector bar.

Link copied to clipboard
data class Timeline(val scope: Timeline.Scope, val id: EditorComponentId, val modifier: Modifier, val visible: Boolean, val enterTransition: EnterTransition, val exitTransition: ExitTransition, val decoration: ScopedDecoration<Timeline.Scope>, val addClipButton: EditorComponent<*>?, val addAudioButton: EditorComponent<*>?, val headerListBuilder: HorizontalListBuilder<EditorComponent<*>>, val height: TimelineHeight) : EditorComponent<Timeline.Scope>

A component for rendering the timeline. Use Timeline.Companion.remember composable function to create an instance of this class. Check TimelineBuilder and its superclasses to see what each property does.

Link copied to clipboard
Link copied to clipboard

Renders the editor's Timeline component and its built-in add buttons.

Properties

Link copied to clipboard

The id of the timeline button returned by Timeline.Button.rememberAddAudio.

Link copied to clipboard

The id of the timeline button returned by Timeline.Button.rememberAddClip.

Link copied to clipboard
Link copied to clipboard

Predicate to be used when the EditorComponent is always enabled.

Link copied to clipboard

Predicate to be used when the EditorComponent is always visible.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The id of the dock button returned by Dock.Button.rememberBlur.

The id of the inspector bar button returned by InspectorBar.Button.rememberBlur.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The id of the dock button returned by Dock.Button.rememberCaptions.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The id of the dock button returned by Dock.Button.rememberCrop.

The id of the inspector bar button returned by InspectorBar.Button.rememberCrop.

Link copied to clipboard

The id of the canvas menu button returned by CanvasMenu.Button.rememberDelete.

The id of the inspector bar button returned by InspectorBar.Button.rememberDelete.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The id of the dock button returned by Dock.Button.rememberEffect.

The id of the inspector bar button returned by InspectorBar.Button.rememberEffect.

Link copied to clipboard
Link copied to clipboard

A helper lambda that represents no decoration.

Link copied to clipboard
Link copied to clipboard

The id of the navigation bar button returned by NavigationBar.Button.rememberExport.

Link copied to clipboard
Link copied to clipboard

The id of the dock button returned by Dock.Button.rememberFilter.

The id of the inspector bar button returned by InspectorBar.Button.rememberFilter.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The id of the inspector bar button returned by InspectorBar.Button.rememberLayer.

Link copied to clipboard

The id of the timeline button returned by Timeline.Button.rememberLoop.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The id of the navigation bar button returned by NavigationBar.Button.rememberRedo.

Link copied to clipboard

The id of the dock button returned by Dock.Button.rememberReorder.

The id of the inspector bar button returned by InspectorBar.Button.rememberReorder.

Link copied to clipboard

The id of the inspector bar button returned by InspectorBar.Button.rememberReplace.

Link copied to clipboard

The id of the dock button returned by Dock.Button.rememberResizeAll.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The id of the inspector bar button returned by InspectorBar.Button.rememberShape.

Link copied to clipboard
Link copied to clipboard

The id of the inspector bar button returned by InspectorBar.Button.rememberSplit.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The id of the timeline label returned by Timeline.Label.rememberTimecode.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The id of the navigation bar button returned by NavigationBar.Button.rememberUndo.

Link copied to clipboard
Link copied to clipboard

The id of the inspector bar button returned by InspectorBar.Button.rememberVolume.

Functions

Link copied to clipboard
fun Dock.Companion.DefaultDecoration(_: Nothing = nothing, background: Color = MaterialTheme.colorScheme.surface1.copy(alpha = 0.95f), paddingValues: PaddingValues = PaddingValues(vertical = 10.dp), __: Nothing = nothing, content: @Composable () -> Unit)

Default decoration of the dock. Sets a background color and applies paddings to the dock by adding a containing box.

fun NavigationBar.Companion.DefaultDecoration(_: Nothing = nothing, background: Color = MaterialTheme.colorScheme.surface.copy(alpha = 0.95F), paddingValues: PaddingValues = PaddingValues(horizontal = 4.dp), __: Nothing = nothing, content: @Composable () -> Unit)

Default decoration of the navigation bar. Sets a background color and applies paddings to the navigation bar by adding a containing box.

fun Timeline.Companion.DefaultDecoration(_: Nothing = nothing, background: Color = MaterialTheme.colorScheme.surface1, paddingValues: PaddingValues = PaddingValues(0.dp), __: Nothing = nothing, content: @Composable () -> Unit)

The default decoration of the timeline.

fun InspectorBar.Companion.DefaultDecoration(_: Nothing = nothing, scope: InspectorBar.Scope, background: Color = MaterialTheme.colorScheme.surface, paddingValues: PaddingValues = PaddingValues(start = 16.dp, top = 10.dp, bottom = 10.dp), __: Nothing = nothing, content: @Composable () -> Unit)

Default decoration of the inspector bar. Sets a background color, applies paddings and adds a close button to the inspector bar by adding a containing box.

fun CanvasMenu.Companion.DefaultDecoration(_: Nothing = nothing, scope: CanvasMenu.Scope, shape: Shape = MaterialTheme.shapes.extraLarge, contentColor: Color = MaterialTheme.colorScheme.onSurfaceVariant, shadowElevation: Dp = 1.dp, rotateHandleSize: Dp = 48.dp, verticalPadding: Dp = 24.dp, horizontalPadding: Dp = 16.dp, __: Nothing = nothing, content: @Composable () -> Unit)

The default decoration of the canvas menu. Calculates the position and rotation of the selected design block and finds the coordinates where the canvas menu should be placed. Finally, canvas menu is placed in a surface which parameters can be configured.

Link copied to clipboard
fun <Scope : EditorScope> EditorComponent(component: EditorComponent<Scope>, modifier: Modifier = Modifier, onHide: () -> Unit = {})

The content of the component.

Link copied to clipboard
fun <Scope : EditorScope> ColumnScope.EditorComponent(component: EditorComponent<Scope>, modifier: Modifier = Modifier, onHide: () -> Unit = {})

The content of the component when rendered in a ColumnScope. Prefer using this overload over without ColumnScope when the component is being rendered in a column.

fun <Scope : EditorScope> RowScope.EditorComponent(component: EditorComponent<Scope>, modifier: Modifier = Modifier, onHide: () -> Unit = {})

The content of the component when rendered in a RowScope. Prefer using this overload over without RowScope when the component is being rendered in a row.

Link copied to clipboard

A composable function that modifies existing EditorComponent.ListBuilder. Useful if you want to apply modifications to the original builder, without touching the original builder.

Link copied to clipboard

A composable overload for CanvasMenu.Button.remember that uses AbstractButtonBuilder to create and remember an Button instance. Check the documentation of overloaded CanvasMenu.Button.remember function below for more details. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

A composable overload for CanvasMenu.Companion.remember that uses CanvasMenuBuilder to create and remember a CanvasMenu instance. Check the documentation of overloaded CanvasMenu.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. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

A composable overload for CanvasMenu.Divider.remember that uses CanvasMenu.DividerBuilder to create and remember a Divider instance. Check the documentation of overloaded CanvasMenu.Divider.remember function below for more details. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

A composable function that creates and remembers a CanvasMenu.ListBuilder instance.

A composable overload for Dock.Button.remember that uses AbstractButtonBuilder to create and remember an Button instance. Check the documentation of overloaded Dock.Button.remember function below for more details. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

A composable overload for Dock.Companion.remember that uses DockBuilder to create and remember a Dock instance. Check the documentation of overloaded Dock.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. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

A composable overload for Dock.Divider.remember that uses Dock.DividerBuilder to create and remember a Divider instance. Check the documentation of overloaded Dock.Divider.remember function below for more details. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

A composable function that creates and remembers a Dock.ListBuilder instance.

A composable overload for EditorComponent.Companion.remember where the component's scope is automatically EditorScope instance. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

A composable function that creates and remembers a EditorComponent.ListBuilder instance.

fun EditorTrigger.Companion.remember(vararg keys: Any?, flow: () -> Flow<*>): EditorTrigger

Creates and remembers a new EditorTrigger.

A composable overload for InspectorBar.Button.remember that uses AbstractButtonBuilder to create and remember an Button instance. Check the documentation of overloaded InspectorBar.Button.remember function below for more details. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

A composable overload for InspectorBar.Companion.remember that uses AbstractInspectorBarBuilder to create and remember an InspectorBar instance. Check the documentation of overloaded InspectorBar.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. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

A composable function that creates and remembers an InspectorBar.ListBuilder instance.

A composable overload for NavigationBar.Button.remember that uses AbstractButtonBuilder to create and remember an Button instance. Check the documentation of overloaded NavigationBar.Button.remember function below for more details. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

A composable overload for NavigationBar.Companion.remember that uses NavigationBarBuilder to create and remember a NavigationBar instance. Check the documentation of overloaded NavigationBar.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. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

A composable function that creates and remembers a NavigationBar.ListBuilder instance.

A composable function that creates and remembers a custom entry for the "Add Audio" menu. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions.

A composable function that creates and remembers a custom entry for the "Add Clip" menu. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions.

A composable overload for Timeline.Companion.remember that uses TimelineBuilder to create and remember a Timeline instance. Check the documentation of overloaded Timeline.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. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

A composable function that creates and remembers a Timeline.HeaderListBuilder instance.

A composable function that creates and remembers an Button instance. Note that both builderFactory and builder lambdas run only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

A composable function that creates and remembers a CanvasMenu instance.

A composable function that creates and remembers a Divider instance. Note that both builderFactory and builder lambdas run only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

fun <Scope : Dock.Scope, Builder : AbstractDockBuilder<Scope>> Dock.Companion.remember(builderFactory: () -> Builder, builder: Builder.() -> Unit = {}): Dock<Scope>

A composable function that creates and remembers a Dock instance.

A composable function that creates and remembers a fully custom editor component. Use this function whenever you want to provide a fully custom UI for EditorComponent. For instance, you can replace the content of the inspector bar:

A composable function that creates and remembers an InspectorBar instance.

A composable function that creates and remembers a NavigationBar instance.

A composable function that creates and remembers a Timeline.AddAudioOption instance. Note that both builderFactory and builder lambdas run only once, therefore you should not have builder property reassignments based on conditions.

A composable function that creates and remembers a Timeline.AddClipOption instance. Note that both builderFactory and builder lambdas run only once, therefore you should not have builder property reassignments based on conditions.

A composable function that creates and remembers a Timeline instance. Note that both builderFactory and builder lambdas run only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers the built-in "Add Audio" button of the Timeline. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers the built-in "Add Clip" button of the Timeline. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers a Dock.Button that opens adjustments sheet for the current page via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

A helper function that returns an Button that opens adjustments sheet via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A helper function that returns an Button that opens animation sheet via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers a Dock.Button that opens a library sheet with tabs via EditorEvent.Sheet.Open. Every item in ly.img.editor.core.library.AssetLibrary.tabs is represented via a tab in the sheet.

Link copied to clipboard

A composable helper function that creates and remembers a Dock.Button that opens a library sheet with audios via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers a Dock.Button that opens blur sheet for the current page via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

A composable helper function that creates and remembers an Button that opens blur sheet via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that brings forward currently selected design block via EditorEvent.Selection.BringForward. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers the "Add Clip" entry that records a clip with the camera and appends it to the background track. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions.

Link copied to clipboard

A composable helper function that creates and remembers a Dock.Button that opens the captions sheet via EditorEvent.Sheet.Open.

Link copied to clipboard

A composable helper function that creates and remembers an Button that opens the caption style preset grid via EditorEvent.Sheet.Open. A preset is applied to the selected caption and the engine syncs the style across every caption on its track. Hidden when AssetSourceType.CaptionPresets is not registered. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that opens clip speed sheet via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that triggers ly.img.editor.core.configuration.EditorConfiguration.onClose callback via EditorEvent.OnClose. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that opens crop sheet via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

fun Dock.Button.rememberCrop(mode: SheetType.Crop.Mode = SheetType.Crop.Mode.ImageCrop, builder: Dock.ButtonBuilder.() -> Unit = {}): Button<Dock.ItemScope>

A composable helper function that creates and remembers a Dock.Button that opens crop sheet for the current page via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard
fun CanvasMenu.Companion.rememberDefaultScope(_: Nothing = nothing, parentScope: EditorScope, selectedDesignBlock: EditorScope.() -> DesignBlock? = { editorContext.engine.block.findAllSelected().firstOrNull() }, __: Nothing = nothing): CanvasMenu.Scope

The default scope of the canvas menu. The value is updated when:

fun InspectorBar.Companion.rememberDefaultScope(_: Nothing = nothing, parentScope: EditorScope, selectedDesignBlock: EditorScope.() -> DesignBlock? = { editorContext.engine.block.findAllSelected().firstOrNull()?.takeIf { editorContext.engine.block.getType(it) != DesignBlockType.Page.key || editorContext.engine.editor.getSettingBoolean("page/selectWhenNoBlocksSelected").not() } }, __: Nothing = nothing): InspectorBar.Scope

The default scope of the inspector bar. The value is updated when:

Link copied to clipboard

A composable helper function that creates and remembers an Button that deletes currently selected design block via EditorEvent.Selection.Delete. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that duplicates currently selected design block via EditorEvent.Selection.Duplicate. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that opens the captions sheet via EditorEvent.Sheet.Open, with the selected caption revealed in the list. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that enters text editing mode for the selected design block via EditorEvent.Selection.EnterTextEditMode. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers a Dock.Button that opens effect sheet for the current page via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

A composable helper function that creates and remembers an Button that opens effect sheet via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers a Dock.Button that opens a library sheet with elements via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that changes selection from the selected group design block to a design block within that group via EditorEvent.Selection.EnterGroup. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that starts export via EditorEvent.Export. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that opens fill stroke sheet via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers a Dock.Button that opens filter sheet for the current page via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

A composable helper function that creates and remembers an Button that opens filter sheet via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that opens text formatting sheet via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers the "Add Clip" entry that opens the system gallery and appends the selection to the background track. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions.

Link copied to clipboard

A composable helper function that creates and remembers a Dock.Button that opens a library sheet with images via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard
fun Dock.Button.rememberImglyCamera(acceptsVideoCapture: Dock.ItemScope.() -> Boolean = { false }, builder: Dock.ButtonBuilder.() -> Unit = {}): Button<Dock.ItemScope>

A composable helper function that creates and remembers a Dock.Button that opens the imgly camera via EditorEvent.LaunchContract.

Link copied to clipboard

A composable helper function that creates and remembers an Button that opens layer sheet via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers the "Add Clip" entry that opens the asset library and appends the selection to the background track. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions.

Link copied to clipboard

A composable helper function that creates and remembers a Timeline header button that toggles looping playback. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions.

Link copied to clipboard

A composable helper function that creates and remembers an Button that moves currently selected design block into the background track as clip via EditorEvent.Selection.MoveAsClip. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that moves currently selected design block from the background track to an overlay via EditorEvent.Selection.MoveAsOverlay. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers the "Add Audio" entry that opens the asset library's audio category. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions.

Link copied to clipboard

A composable helper function that creates and remembers a custom EditorComponent that navigates to the next page via EditorEvent.Navigation.ToNextPage. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers a Dock.Button that opens a library sheet with overlays via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers a Timeline header button that starts and pauses playback. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions.

Link copied to clipboard

A composable helper function that creates and remembers a custom EditorComponent that navigates to the previous page via EditorEvent.Navigation.ToPreviousPage. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that does redo operation in the editor via ly.img.engine.EditorApi.redo engine API. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers a Dock.Button that opens reorder sheet via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

A composable helper function that creates and remembers an Button that opens reorder sheet via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that opens a library sheet via EditorEvent.Sheet.Open. Selected asset will replace the content of the currently selected design block. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers a Dock.Button that opens resize sheet for the current page via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that selects the group design block that contains the currently selected design block via EditorEvent.Selection.SelectGroup. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that sends backward currently selected design block via EditorEvent.Selection.SendBackward. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that opens shape options sheet via EditorEvent.Sheet.Open. The button is applicable for the following shape types: ShapeType.Star, ShapeType.Polygon, ShapeType.Rect. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers a Dock.Button that opens a library sheet with shapes via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that splits currently selected design block via EditorEvent.Selection.Split. The button is visible when the "lifecycle/duplicate" scope of the selected design block is allowed. A caption is only enabled while the playhead sits inside it, since a caption divides where the playhead is. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers a Dock.Button that opens a library sheet with stickers and shapes via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers a Dock.Button that opens a library sheet with stickers via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers a Dock.Button that opens the system camera via EditorEvent.LaunchContract. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers a Dock.Button that opens a library sheet with system gallery content via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that opens text background options sheet via EditorEvent.Sheet.Open. The button is disabled for a text on a path, because the engine draws no background for it. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers a Dock.Button that opens a library sheet with text via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that opens the text on path sheet via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that opens the text style presets library sheet via EditorEvent.Sheet.Open. Selected preset is applied to the currently selected text block via the engine asset replace path. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers the Timeline header timecode, displaying the current playhead position and the total duration. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions.

Link copied to clipboard

A composable helper function that creates and remembers a Timeline header button that expands and collapses the timeline. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions.

Link copied to clipboard

A composable helper function that creates and remembers a custom EditorComponent that updates editor view mode via EditorEvent.SetViewMode: when current view mode is EditorViewMode.Edit, then EditorViewMode.Pages is set and vice versa. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that updates editor view mode via EditorEvent.SetViewMode: when current view mode is EditorViewMode.Edit, then EditorViewMode.Preview is set and vice versa. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A helper function that returns a Button that opens the transition sheet for the selected design block. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A composable helper function that creates and remembers an Button that does undo operation in the editor via ly.img.engine.EditorApi.undo engine API. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.

Link copied to clipboard

A helper function that returns an InspectorBar.Button that opens the voiceover recording sheet via EditorEvent.Sheet.Open.

A composable helper function that creates and remembers the "Add Audio" entry that records a voiceover. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions.

Link copied to clipboard

A composable helper function that creates and remembers a Dock.Button that opens the voiceover recording sheet via EditorEvent.Sheet.Open.

Link copied to clipboard

A composable helper function that creates and remembers an Button that opens volume sheet via EditorEvent.Sheet.Open. Note that builder lambda runs only once, therefore you should not have builder property reassignments based on conditions. Check ly.img.editor.core.configuration.EditorConfiguration.Companion.remember for more details on this pattern.