Typealias for the common function signature of [RenderContext. methods. It is used for defining a generic extension method for styling basic HTML elements.

BasicParams

@ExperimentalCoroutinesApi()

interface BasicParams : Space, Color, Border, Typo, Background, Position, Shadow, Layout, PseudoClasses, PseudoElements

interface combining all the basic style-parameters

Border

@ExperimentalCoroutinesApi()

interface Border : StyleParams

This context interface offers functions to style the border related CSS properties of a component.

BorderContext

@ExperimentalCoroutinesApi()

class BorderContext(widthKey: String, styleKey: String, colorKey: String, styleParams: StyleParams, target: StringBuilder) : StyleParams

This context class enables the definition of the common border styling properties like width, style and color.

BordersContext

@ExperimentalCoroutinesApi()

class BordersContext(styleParams: StyleParams, target: StringBuilder) : StyleParams

This context class acts as an intermediate context to style the four sides of a border independently.

BorderStyleProperty

typealias BorderStyleProperty = Property

Alias for specific BorderStyleValues properties.

BorderStyleValues

object BorderStyleValues : PropertyValues

Predefined values for the border-style property.

BoxParams

@ExperimentalCoroutinesApi()

interface BoxParams : FlexParams, GridParams

interface combining flex-style-parameters with grid and basic style-parameters

Color

@ExperimentalCoroutinesApi()

interface Color : StyleParams

This context interface offers functions to style the color related CSS properties of a component.

ColorProperty

typealias ColorProperty = Property

alias for colors

DirectionProperty

typealias DirectionProperty = Property

Alias for the specific DirectionValues properties.

DirectionValues

object DirectionValues : PropertyValues

Predefined values for the flex-direction property.

DisplayProperty

typealias DisplayProperty = Property

Alias for specific DisplayValues properties.

DisplayValues

object DisplayValues : PropertyValues

Predefined values for the display property.

FlexBasisProperty

typealias FlexBasisProperty = Property

Alias for specific FlexBasisValues properties.

FlexBasisValues

object FlexBasisValues : PropertyValues

Predefined values for the flex-basis property.

Flexbox

@ExperimentalCoroutinesApi()

interface Flexbox : StyleParams, Alignment

This context interface offers functions to styleflexbox(https://developer.mozilla.org/en/docs/Learn/CSS/CSS_layout/Flexbox)-layouts.

FlexItemContext

@ExperimentalCoroutinesApi()

class FlexItemContext(styleParams: StyleParams, selfAlignment: SelfAlignment, target: StringBuilder) : StyleParams, SelfAlignment

This context interface offers functions to style elements of a flex layout.

FlexParams

@ExperimentalCoroutinesApi()

interface FlexParams : BasicParams, Flexbox

interface combining flex-style-parameters with the basic style-parameters

FontStyleProperty

typealias FontStyleProperty = Property

Alias for specific FontStyleProperty properties.

FontStyles

object FontStyles : PropertyValues

Predefined values for the font-style property.

FontWeightProperty

typealias FontWeightProperty = Property

Alias for specific FontWeightProperty properties.

FontWeights

object FontWeights : PropertyValues

Predefined values for the font-weight property.

GridAreaContext

@ExperimentalCoroutinesApi()

class GridAreaContext(styleParams: StyleParams, target: StringBuilder) : StyleParams

This context class is responsible for defining the grid area layout as comfortable and safe as possible.

GridContext

@ExperimentalCoroutinesApi()

class GridContext(styleParams: StyleParams, selfAlignment: SelfAlignment, target: StringBuilder) : StyleParams, SelfAlignment

This context interface offers functions to stylegrid layout(https://developer.mozilla.org/en/docs/Web/CSS/CSS_Grid_Layout)-cells / child elements.

GridLayout

@ExperimentalCoroutinesApi()

interface GridLayout : StyleParams, Alignment

This context interface offers functions to style the container component for grid(https://developer.mozilla.org/en/docs/Web/CSS/CSS_Grid_Layout/Basic_Concepts_of_Grid_Layout)-layouts.

GridParams

@ExperimentalCoroutinesApi()

interface GridParams : BasicParams, GridLayout

interface combining grid-style-parameters with the basic style-parameters

GridRowColumnContext

@ExperimentalCoroutinesApi()

class GridRowColumnContext(keyFragment: String, styleParams: StyleParams, target: StringBuilder) : StyleParams

GridTemplateContext

@ExperimentalCoroutinesApi()

class GridTemplateContext(styleParams: StyleParams, target: StringBuilder) : StyleParams

This context class enables to set the template properties for rows, columns and their corresponding automatic variants for dynamically added rows or columns (have a look at Auto placement documentation) in a flexible yet comfortable way.

JustifyContentProperty

typealias JustifyContentProperty = Property

Alias for specific justification properties.

JustifyContentValues

object JustifyContentValues : PropertyValues

Predefined values for justification Central Alignment Contexts inspired by https://drafts.csswg.

Layout

@ExperimentalCoroutinesApi()

interface Layout : StyleParams

This context interface offers different functions to define or affect the fundamental layout of the whole page, a container within the page or an element itself.

OverflowBaseValues

open class OverflowBaseValues(key: String) : PropertyValues

Predefined common values for the overflow related properties.

OverflowProperty

typealias OverflowProperty = Property

Alias for specific OverflowBaseValues properties.

OverflowValues

object OverflowValues : OverflowBaseValues

Predefined values for the overflow property.

OverflowXValues

object OverflowXValues : OverflowBaseValues

Predefined values for the overflow-x property.

OverflowYValues

object OverflowYValues : OverflowBaseValues

Predefined values for the overflow-y property.

Position

@ExperimentalCoroutinesApi()

interface Position : StyleParams

This context interface offers two functions to specify the positional appearance of an element.

PositionContext

@ExperimentalCoroutinesApi()

class PositionContext(styleParams: StyleParams, target: StringBuilder) : StyleParams

This context class acts as an intermediate context to set the position of an element and to specify the actual positioning concerning the sides distances too.

PositioningContext

@ExperimentalCoroutinesApi()

class PositioningContext(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.

PropertyValues

interface PropertyValues

base-interface for all enum base properties

PseudoClasses

@ExperimentalCoroutinesApi()

interface PseudoClasses : StyleParams

PseudoElements

@ExperimentalCoroutinesApi()

interface PseudoElements : StyleParams

RadiiContext

@ExperimentalCoroutinesApi()

class RadiiContext(styleParams: StyleParams, target: StringBuilder) : StyleParams

This context class is used to provide a scope for styling the four radii of a border independently.

ScaledValueProperty

typealias ScaledValueProperty = ScaledValue.() -> Property

shortcut for functions that derive a value from ScaledValue defined at the Theme

SelfAlignItemProperty

typealias SelfAlignItemProperty = Property

Alias for specific self alignment properties.

SelfAlignItemsValues

object SelfAlignItemsValues : PropertyValues

Predefined values for self alignment Central Alignment Contexts inspired by https://drafts.csswg.

SelfAlignment

interface SelfAlignment

This context interface offers functions for self-alignment.

Shadow

interface Shadow : StyleParams

This context interface offers functions to style the shadow related CSS properties of a component.

ShadowProperty

typealias ShadowProperty = Property

Alias for specific Shadow properties.

SizesProperty

typealias SizesProperty = Sizes.() -> Property

shortcut for functions that derive a value from SizesProperty defined at the Theme

Space

@ExperimentalCoroutinesApi()

interface Space : StyleParams

This context interface offers functions to style the space related CSS properties of a component.

SpacesContext

@ExperimentalCoroutinesApi()

class SpacesContext(topKey: String, leftKey: String, bottomKey: String, rightKey: String, styleParams: StyleParams, target: StringBuilder) : StyleParams

This context class enables the definition of the common space oriented (margin and padding) styling properties.

Style

typealias Style<T> = T.() -> Unit

shortcut for a function defining style-parameters

StyleParams

interface StyleParams

Basic interface for all StyleParams-classes

StyleParamsImpl

@ExperimentalCoroutinesApi()

open class StyleParamsImpl : BoxParams

Implemantation of all StyleParams-interface providing the needed StringBuilders

StyleParamsMarker

@DslMarker()

annotation class StyleParamsMarker

DSLMarker-annotation for style-parameter-DSL

TextAlignProperty

typealias TextAlignProperty = Property

Alias for specific TextAlignProperty properties.

TextAligns

object TextAligns : PropertyValues

Predefined values for the text-align property.

TextDecorationProperty

typealias TextDecorationProperty = Property

Alias for specific TextDecorations properties.

TextDecorations

object TextDecorations : PropertyValues

Predefined values for the font-weight property.

TextTransformProperty

typealias TextTransformProperty = Property

Alias for specific TextTransformProperty properties.

TextTransforms

object TextTransforms : PropertyValues

Predefined values for the text-transform property.

Typo

@ExperimentalCoroutinesApi()

interface Typo : StyleParams

This context interface offers functions to style the typography related CSS properties of a component.

VerticalAlignProperty

typealias VerticalAlignProperty = Property

Alias for specific VerticalAlignValues properties.

VerticalAlignValues

object VerticalAlignValues : PropertyValues

Predefined values for the vertical-align property.

WeightedValueProperty

typealias WeightedValueProperty = WeightedValue.() -> Property

shortcut for functions that derive a value from WeightedValue defined at the Theme

WrapProperty

typealias WrapProperty = Property

Alias for the specific WrapValues properties.

WrapValues

object WrapValues : PropertyValues

Predefined values for the flex-wrap property.

ZIndicesProperty

typealias ZIndicesProperty = ZIndices.() -> Property

shortcut for functions that derive a value from ZIndicesProperty defined at the Theme

Functions

alterHexColorBrightness

fun alterHexColorBrightness(color: ColorProperty, brightness: Double): ColorProperty

alters the brightness of a given input color in the hex format.

and

infix fun ShadowProperty.and(other: ShadowProperty): ShadowProperty

combines to shadow property values created by shadow

hsl

fun hsl(h: Int, s: Int, l: Int): String

creates a ColorProperty from hsl-values

hsla

fun hsla(h: Int, s: Int, l: Int, a: Double): String

creates a ColorProperty from hsla-values

plus

inline operator fun <T> Style<T>.plus(crossinline other: Style<T>): Style<T>

combines to Styles

property

inline fun <T : PropertyValues> StyleParams.property(base: T, value: T.() -> Property)

sets an enum-based property for small-screens (default)

fun StyleParams.property(key: String, value: Property, target: StringBuilder = smProperties)

sets a property for a given target screen size

inline fun <T> StyleParams.property(key: String, base: T, value: T.() -> Property, target: StringBuilder = smProperties)

sets a property derived from the Theme

fun <T : PropertyValues> StyleParams.property(base: T, sm: T.() -> Property? = null, md: T.() -> Property? = null, lg: T.() -> Property? = null, xl: T.() -> Property? = null)

sets a responsive enum-based property

fun StyleParams.property(key: String, sm: Property? = null, md: Property? = null, lg: Property? = null, xl: Property? = null)

sets a responsive property for

fun <T> StyleParams.property(key: String, base: T, sm: T.() -> Property? = null, md: T.() -> Property? = null, lg: T.() -> Property? = null, xl: T.() -> Property? = null)

sets a responsive property derived from the Theme

rgb

fun rgb(r: Int, g: Int, b: Int): String

creates a ColorProperty from rgb-values

rgba

fun rgba(r: Int, g: Int, b: Int, a: Double): String

creates a ColorProperty from rgba-values

shadow

fun shadow(offsetHorizontal: String, offsetVertical: String = offsetHorizontal, blur: String? = null, spread: String? = null, color: String? = null, inset: Boolean = false): ShadowProperty

creates a valid value for shadow-properties like box-shadow or text-shadow

styled

fun <E> BasicComponent<E>.styled(baseClass: StyleClass = StyleClass.None, id: String? = null, prefix: String = "css", styling: BoxParams.() -> Unit): TagContext.(E.() -> Unit) -> E

Extension method that enables the usage of fritz2's powerful styling DSL for basic HTML elements.

fun <E> BasicComponent<E>.styled(parentStyling: BoxParams.() -> Unit = {}, baseClass: StyleClass = StyleClass.None, id: String? = null, prefix: String = "css", styling: BoxParams.() -> Unit): TagContext.(E.() -> Unit) -> E

Extension method that enables the usage of fritz2's powerful styling DSL for basic HTML elements.

Properties

boxShadowKey

const val boxShadowKey: String

cssDelimiter

const val cssDelimiter: String

end

val AreaName.end: String

Extension property that generates the value for the end grid line of an area

middle

val AreaName.middle: String

Extension property that generates the value for the middle between the start and end grid lines of an area

start

val AreaName.start: String

Extension property that generates the value for the start grid line of an area

textShadowKey

const val textShadowKey: String