Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard

Container (background) color of the button. Defaults to Color.Transparent.

Link copied to clipboard

Content description of this button. Useful for handling accessibility issues. Always provide this value if the button does not contain visual text explaining what it does. Default value is null.

Link copied to clipboard

Content padding of the button. By default both vertical and horizontal values are applied.

Link copied to clipboard

Decoration of this component. Useful when you want to add custom background, foreground, shadow, paddings etc. By default no decoration is applied.

Link copied to clipboard

Whether button is enabled or not. Default value is always true.

Link copied to clipboard

Transition of the component when it enters the parent composable. By default no transition is applied.

Link copied to clipboard

Transition of the component when it exits the parent composable. By default no transition is applied.

Link copied to clipboard
open var icon: @Composable Scope.() -> Unit?

Composable function that is used to render an icon. Can be used to draw ambiguous content. By default no icon is applied.

Link copied to clipboard

Unique id of this component. By default property is not initialized.

Link copied to clipboard

Modifier of this component. By default empty Modifier is applied.

Link copied to clipboard
open var onClick: Scope.() -> Unit

Callback that is invoked when the button is clicked. By default it does nothing.

Link copied to clipboard

Scope of this component. Every new value will trigger recomposition of all ScopedPropertys such as visible, enterTransition, exitTransition etc. Consider using Compose androidx.compose.runtime.State objects in the lambdas for granular recompositions over updating the scope, since scope change triggers full recomposition of the component. Ideally, scope should be updated when the parent scope (scope of the parent component) is updated and when you want to observe changes from the Engine. Property is abstract.

Link copied to clipboard
open var text: @Composable Scope.() -> Unit?

Composable function that is used to render a text. Can be used to draw ambiguous content. By default no text is applied.

Link copied to clipboard

Custom implementation of text that provides a text from a string. By default no text string is applied.

Link copied to clipboard

Tint of this button. Default value is always onSurfaceVariant from MaterialTheme.colorScheme.

Link copied to clipboard

Custom implementation of icon that provides an icon from a vector resource. By default no vector icon is applied.

Link copied to clipboard

Whether the component should be visible. By default component is always visible.

Functions

Link copied to clipboard
open override fun build(scope: Scope, id: EditorComponentId, modifier: Modifier, visible: Boolean, enterTransition: EnterTransition, exitTransition: ExitTransition, decoration: ScopedDecoration<Scope>): Button<Scope>