androidx.compose.ui
Interfaces
Alignment |
An interface to calculate the position of a sized box inside an available space. |
Cmn
|
Alignment.Horizontal |
An interface to calculate the position of box of a certain width inside an available width. |
Cmn
|
Alignment.Vertical |
An interface to calculate the position of a box of a certain height inside an available height. |
Cmn
|
Modifier |
An ordered, immutable collection of |
Cmn
|
Modifier.Element |
A single element contained within a |
Cmn
|
MotionDurationScale |
Provides a duration scale for motion such as animations. |
Cmn
|
Classes
BiasAbsoluteAlignment |
An |
Cmn
|
BiasAbsoluteAlignment.Horizontal |
An |
Cmn
|
BiasAlignment |
An |
Cmn
|
BiasAlignment.Horizontal |
An |
Cmn
|
BiasAlignment.Vertical |
An |
Cmn
|
CombinedModifier |
A node in a |
Cmn
|
Modifier.Node |
The longer-lived object that is created for each |
Cmn
|
Objects
AbsoluteAlignment |
A collection of common |
Cmn
|
ComposeUiFlags |
This is a collection of flags which are used to guard against regressions in some of the "riskier" refactors or new feature support that is added to this module. |
Cmn
|
Modifier.Companion |
The companion object |
Cmn
|
MotionDurationScale.Key |
Cmn
|
Annotations
ExperimentalComposeUiApi |
Cmn
|
|
InternalComposeUiApi |
Unstable API for use only between |
Cmn
|
UiComposable |
An annotation that can be used to mark a composable function as being expected to be use in a composable function that is also marked or inferred to be marked as a |
Cmn
|
Extension functions summary
Modifier |
Modifier.composed( Declare a just-in-time composition of a |
Cmn
|
Modifier |
Modifier.composed( Declare a just-in-time composition of a |
Cmn
|
Modifier |
Modifier.composed( Declare a just-in-time composition of a |
Cmn
|
Modifier |
Modifier.composed( Declare a just-in-time composition of a |
Cmn
|
Modifier |
Modifier.composed( Declare a just-in-time composition of a |
Cmn
|
Modifier |
Composer.materialize(modifier: Modifier) Materialize any instance-specific |
Cmn
|
Modifier |
Modifier.sensitiveContent(isContentSensitive: Boolean) This modifier hints that the composable renders sensitive content (i.e. username, password, credit card etc) on the screen, and the content should be protected during screen share in supported environments. |
Cmn
|
Modifier |
Creates a modifier that controls the drawing order for the children of the same layout parent. |
Cmn
|
Extension functions
composed
fun Modifier.composed(
inspectorInfo: InspectorInfo.() -> Unit = NoInspectorInfo,
factory: @Composable Modifier.() -> Modifier
): Modifier
Declare a just-in-time composition of a Modifier
that will be composed for each element it modifies. composed
may be used to implement stateful modifiers that have instance-specific state for each modified element, allowing the same Modifier
instance to be safely reused for multiple elements while maintaining element-specific state.
If inspectorInfo
is specified this modifier will be visible to tools during development. Specify the name and arguments of the original modifier.
Example usage:
import androidx.compose.ui.Modifier import androidx.compose.ui.composed import androidx.compose.ui.graphics.Color import androidx.compose.ui.platform.debugInspectorInfo // let's create your own custom stateful modifier fun Modifier.myColorModifier(color: Color) = composed( // pass inspector information for debug inspectorInfo = debugInspectorInfo { // name should match the name of the modifier name = "myColorModifier" // specify a single argument as the value when the argument name is irrelevant value = color }, // pass your modifier implementation that resolved per modified element factory = { // add your modifier implementation here Modifier } )
import androidx.compose.ui.Modifier import androidx.compose.ui.composed import androidx.compose.ui.graphics.Color import androidx.compose.ui.platform.debugInspectorInfo import androidx.compose.ui.unit.Dp // let's create your own custom stateful modifier with multiple arguments fun Modifier.myModifier(width: Dp, height: Dp, color: Color) = composed( // pass inspector information for debug inspectorInfo = debugInspectorInfo { // name should match the name of the modifier name = "myModifier" // add name and value of each argument properties["width"] = width properties["height"] = height properties["color"] = color }, // pass your modifier implementation that resolved per modified element factory = { // add your modifier implementation here Modifier } )
materialize
must be called to create instance-specific modifiers if you are directly applying a Modifier
to an element tree node.
composed
fun Modifier.composed(
fullyQualifiedName: String,
key1: Any?,
inspectorInfo: InspectorInfo.() -> Unit = NoInspectorInfo,
factory: @Composable Modifier.() -> Modifier
): Modifier
Declare a just-in-time composition of a Modifier
that will be composed for each element it modifies. composed
may be used to implement stateful modifiers that have instance-specific state for each modified element, allowing the same Modifier
instance to be safely reused for multiple elements while maintaining element-specific state.
When keys are provided, composed
produces a Modifier
that will compare equals
to another modifier constructed with the same keys in order to take advantage of caching and skipping optimizations. fullyQualifiedName
should be the fully-qualified import
name for your modifier factory function, e.g. com.example.myapp.ui.fancyPadding
.
If inspectorInfo
is specified this modifier will be visible to tools during development. Specify the name and arguments of the original modifier.
Example usage:
import androidx.compose.ui.Modifier import androidx.compose.ui.composed import androidx.compose.ui.graphics.Color import androidx.compose.ui.platform.debugInspectorInfo // let's create your own custom stateful modifier fun Modifier.myColorModifier(color: Color) = composed( // pass inspector information for debug inspectorInfo = debugInspectorInfo { // name should match the name of the modifier name = "myColorModifier" // specify a single argument as the value when the argument name is irrelevant value = color }, // pass your modifier implementation that resolved per modified element factory = { // add your modifier implementation here Modifier } )
import androidx.compose.ui.Modifier import androidx.compose.ui.composed import androidx.compose.ui.graphics.Color import androidx.compose.ui.platform.debugInspectorInfo import androidx.compose.ui.unit.Dp // let's create your own custom stateful modifier with multiple arguments fun Modifier.myModifier(width: Dp, height: Dp, color: Color) = composed( // pass inspector information for debug inspectorInfo = debugInspectorInfo { // name should match the name of the modifier name = "myModifier" // add name and value of each argument properties["width"] = width properties["height"] = height properties["color"] = color }, // pass your modifier implementation that resolved per modified element factory = { // add your modifier implementation here Modifier } )
materialize
must be called to create instance-specific modifiers if you are directly applying a Modifier
to an element tree node.
composed
fun Modifier.composed(
fullyQualifiedName: String,
vararg keys: Any?,
inspectorInfo: InspectorInfo.() -> Unit = NoInspectorInfo,
factory: @Composable Modifier.() -> Modifier
): Modifier
Declare a just-in-time composition of a Modifier
that will be composed for each element it modifies. composed
may be used to implement stateful modifiers that have instance-specific state for each modified element, allowing the same Modifier
instance to be safely reused for multiple elements while maintaining element-specific state.
When keys are provided, composed
produces a Modifier
that will compare equals
to another modifier constructed with the same keys in order to take advantage of caching and skipping optimizations. fullyQualifiedName
should be the fully-qualified import
name for your modifier factory function, e.g. com.example.myapp.ui.fancyPadding
.
If inspectorInfo
is specified this modifier will be visible to tools during development. Specify the name and arguments of the original modifier.
Example usage:
import androidx.compose.ui.Modifier import androidx.compose.ui.composed import androidx.compose.ui.graphics.Color import androidx.compose.ui.platform.debugInspectorInfo // let's create your own custom stateful modifier fun Modifier.myColorModifier(color: Color) = composed( // pass inspector information for debug inspectorInfo = debugInspectorInfo { // name should match the name of the modifier name = "myColorModifier" // specify a single argument as the value when the argument name is irrelevant value = color }, // pass your modifier implementation that resolved per modified element factory = { // add your modifier implementation here Modifier } )
import androidx.compose.ui.Modifier import androidx.compose.ui.composed import androidx.compose.ui.graphics.Color import androidx.compose.ui.platform.debugInspectorInfo import androidx.compose.ui.unit.Dp // let's create your own custom stateful modifier with multiple arguments fun Modifier.myModifier(width: Dp, height: Dp, color: Color) = composed( // pass inspector information for debug inspectorInfo = debugInspectorInfo { // name should match the name of the modifier name = "myModifier" // add name and value of each argument properties["width"] = width properties["height"] = height properties["color"] = color }, // pass your modifier implementation that resolved per modified element factory = { // add your modifier implementation here Modifier } )
materialize
must be called to create instance-specific modifiers if you are directly applying a Modifier
to an element tree node.
composed
fun Modifier.composed(
fullyQualifiedName: String,
key1: Any?,
key2: Any?,
inspectorInfo: InspectorInfo.() -> Unit = NoInspectorInfo,
factory: @Composable Modifier.() -> Modifier
): Modifier
Declare a just-in-time composition of a Modifier
that will be composed for each element it modifies. composed
may be used to implement stateful modifiers that have instance-specific state for each modified element, allowing the same Modifier
instance to be safely reused for multiple elements while maintaining element-specific state.
When keys are provided, composed
produces a Modifier
that will compare equals
to another modifier constructed with the same keys in order to take advantage of caching and skipping optimizations. fullyQualifiedName
should be the fully-qualified import
name for your modifier factory function, e.g. com.example.myapp.ui.fancyPadding
.
If inspectorInfo
is specified this modifier will be visible to tools during development. Specify the name and arguments of the original modifier.
Example usage:
import androidx.compose.ui.Modifier import androidx.compose.ui.composed import androidx.compose.ui.graphics.Color import androidx.compose.ui.platform.debugInspectorInfo // let's create your own custom stateful modifier fun Modifier.myColorModifier(color: Color) = composed( // pass inspector information for debug inspectorInfo = debugInspectorInfo { // name should match the name of the modifier name = "myColorModifier" // specify a single argument as the value when the argument name is irrelevant value = color }, // pass your modifier implementation that resolved per modified element factory = { // add your modifier implementation here Modifier } )
import androidx.compose.ui.Modifier import androidx.compose.ui.composed import androidx.compose.ui.graphics.Color import androidx.compose.ui.platform.debugInspectorInfo import androidx.compose.ui.unit.Dp // let's create your own custom stateful modifier with multiple arguments fun Modifier.myModifier(width: Dp, height: Dp, color: Color) = composed( // pass inspector information for debug inspectorInfo = debugInspectorInfo { // name should match the name of the modifier name = "myModifier" // add name and value of each argument properties["width"] = width properties["height"] = height properties["color"] = color }, // pass your modifier implementation that resolved per modified element factory = { // add your modifier implementation here Modifier } )
materialize
must be called to create instance-specific modifiers if you are directly applying a Modifier
to an element tree node.
composed
fun Modifier.composed(
fullyQualifiedName: String,
key1: Any?,
key2: Any?,
key3: Any?,
inspectorInfo: InspectorInfo.() -> Unit = NoInspectorInfo,
factory: @Composable Modifier.() -> Modifier
): Modifier
Declare a just-in-time composition of a Modifier
that will be composed for each element it modifies. composed
may be used to implement stateful modifiers that have instance-specific state for each modified element, allowing the same Modifier
instance to be safely reused for multiple elements while maintaining element-specific state.
When keys are provided, composed
produces a Modifier
that will compare equals
to another modifier constructed with the same keys in order to take advantage of caching and skipping optimizations. fullyQualifiedName
should be the fully-qualified import
name for your modifier factory function, e.g. com.example.myapp.ui.fancyPadding
.
If inspectorInfo
is specified this modifier will be visible to tools during development. Specify the name and arguments of the original modifier.
Example usage:
import androidx.compose.ui.Modifier import androidx.compose.ui.composed import androidx.compose.ui.graphics.Color import androidx.compose.ui.platform.debugInspectorInfo // let's create your own custom stateful modifier fun Modifier.myColorModifier(color: Color) = composed( // pass inspector information for debug inspectorInfo = debugInspectorInfo { // name should match the name of the modifier name = "myColorModifier" // specify a single argument as the value when the argument name is irrelevant value = color }, // pass your modifier implementation that resolved per modified element factory = { // add your modifier implementation here Modifier } )
import androidx.compose.ui.Modifier import androidx.compose.ui.composed import androidx.compose.ui.graphics.Color import androidx.compose.ui.platform.debugInspectorInfo import androidx.compose.ui.unit.Dp // let's create your own custom stateful modifier with multiple arguments fun Modifier.myModifier(width: Dp, height: Dp, color: Color) = composed( // pass inspector information for debug inspectorInfo = debugInspectorInfo { // name should match the name of the modifier name = "myModifier" // add name and value of each argument properties["width"] = width properties["height"] = height properties["color"] = color }, // pass your modifier implementation that resolved per modified element factory = { // add your modifier implementation here Modifier } )
materialize
must be called to create instance-specific modifiers if you are directly applying a Modifier
to an element tree node.
materialize
fun Composer.materialize(modifier: Modifier): Modifier
Materialize any instance-specific composed modifiers
for applying to a raw tree node. Call right before setting the returned modifier on an emitted node. You almost certainly do not need to call this function directly.
sensitiveContent
fun Modifier.sensitiveContent(isContentSensitive: Boolean = true): Modifier
This modifier hints that the composable renders sensitive content (i.e. username, password, credit card etc) on the screen, and the content should be protected during screen share in supported environments.
zIndex
fun Modifier.zIndex(zIndex: Float): Modifier
Creates a modifier that controls the drawing order for the children of the same layout parent. A child with larger zIndex
will be drawn on top of all the children with smaller zIndex
. When children have the same zIndex
the original order in which the parent placed the children is used.
Note that if there would be multiple zIndex
modifiers applied for the same layout the sum of their values will be used as the final zIndex. If no zIndex
were applied for the layout then the default zIndex is 0.
import androidx.compose.foundation.layout.Box import androidx.compose.material.Text import androidx.compose.ui.Modifier import androidx.compose.ui.zIndex Box { Text("Drawn second", Modifier.zIndex(1f)) Text("Drawn first") }