ui/me.tbsten.compose.preview.lab.ui.components/MenuPosition

MenuPosition

Interfaces for positioning a menu within a window. This is the same purpose as the interface PopupPositionProvider, except Vertical and Horizontal separate out the positioning logic for each direction individually.

Types

Horizontal

@Stable

fun interface Horizontal

An interface to calculate the horizontal position of a menu with respect to its anchor, window, and layout direction. The returned x-coordinate is relative to the window.

Vertical

@Stable

fun interface Vertical

An interface to calculate the vertical position of a menu with respect to its anchor and window. The returned y-coordinate is relative to the window.

Functions

bottomToAnchorTop

fun bottomToAnchorTop(offset: Int = 0): MenuPosition.Vertical

Returns a MenuPosition.Vertical which aligns the bottom of the menu to the top of the anchor.

bottomToWindowBottom

fun bottomToWindowBottom(margin: Int = 0): MenuPosition.Vertical

Returns a MenuPosition.Vertical which aligns the bottom of the menu to the bottom of the window.

centerToAnchorTop

fun centerToAnchorTop(offset: Int = 0): MenuPosition.Vertical

Returns a MenuPosition.Vertical which aligns the center of the menu to the top of the anchor.

endToAnchorEnd

fun endToAnchorEnd(offset: Int = 0): MenuPosition.Horizontal

Returns a MenuPosition.Horizontal which aligns the end of the menu to the end of the anchor.

leftToWindowLeft

fun leftToWindowLeft(margin: Int = 0): MenuPosition.Horizontal

Returns a MenuPosition.Horizontal which aligns the left of the menu to the left of the window.

rightToWindowRight

fun rightToWindowRight(margin: Int = 0): MenuPosition.Horizontal

Returns a MenuPosition.Horizontal which aligns the right of the menu to the right of the window.

startToAnchorStart

fun startToAnchorStart(offset: Int = 0): MenuPosition.Horizontal

Returns a MenuPosition.Horizontal which aligns the start of the menu to the start of the anchor.

topToAnchorBottom

fun topToAnchorBottom(offset: Int = 0): MenuPosition.Vertical

Returns a MenuPosition.Vertical which aligns the top of the menu to the bottom of the anchor.

topToWindowTop

fun topToWindowTop(margin: Int = 0): MenuPosition.Vertical

Returns a MenuPosition.Vertical which aligns the top of the menu to the top of the window.