androidx.compose.foundation.layout

Used to specify the horizontal arrangement of the layout's children in layouts like Row.

Used to specify the horizontal arrangement of the layout's children in horizontal layouts like Row, or the vertical arrangement of the layout's children in vertical layouts like Column.

Used to specify the vertical arrangement of the layout's children in layouts like Column.

A BoxScope provides a scope for the children of Box and BoxWithConstraints.

Receiver scope being used by the children parameter of BoxWithConstraints

Scope for the children of Column.

This interface is deprecated. ContextualFlowLayouts are no longer maintained

This interface is deprecated. ContextualFlowLayouts are no longer maintained

This interface is deprecated. ContextualFlowLayouts are no longer maintained

This interface is deprecated. ContextualFlowLayouts are no longer maintained

Represents a configuration for a FlexBox container.

Receiver scope for configuring FlexBox container properties.

Scope for the content of a FlexBox.

Represents a configuration for a flex item within a FlexBox.

Scope for configuring flex item properties within a FlexBox.

Scope for the overflow FlowColumn.

Scope for the children of FlowColumn.

Scope for the overflow FlowRow.

Scope for the children of FlowRow.

Scope for configuring the structure of a Grid.

Scope for the children of Grid.

Marker interface to enable vararg usage with GridTrackSize.

Describes a padding to be applied along the edges inside a box.

Scope for the children of Row.

A representation of window insets that tracks access to enable recomposition, relayout, and redrawing when values change.

This class is deprecated. ContextualFlowLayouts are no longer maintained

This class is deprecated. ContextualFlowLayouts are no longer maintained

Defines how multiple lines are distributed along the cross axis.

Defines the default alignment for items along the cross axis within their respective lines.

Defines the cross-axis alignment for a single flex item, overriding the container's FlexAlignItems.

Defines the initial main size of a flex item before free space distribution.

Defines the direction of the main axis in a FlexBox container.

Defines the arrangement of items along the main axis of their respective lines.

Defines whether flex items are forced onto a single line or can wrap onto multiple lines.

This class is deprecated. FlowLayout overflow is no longer maintained

This class is deprecated. FlowLayout overflow is no longer maintained

This class is deprecated. FlowLayout overflow is no longer maintained

Represents a flexible unit used for sizing Grid tracks.

Defines the direction in which auto-placed items flow within the grid.

Defines the size of a track (a row or a column) in a Grid.

A WindowInsets whose values can change without changing the instance.

Describes an absolute (RTL unaware) padding to be applied along the edges inside a box.

WindowInsetsSides is used in WindowInsets.only to define which sides of the WindowInsets should apply.

Used to specify the arrangement of the layout's children in layouts like Row or Column in the main axis direction (horizontal and vertical, respectively).

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.

Intrinsic size used in width or height which can refer to width or height.

A box with no content that can participate in layout, drawing, pointer input due to the modifier applied to it.

A composable that defines its own content according to the available space, based on the incoming constraints or the current LayoutDirection.

A layout composable that places its children in a vertical sequence.

ContextualFlowColumn is a specialized version of the FlowColumn layout.

ContextualFlowRow is a specialized version of the FlowRow layout.

A layout that aligns its children in a single direction (the main axis) and allows them to wrap onto multiple lines.

FlowColumn is a layout that fills items from top to bottom, and when it runs out of space on the bottom, moves to the next "column" or "line" on the right or left based on ltr or rtl layouts, and then continues filling items from top to bottom.

FlowRow is a layout that fills items from left to right (ltr) in LTR layouts or right to left (rtl) in RTL layouts and when it runs out of space, moves to the next "row" or "line" positioned on the bottom, and then continues filling items until the items run out.

A 2D layout composable that arranges children into a grid of rows and columns.

A layout composable that places its children in a horizontal sequence.

Component that represents an empty space layout, whose size can be defined using Modifier.width, Modifier.height and Modifier.size modifiers.

Convert a WindowInsets to a PaddingValues and uses LocalDensity for DP to pixel conversion.

Offset the content by offset px.

Apply additional space along each edge of the content in Dp: left, top, right and bottom.

Attempts to size the content to match a specified aspect ratio by trying to match one of the incoming constraints in the following order: Constraints.maxWidth, Constraints.maxHeight, Constraints.minWidth, Constraints.minHeight if matchHeightConstraintsFirst is false (which is the default), or Constraints.maxHeight, Constraints.maxWidth, Constraints.minHeight, Constraints.minWidth if matchHeightConstraintsFirst is true.

Adds padding to accommodate the caption bar insets.

Consume insets that haven't been consumed yet by other insets Modifiers similar to windowInsetsPadding without adding any padding.

Constrain the size of the wrapped layout only when it would be otherwise unconstrained: the minWidth and minHeight constraints are only applied when the incoming corresponding constraint is 0.

Adds padding to accommodate the display cutout.

Have the content fill (possibly only partially) the Constraints.maxHeight of the incoming measurement constraints, by setting the minimum height and the maximum height to be equal to the maximum height multiplied by fraction.

Have the content fill (possibly only partially) the Constraints.maxWidth and Constraints.maxHeight of the incoming measurement constraints, by setting the minimum width and the maximum width to be equal to the maximum width multiplied by fraction, as well as the minimum height and the maximum height to be equal to the maximum height multiplied by fraction.

Have the content fill (possibly only partially) the Constraints.maxWidth of the incoming measurement constraints, by setting the minimum width and the maximum width to be equal to the maximum width multiplied by fraction.

Fits the contents within rulers.

If one of the Rulers in rulers has a value within the bounds of the Layout, this sizes the content to that Ruler and the edge.

Declare the preferred height of the content to be exactly heightdp.

Constrain the height of the content to be between mindp and maxdp as permitted by the incoming measurement Constraints.

Controls the soft keyboard as a nested scrolling on Android R and later.

Adds padding to accommodate the ime insets.

Adds padding to accommodate the mandatory system gestures insets.

Adds padding to accommodate the navigation bars insets.

Offset the content by offset px.

Calls block with the WindowInsets that have been consumed, either by consumeWindowInsets or one of the padding Modifiers, such as imePadding.

Apply all dp of additional space along each edge of the content, left, top, right and bottom.

A Modifier that can add padding to position the content according to specified distances from its bounds to an alignment line.

A Modifier that positions the content in a layout such that the distance from the top of the layout to the baseline of the first line of text in the content is top, and the distance from the baseline of the last line of text in the content to the bottom of the layout is bottom.

This recalculates the WindowInsets based on the size and position.

Declare the height of the content to be exactly heightdp.

Constrain the height of the content to be between mindp and maxdp.

Declare the size of the content to be exactly sizedp width and height.

Constrain the width of the content to be between minWidthdp and maxWidthdp, and the height of the content to be between minHeightdp and maxHeightdp.

Declare the width of the content to be exactly the same as the min or max intrinsic width of the content.

Constrain the width of the content to be between mindp and maxdp.

Adds padding to accommodate the safe content insets.

Adds padding to accommodate the safe drawing insets.

Adds padding to accommodate the safe gestures insets.

Declare the preferred size of the content to be exactly sizedp square.

Constrain the width of the content to be between minWidthdp and maxWidthdp and the height of the content to be between minHeightdp and maxHeightdp as permitted by the incoming measurement Constraints.

Adds padding to accommodate the status bars insets.

Adds padding to accommodate the system bars insets.

Adds padding to accommodate the system gestures insets.

A Modifier that controls the visibility of the Layout it is applied to.

Adds padding to accommodate the waterfall insets.

Declare the preferred width of the content to be the same as the min or max intrinsic width of the content.

Constrain the width of the content to be between mindp and maxdp as permitted by the incoming measurement Constraints.

Sets the height to that of insets at the bottom of the screen.

Sets the width to that of insets at the end of the screen, using either left or right, depending on the LayoutDirection.

Adds padding so that the content doesn't enter insets space.

Sets the width to that of insets at the start of the screen, using either left or right, depending on the LayoutDirection.

Sets the height to that of insets at the top of the screen.

Allow the content to measure at its desired height without regard for the incoming measurement minimum height constraint, and, if unbounded is true, also without regard for the incoming measurement maximum height constraint.

Allow the content to measure at its desired size without regard for the incoming measurement minimum width or minimum height constraints, and, if unbounded is true, also without regard for the incoming maximum constraints.

Allow the content to measure at its desired width without regard for the incoming measurement minimum width constraint, and, if unbounded is true, also without regard for the incoming measurement maximum width constraint.

Creates a padding of all dp along all 4 edges.

Creates a padding of horizontal dp along the left and right edges, and of vertical dp along the top and bottom edges.

Creates a padding to be applied along the edges inside a box.

Create a WindowInsets with fixed dimensions of 0 on all sides.

Create a WindowInsets with fixed dimensions, using Dp values.

Create a WindowInsets with fixed dimensions.

Returns a WindowInsets that has values of this, added to the values of insets.

Convert a WindowInsets to a PaddingValues and uses density for DP to pixel conversion.

The padding to be applied along the end edge inside a box: along the right edge if the layout direction is LTR, or along the left edge for RTL.

The padding to be applied along the start edge inside a box: along the left edge if the layout direction is LTR, or along the right edge for RTL.

Adds multiple columns with the specified specs.

Returns the values in this WindowInsets that are not also in insets.

Subtracts a PaddingValues from another one and ensures that the result is non-negative.

Returns a WindowInsets that eliminates all dimensions except the ones that are enabled.

Adds two PaddingValues together.

Adds multiple rows with the specified specs.

Returns a WindowInsets that has the maximum values of this WindowInsets and insets.

true when the navigationBars are being displayed, irrespective of whether they intersects with the Window.

true when the statusBars are being displayed, irrespective of whether they intersects with the Window.

true when the systemBars are being displayed, irrespective of whether they intersects with the Window.

An insets type representing the window of a caption bar.

The insets that the WindowInsetsCompat.Type.captionBar will consume if shown.

Indicates whether access to WindowInsets within the content should consume the Android android.view.WindowInsets.

The path for the cutout, if any.

This WindowInsets represents the area with the display cutout (e.g. for camera).

An insets type representing the window of the software keyboard.

The WindowInsets for the IME before the IME started animating in.

The WindowInsets for the IME when the animation completes, if it is allowed to complete successfully.

true when the caption bar is being displayed, irrespective of whether it intersects with the Window.

true when the soft keyboard is being displayed, irrespective of whether it intersects with the Window.

true when the tappableElement is being displayed, irrespective of whether they intersects with the Window.

These insets represent the space where system gestures have priority over application gestures.

These insets represent where system UI places navigation bars.

The insets that WindowInsetsCompat.Type.navigationBars will consume if shown.

The insets that include all areas that may be drawn over or have gesture confusion, including everything in safeDrawing and safeGestures.

The insets that include areas where content may be covered by other drawn content.

The insets that include areas where gestures may be confused with other input, including systemGestures, mandatorySystemGestures, waterfall, and tappableElement.

These insets represent status bar.

The insets that WindowInsetsCompat.Type.statusBars will consume if shown.

These insets represent all system bars.

The insets that WindowInsetsCompat.Type.systemBars will consume if shown.

The systemGestures insets represent the area of a window where system gestures have priority and may consume some or all touch input, e.g. due to the system bar occupying it, or it being reserved for touch-only gestures.

Returns the tappable element insets.

The insets that WindowInsetsCompat.Type.tappableElement will consume if active.

The insets for the curved areas in a waterfall display.