styling/dev.fritz2.styling.params/PositioningContext

PositioningContext

@ExperimentalCoroutinesApi

class PositioningContext(val styleParams: StyleParams, target: StringBuilder) : StyleParams

This context class enables the definition of positioning properties for the four directions of top, right, bottom and left and convenience functions for defining the horizontal or vertical aspects at once.

This enables to define the position as follows:

position { /* it == PositionContext.() */
    absolute { /* it == PositioningContext.() */
            top { large } // use predefined property of the theme
            right { "2em" } // use a custom value
        }
    }

Parameters

styleParams

basic context scope interface

target

the defined output StringBuilder to write the generated CSS into

Constructors

PositioningContext

fun PositioningContext(styleParams: StyleParams, target: StringBuilder)

Functions

fun bottom(value: ScaledValueProperty)

This function is used to define the positional behaviour of an element by the bottom property.

fun horizontal(value: ScaledValueProperty)

This convenience function is used to define the horizontal positional behaviour of an element by the right and left properties at once.

fun left(value: ScaledValueProperty)

This function is used to define the positional behaviour of an element by the left property.

fun right(value: ScaledValueProperty)

This function is used to define the positional behaviour of an element by the right property.

fun top(value: ScaledValueProperty)

This function is used to define the positional behaviour of an element by the top property.

fun vertical(value: ScaledValueProperty)

This convenience function is used to define the vertical positional behaviour of an element by the top and bottom properties at once.

Properties

open override val lgProperties: StringBuilder

collects the properties for large screens

open override val mdProperties: StringBuilder

collects the properties for middle-sized screens

open override val smProperties: StringBuilder

collects the properties for small screens

val styleParams: StyleParams

open override val xlProperties: StringBuilder

collects the properties for extra-large screens