Optimizes the visibility of the floating element by choosing the placement that has the most space available automatically, without needing to specify a preferred placement. Alternative to flip.

fun autoPlacement(init: AutoPlacementOptions.() -> Unit): Middleware

convertValueToCoords

external fun convertValueToCoords(state: MiddlewareState, options: OffsetOptions): Promise<Coords>

flip

external fun flip(options: FlipOptions? = definedExternally): Middleware

Optimizes the visibility of the floating element by flipping the placement in order to keep it in view when the preferred placement(s) will overflow the clipping boundary. Alternative to autoPlacement.

fun flip(init: FlipOptions.() -> Unit): Middleware

getPlacementList

external fun getPlacementList(alignment: Alignment?, autoAlignment: Boolean, allowedPlacements: Array<Placement>): Array<Placement>

getRectsByLine

external fun getRectsByLine(rects: Array<ClientRectObject>): Array<ClientRectObject>

hide

external fun hide(options: HideOptions?): Middleware

Provides data to hide the floating element in applicable situations, such as when it is not in the same clipping context as the reference element.

fun hide(init: HideOptions.() -> Unit): Middleware

inline

external fun inline(options: InlineOptions? = definedExternally): Middleware

Provides improved positioning for inline reference elements that can span over multiple lines, such as hyperlinks or range selections.

fun inline(init: InlineOptions.() -> Unit): Middleware

limitShift

external fun limitShift(options: LimitShiftOptions? = definedExternally): ShiftOptionsLimiter

Built-in limiter that will stop shift() at a certain point.

fun limitShift(init: LimitShiftOptions.() -> Unit): ShiftOptionsLimiter

offset

external fun offset(options: OffsetOptions): Middleware

Modifies the placement by translating the floating element along the specified axes. A number (shorthand for mainAxis or distance), or an axes configuration object may be passed.

fun offset(init: OffsetOptions.() -> Unit): Middleware

fun offset(mainAxis: Number): Middleware

shift

external fun shift(options: ShiftOptions? = definedExternally): Middleware

Optimizes the visibility of the floating element by shifting it in order to keep it in view when it will overflow the clipping boundary.

fun shift(init: ShiftOptions.() -> Unit): Middleware

size

external fun size(options: SizeOptions? = definedExternally): Middleware

Provides data that allows you to change the size of the floating element — for instance, prevent it from overflowing the clipping boundary or match the width of the reference element.

fun size(init: SizeOptions.() -> Unit): Middleware