RulerScope

Added in 1.7.0

Cmn

@MeasureScopeMarker
interface RulerScope : Density

A scope used in MeasureScope.layout for the rulers parameter to allow a layout to define Ruler values for children.

import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.WindowInsets
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.safeContent
import androidx.compose.ui.Modifier
import androidx.compose.ui.layout.layout

val safeInsets = WindowInsets.safeContent

Box(
    Modifier.fillMaxSize().layout { measurable, constraints ->
        val placeable = measurable.measure(constraints)
        layout(
            width = placeable.width,
            height = placeable.height,
            rulers = {
                val height = coordinates.size.height
                SafeBottomRuler provides (height - safeInsets.getBottom(this)).toFloat()
            },
        ) {
            placeable.place(0, 0)
        }
    },
    content = content,
)

Summary

Public functions
`infix Unit`	`Ruler.provides(value: Float)` Provides a constant value for a `Ruler`.	Cmn
`infix Unit`	`VerticalRuler.providesRelative(value: Float)` Provides a `VerticalRuler` value that is relative to the left side in an LTR layout or right side on an RTL layout.	Cmn

Public properties
`LayoutCoordinates`	`coordinates` `LayoutCoordinates` of the position in the hierarchy that the `Ruler` will be `provided`.	Cmn

Inherited functions

From androidx.compose.ui.unit.Density

`open Int`	`Dp.roundToPx()` Convert `Dp` to `Int` by rounding	Cmn
`open Int`	`TextUnit.roundToPx()` Convert Sp to `Int` by rounding	Cmn
`open Dp`	`Int.toDp()` Convert an `Int` pixel value to `Dp`.	Cmn
`open Dp`	`Float.toDp()` Convert a `Float` pixel value to a Dp	Cmn
`open DpSize`	`Size.toDpSize()` Convert a `Size` to a `DpSize`.	Cmn
`open Float`	`Dp.toPx()` Convert `Dp` to pixels.	Cmn
`open Float`	`TextUnit.toPx()` Convert Sp to pixels.	Cmn
`open Rect`	`DpRect.toRect()` Convert a `DpRect` to a `Rect`.	Cmn
`open Size`	`DpSize.toSize()` Convert a `DpSize` to a `Size`.	Cmn
`open TextUnit`	`Int.toSp()` Convert an `Int` pixel value to Sp.	Cmn
`open TextUnit`	`Float.toSp()` Convert a `Float` pixel value to a Sp	Cmn

From androidx.compose.ui.unit.FontScaling

`open Dp`	`TextUnit.toDp()` Convert Sp to `Dp`.	Cmn
`open TextUnit`	`Dp.toSp()` Convert `Dp` to Sp.	Cmn

Inherited properties

From androidx.compose.ui.unit.Density

Float

density

The logical density of the display.

Cmn

From androidx.compose.ui.unit.FontScaling

Float

fontScale

Current user preference for the scaling factor for fonts.

Cmn

Public functions

provides

Cmn

Artifact: androidx.compose.ui:ui

View Source

Added in 1.7.0

infix fun Ruler.provides(value: Float): Unit

Provides a constant value for a Ruler.

providesRelative

Cmn

Artifact: androidx.compose.ui:ui

View Source

Added in 1.7.0

infix fun VerticalRuler.providesRelative(value: Float): Unit

Provides a VerticalRuler value that is relative to the left side in an LTR layout or right side on an RTL layout.

Public properties

coordinates

Cmn

Added in 1.7.0

val coordinates: LayoutCoordinates

LayoutCoordinates of the position in the hierarchy that the Ruler will be provided.