styling/dev.fritz2.styling.params/BoxParams

BoxParams

@ExperimentalCoroutinesApi

interface BoxParams : FlexParams, GridParams

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

Functions

active

open fun active(content: BasicParams.() -> Unit)

after

open fun after(content: BasicParams.() -> Unit)

alignContent

open fun alignContent(value: AlignContentValues.() -> AlignContentProperty)

This function sets the align-content property

open fun alignContent( sm: AlignContentValues.() -> AlignContentProperty? = null, md: AlignContentValues.() -> AlignContentProperty? = null, lg: AlignContentValues.() -> AlignContentProperty? = null, xl: AlignContentValues.() -> AlignContentProperty? = null)

This function sets the align-content property for each media device independently.

alignItems

open fun alignItems(value: AlignItemsValues.() -> AlignItemsProperty)

This function sets the align-items property

open fun alignItems( sm: AlignItemsValues.() -> AlignItemsProperty? = null, md: AlignItemsValues.() -> AlignItemsProperty? = null, lg: AlignItemsValues.() -> AlignItemsProperty? = null, xl: AlignItemsValues.() -> AlignItemsProperty? = null)

This function sets the align-items property for each media device independently.

anyLink

open fun anyLink(content: BasicParams.() -> Unit)

areas

open fun areas(value: GridAreaContext.() -> Unit)

This function opens a context (GridTemplateContext) to specify the overall layout of a grid layout via the grid-template-areas CSS property for all media devices.

open fun areas( sm: GridAreaContext.() -> Unit? = null, md: GridAreaContext.() -> Unit? = null, lg: GridAreaContext.() -> Unit? = null, xl: GridAreaContext.() -> Unit? = null)

This function opens a context (GridTemplateContext) to specify the overall layout of a grid layout via the grid-template-areas CSS property for each media device independently.

autoColumns

open fun autoColumns(value: GridTemplateContext.() -> Property)

This function opens a context (GridTemplateContext) to specify the auto columns layout of a grid layout via the grid-auto-columns CSS property for all media devices.

open fun autoColumns( sm: GridTemplateContext.() -> Property? = null, md: GridTemplateContext.() -> Property? = null, lg: GridTemplateContext.() -> Property? = null, xl: GridTemplateContext.() -> Property? = null)

This function opens a context (GridTemplateContext) to specify the auto columns layout of a grid layout via the grid-auto-columns CSS property for each media device independently.

autoFlow

open fun autoFlow(value: AutoFlowValues.() -> AutoFlowProperty)

This function sets the grid-auto-flow property for all media devices.

open fun autoFlow( sm: AutoFlowValues.() -> AutoFlowProperty? = null, md: AutoFlowValues.() -> AutoFlowProperty? = null, lg: AutoFlowValues.() -> AutoFlowProperty? = null, xl: AutoFlowValues.() -> AutoFlowProperty? = null)

This function sets the grid-auto-flow property for each media device independently.

autoRows

open fun autoRows(value: GridTemplateContext.() -> Property)

This function opens a context (GridTemplateContext) to specify the auto rows layout of a grid layout via the grid-auto-rows CSS property for all media devices.

open fun autoRows( sm: GridTemplateContext.() -> Property? = null, md: GridTemplateContext.() -> Property? = null, lg: GridTemplateContext.() -> Property? = null, xl: GridTemplateContext.() -> Property? = null)

This function opens a context (GridTemplateContext) to specify the auto rows layout of a grid layout via the grid-auto-rows CSS property for each media device independently.

background

open fun background(value: BackgroundContext.() -> Unit)

This function opens the context for defining the background related properties for all media devices.

open fun background( sm: BackgroundContext.() -> Unit? = null, md: BackgroundContext.() -> Unit? = null, lg: BackgroundContext.() -> Unit? = null, xl: BackgroundContext.() -> Unit? = null)

This function opens the context for defining the background related properties for each media device independently.

before

open fun before(content: BasicParams.() -> Unit)

blank

open fun blank(content: BasicParams.() -> Unit)

border

open fun border(value: BorderContext.() -> Unit)

This function opens the context for defining the border related properties for all media devices.

open fun border( sm: BorderContext.() -> Unit? = null, md: BorderContext.() -> Unit? = null, lg: BorderContext.() -> Unit? = null, xl: BorderContext.() -> Unit? = null)

This function opens the context for defining the border related properties for each media device independently.

borders

open fun borders(value: BordersContext.() -> Unit)

This function opens the intermediate context for defining the border related properties independently for each side for all media devices.

open fun borders( sm: BordersContext.() -> Unit? = null, md: BordersContext.() -> Unit? = null, lg: BordersContext.() -> Unit? = null, xl: BordersContext.() -> Unit? = null)

This function opens the intermediate context for defining the border related properties independently for each side and for each media device.

boxShadow

open fun boxShadow(value: Shadows.() -> Property)

This function sets the box-shadow property.

open fun boxShadow( sm: Shadows.() -> Property? = null, md: Shadows.() -> Property? = null, lg: Shadows.() -> Property? = null, xl: Shadows.() -> Property? = null)

This function sets the box-shadow property for each media device independently.

checked

open fun checked(content: BasicParams.() -> Unit)

children

open fun children(selector: String, content: BasicParams.() -> Unit)

color

open fun color(value: Colors.() -> ColorProperty)

This function sets the color property for all media devices.

open fun color( sm: Colors.() -> ColorProperty? = null, md: Colors.() -> ColorProperty? = null, lg: Colors.() -> ColorProperty? = null, xl: Colors.() -> ColorProperty? = null)

This function sets the color property for each media device independently.

columnGap

open fun columnGap(value: ScaledValueProperty)

This function sets the column-gap property for all media devices.

open fun columnGap( sm: ScaledValueProperty? = null, md: ScaledValueProperty? = null, lg: ScaledValueProperty? = null, xl: ScaledValueProperty? = null)

This function sets the column-gap property for each media device independently.

columns

open fun columns(value: GridTemplateContext.() -> Property)

This function opens a context (GridTemplateContext) to specify the column layout of a grid layout via the grid-template-columns CSS property for all media devices.

open fun columns( sm: GridTemplateContext.() -> Property? = null, md: GridTemplateContext.() -> Property? = null, lg: GridTemplateContext.() -> Property? = null, xl: GridTemplateContext.() -> Property? = null)

This function opens a context (GridTemplateContext) to specify the column layout of a grid layout via the grid-template-columns CSS property for each media device independently.

css

open fun css(value: Property): StringBuilder

This function passes raw CSS code into the underlying model without modification by fritz2 for all media devices at once.

open fun css( sm: Property? = null, md: Property? = null, lg: Property? = null, xl: Property? = null)

This function passes raw CSS code into the underlying model without modification by fritz2 for each media device independently.

current

open fun current(content: BasicParams.() -> Unit)

default

open fun default(content: BasicParams.() -> Unit)

dir

open fun dir(param: Property, content: BasicParams.() -> Unit)

direction

open fun direction(value: DirectionValues.() -> DirectionProperty)

This function sets the flex-direction property for all media devices.

open fun direction( sm: DirectionValues.() -> DirectionProperty? = null, md: DirectionValues.() -> DirectionProperty? = null, lg: DirectionValues.() -> DirectionProperty? = null, xl: DirectionValues.() -> DirectionProperty? = null)

This function sets the flex-direction property for each media device independently.

disabled

open fun disabled(content: BasicParams.() -> Unit)

display

open fun display(value: DisplayValues.() -> DisplayProperty)

This function sets the display property of a component for all media devices.

open fun display( sm: DisplayValues.() -> DisplayProperty? = null, md: DisplayValues.() -> DisplayProperty? = null, lg: DisplayValues.() -> DisplayProperty? = null, xl: DisplayValues.() -> DisplayProperty? = null)

This function sets the display property of a component for each media device independently.

empty

open fun empty(content: BasicParams.() -> Unit)

enabled

open fun enabled(content: BasicParams.() -> Unit)

first

open fun first(content: BasicParams.() -> Unit)

firstChild

open fun firstChild(content: BasicParams.() -> Unit)

firstLetter

open fun firstLetter(content: BasicParams.() -> Unit)

firstLine

open fun firstLine(content: BasicParams.() -> Unit)

firstOfType

open fun firstOfType(content: BasicParams.() -> Unit)

fitContent

open fun fitContent(value: Property): String

Function to create the CSS fit-content function.

flex

open fun flex(value: FlexItemContext.() -> Unit)

open fun flex( sm: FlexItemContext.() -> Unit? = null, md: FlexItemContext.() -> Unit? = null, lg: FlexItemContext.() -> Unit? = null, xl: FlexItemContext.() -> Unit? = null)

This function opens the context for defining the flex layout related properties for a flex layout child component for all media devices.

focus

open fun focus(content: BasicParams.() -> Unit)

focusVisible

open fun focusVisible(content: BasicParams.() -> Unit)

focusWithin

open fun focusWithin(content: BasicParams.() -> Unit)

fontFamily

open fun fontFamily(value: FontFamilies.() -> Property)

This function sets the font-family property.

open fun fontFamily( sm: FontFamilies.() -> Property? = null, md: FontFamilies.() -> Property? = null, lg: FontFamilies.() -> Property? = null, xl: FontFamilies.() -> Property? = null)

This function sets the font-family property for each media device independently.

fontSize

open fun fontSize(value: ScaledValueProperty)

This function sets the font-size property

open fun fontSize( sm: ScaledValueProperty? = null, md: ScaledValueProperty? = null, lg: ScaledValueProperty? = null, xl: ScaledValueProperty? = null)

This function sets the font-size property for each media device independently.

fontStyle

open fun fontStyle(value: FontStyles.() -> FontStyleProperty)

This function sets the font-style property

open fun fontStyle( sm: FontStyles.() -> FontStyleProperty? = null, md: FontStyles.() -> FontStyleProperty? = null, lg: FontStyles.() -> FontStyleProperty? = null, xl: FontStyles.() -> FontStyleProperty? = null)

This function sets the font-style property for each media device independently.

fontWeight

open fun fontWeight(value: FontWeights.() -> FontWeightProperty)

This function sets the font-weight property

open fun fontWeight( sm: FontWeights.() -> FontWeightProperty? = null, md: FontWeights.() -> FontWeightProperty? = null, lg: FontWeights.() -> FontWeightProperty? = null, xl: FontWeights.() -> FontWeightProperty? = null)

This function sets the font-weight property for each media device independently.

fullscreen

open fun fullscreen(content: BasicParams.() -> Unit)

future

open fun future(content: BasicParams.() -> Unit)

gap

open fun gap(value: ScaledValueProperty)

This convenience function sets the gap for the rows and columns in a grid all at once. for all media devices.

open fun gap( sm: ScaledValueProperty? = null, md: ScaledValueProperty? = null, lg: ScaledValueProperty? = null, xl: ScaledValueProperty? = null)

This convenience function sets the gap for the rows and columns in a grid all at once. for each media device independently.

grammarError

open fun grammarError(content: BasicParams.() -> Unit)

grid

open fun grid(value: GridContext.() -> Unit)

This function opens the context for defining the grid layout related properties for a grid layout child component for all media devices.

open fun grid( sm: GridContext.() -> Unit? = null, md: GridContext.() -> Unit? = null, lg: GridContext.() -> Unit? = null, xl: GridContext.() -> Unit? = null)

This function opens the context for defining the grid layout related properties for a grid layout child component for each media device independently.

height

open fun height(value: SizesProperty)

This function sets the height property of a component for all media devices.

open fun height( sm: SizesProperty? = null, md: SizesProperty? = null, lg: SizesProperty? = null, xl: SizesProperty? = null)

This function sets the height property of a component for each media device independently.

hover

open fun hover(content: BasicParams.() -> Unit)

indeterminate

open fun indeterminate(content: BasicParams.() -> Unit)

inRange

open fun inRange(content: BasicParams.() -> Unit)

invalid

open fun invalid(content: BasicParams.() -> Unit)

invoke

open operator override fun Style<BasicParams>.invoke()

open operator fun Style<BoxParams>.invoke()

open operator fun Style<FlexParams>.invoke()

open operator fun Style<GridParams>.invoke()

allows the usage of predefined styles in this context

justifyContent

open fun justifyContent(value: JustifyContentValues.() -> JustifyContentProperty)

This function sets the justify-content property

open fun justifyContent( sm: JustifyContentValues.() -> JustifyContentProperty? = null, md: JustifyContentValues.() -> JustifyContentProperty? = null, lg: JustifyContentValues.() -> JustifyContentProperty? = null, xl: JustifyContentValues.() -> JustifyContentProperty? = null)

This function sets the justify-content property for each media device independently.

lang

open fun lang(param: Property, content: BasicParams.() -> Unit)

lastChild

open fun lastChild(content: BasicParams.() -> Unit)

lastOfType

open fun lastOfType(content: BasicParams.() -> Unit)

left

open fun left(content: BasicParams.() -> Unit)

letterSpacing

open fun letterSpacing(value: ScaledValueProperty)

This function sets the letter-spacing property

open fun letterSpacing( sm: ScaledValueProperty? = null, md: ScaledValueProperty? = null, lg: ScaledValueProperty? = null, xl: ScaledValueProperty? = null)

This function sets the letter-spacing property for each media device independently.

lineHeight

open fun lineHeight(value: ScaledValueProperty)

This function sets the line-height property

open fun lineHeight( sm: ScaledValueProperty? = null, md: ScaledValueProperty? = null, lg: ScaledValueProperty? = null, xl: ScaledValueProperty? = null)

This function sets the line-height property for each media device independently.

link

open fun link(content: BasicParams.() -> Unit)

localLink

open fun localLink(content: BasicParams.() -> Unit)

margin

open fun margin(value: ScaledValueProperty)

This function sets the margin property.

open fun margin( sm: ScaledValueProperty? = null, md: ScaledValueProperty? = null, lg: ScaledValueProperty? = null, xl: ScaledValueProperty? = null)

This function sets the margin property for each media device independently.

margins

open fun margins(value: SpacesContext.() -> Unit)

This function opens the context for defining the margin related properties.

open fun margins( sm: SpacesContext.() -> Unit? = null, md: SpacesContext.() -> Unit? = null, lg: SpacesContext.() -> Unit? = null, xl: SpacesContext.() -> Unit? = null)

This function opens the context for defining the margin related properties for each media device independently.

marker

open fun marker(content: BasicParams.() -> Unit)

maxHeight

open fun maxHeight(value: SizesProperty)

open fun maxHeight( sm: SizesProperty? = null, md: SizesProperty? = null, lg: SizesProperty? = null, xl: SizesProperty? = null)

This function sets the max-height property of a component for all media devices.

maxWidth

open fun maxWidth(value: SizesProperty)

open fun maxWidth( sm: SizesProperty? = null, md: SizesProperty? = null, lg: SizesProperty? = null, xl: SizesProperty? = null)

This function sets the max-width property of a component for all media devices.

minHeight

open fun minHeight(value: SizesProperty)

open fun minHeight( sm: SizesProperty? = null, md: SizesProperty? = null, lg: SizesProperty? = null, xl: SizesProperty? = null)

This function sets the min-height property of a component for all media devices.

minWidth

open fun minWidth(value: SizesProperty)

open fun minWidth( sm: SizesProperty? = null, md: SizesProperty? = null, lg: SizesProperty? = null, xl: SizesProperty? = null)

This function sets the min-width property of a component for all media devices.

not

open fun not(param: Property, content: BasicParams.() -> Unit)

nthChild

open fun nthChild(param: Property, content: BasicParams.() -> Unit)

nthLastChild

open fun nthLastChild(param: Property, content: BasicParams.() -> Unit)

nthLastOfType

open fun nthLastOfType(param: Property, content: BasicParams.() -> Unit)

nthOfType

open fun nthOfType(param: Property, content: BasicParams.() -> Unit)

onlyChild

open fun onlyChild(content: BasicParams.() -> Unit)

onlyOfType

open fun onlyOfType(content: BasicParams.() -> Unit)

opacity

open fun opacity(value: WeightedValueProperty)

This function sets the opacity property for all media devices.

open fun opacity( sm: WeightedValueProperty? = null, md: WeightedValueProperty? = null, lg: WeightedValueProperty? = null, xl: WeightedValueProperty? = null)

This function sets the opacity property for each media device independently.

optional

open fun optional(content: BasicParams.() -> Unit)

outOfRange

open fun outOfRange(content: BasicParams.() -> Unit)

overflow

open fun overflow(value: OverflowValues.() -> OverflowProperty)

This function sets the overflow property of a component for all media devices.

open fun overflow( sm: OverflowValues.() -> OverflowProperty? = null, md: OverflowValues.() -> OverflowProperty? = null, lg: OverflowValues.() -> OverflowProperty? = null, xl: OverflowValues.() -> OverflowProperty? = null)

This function sets the overflow property of a component for each media device independently.

overflowX

open fun overflowX(value: OverflowXValues.() -> OverflowProperty)

open fun overflowX( sm: OverflowXValues.() -> OverflowProperty? = null, md: OverflowXValues.() -> OverflowProperty? = null, lg: OverflowXValues.() -> OverflowProperty? = null, xl: OverflowXValues.() -> OverflowProperty? = null)

This function sets the overflow-x property of a component for all media devices.

overflowY

open fun overflowY(value: OverflowYValues.() -> OverflowProperty)

open fun overflowY( sm: OverflowYValues.() -> OverflowProperty? = null, md: OverflowYValues.() -> OverflowProperty? = null, lg: OverflowYValues.() -> OverflowProperty? = null, xl: OverflowYValues.() -> OverflowProperty? = null)

This function sets the overflow-y property of a component for all media devices.

padding

open fun padding(value: ScaledValueProperty)

This function sets the padding property

open fun padding( sm: ScaledValueProperty? = null, md: ScaledValueProperty? = null, lg: ScaledValueProperty? = null, xl: ScaledValueProperty? = null)

This function sets the padding property for each media device independently.

paddings

open fun paddings(value: SpacesContext.() -> Unit)

This function opens the context for defining the padding related properties.

open fun paddings( sm: SpacesContext.() -> Unit? = null, md: SpacesContext.() -> Unit? = null, lg: SpacesContext.() -> Unit? = null, xl: SpacesContext.() -> Unit? = null)

This function opens the context for defining the padding related properties for each media device independently.

position

open fun position(value: PositionContext.() -> Unit)

This function sets the position CSS property of an element for all media devices at once.

open fun position( sm: PositionContext.() -> Unit? = null, md: PositionContext.() -> Unit? = null, lg: PositionContext.() -> Unit? = null, xl: PositionContext.() -> Unit? = null)

This function sets the position CSS property of an element for each media device independently.

radii

open fun radii(value: RadiiContext.() -> Unit)

This function opens the context for defining the radius related properties for each corner independently for all media devices.

open fun radii( sm: RadiiContext.() -> Unit? = null, md: RadiiContext.() -> Unit? = null, lg: RadiiContext.() -> Unit? = null, xl: RadiiContext.() -> Unit? = null)

This function opens the context for defining the radius related properties for each corner and for each media device independently

radius

open fun radius(value: ScaledValueProperty)

This function sets the radius property for all media devices.

open fun radius( sm: ScaledValueProperty? = null, md: ScaledValueProperty? = null, lg: ScaledValueProperty? = null, xl: ScaledValueProperty? = null)

This function sets the radius property for each media device independently.

readOnly

open fun readOnly(content: BasicParams.() -> Unit)

readWrite

open fun readWrite(content: BasicParams.() -> Unit)

required

open fun required(content: BasicParams.() -> Unit)

right

open fun right(content: BasicParams.() -> Unit)

root

open fun root(content: BasicParams.() -> Unit)

rowGap

open fun rowGap(value: ScaledValueProperty)

This function sets the row-gap property for all media devices.

open fun rowGap( sm: ScaledValueProperty? = null, md: ScaledValueProperty? = null, lg: ScaledValueProperty? = null, xl: ScaledValueProperty? = null)

This function sets the row-gap property for each media device independently.

rows

open fun rows(value: GridTemplateContext.() -> Property)

This function opens a context (GridTemplateContext) to specify the row layout of a grid layout via the grid-template-rows CSS property for all media devices.

open fun rows( sm: GridTemplateContext.() -> Property? = null, md: GridTemplateContext.() -> Property? = null, lg: GridTemplateContext.() -> Property? = null, xl: GridTemplateContext.() -> Property? = null)

This function opens a context (GridTemplateContext) to specify the row layout of a grid layout via the grid-template-rows CSS property for each media device independently.

scope

open fun scope(content: BasicParams.() -> Unit)

selection

open fun selection(content: BasicParams.() -> Unit)

size

open fun size(value: SizesProperty)

open fun size( sm: SizesProperty? = null, md: SizesProperty? = null, lg: SizesProperty? = null, xl: SizesProperty? = null)

This convenience function sets the width and height of a component at once for all media devices.

spellingError

open fun spellingError(content: BasicParams.() -> Unit)

target

open fun target(content: BasicParams.() -> Unit)

textAlign

open fun textAlign(value: TextAligns.() -> TextAlignProperty)

This function sets the text-align property

open fun textAlign( sm: TextAligns.() -> TextAlignProperty? = null, md: TextAligns.() -> TextAlignProperty? = null, lg: TextAligns.() -> TextAlignProperty? = null, xl: TextAligns.() -> TextAlignProperty? = null)

This function sets the text-align property for each media device independently.

textDecoration

open fun textDecoration(value: TextDecorations.() -> TextDecorationProperty)

This function sets the text-decoration property

open fun textDecoration( sm: TextDecorations.() -> TextDecorationProperty? = null, md: TextDecorations.() -> TextDecorationProperty? = null, lg: TextDecorations.() -> TextDecorationProperty? = null, xl: TextDecorations.() -> TextDecorationProperty? = null)

This function sets the text-decoration property for each media device independently.

textShadow

open fun textShadow(value: Shadows.() -> Property)

This function sets the text-shadow property.

open fun textShadow( sm: Shadows.() -> Property? = null, md: Shadows.() -> Property? = null, lg: Shadows.() -> Property? = null, xl: Shadows.() -> Property? = null)

This function sets the text-shadow property for each media device independently.

textTransform

open fun textTransform(value: TextTransforms.() -> TextTransformProperty)

This function sets the text-transform property

open fun textTransform( sm: TextTransforms.() -> TextTransformProperty? = null, md: TextTransforms.() -> TextTransformProperty? = null, lg: TextTransforms.() -> TextTransformProperty? = null, xl: TextTransforms.() -> TextTransformProperty? = null)

This function sets the text-transform property for each media device independently.

valid

open fun valid(content: BasicParams.() -> Unit)

verticalAlign

open fun verticalAlign(value: VerticalAlignValues.() -> VerticalAlignProperty)

This function sets the vertical-align property of a component for all media devices.

open fun verticalAlign( sm: VerticalAlignValues.() -> VerticalAlignProperty? = null, md: VerticalAlignValues.() -> VerticalAlignProperty? = null, lg: VerticalAlignValues.() -> VerticalAlignProperty? = null, xl: VerticalAlignValues.() -> VerticalAlignProperty? = null)

This function sets the vertical-align property of a component for each media device independently.

visited

open fun visited(content: BasicParams.() -> Unit)

width

open fun width(value: SizesProperty)

This function sets the width property of a component for all media devices.

open fun width( sm: SizesProperty? = null, md: SizesProperty? = null, lg: SizesProperty? = null, xl: SizesProperty? = null)

This function sets the width property of a component for each media device independently.

wrap

open fun wrap(value: WrapValues.() -> WrapProperty)

This function sets the flex-wrap property for all media devices.

open fun wrap( sm: WrapValues.() -> WrapProperty? = null, md: WrapValues.() -> WrapProperty? = null, lg: WrapValues.() -> WrapProperty? = null, xl: WrapValues.() -> WrapProperty? = null)

This function sets the flex-wrap property for each media device independently.

zIndex

open fun zIndex(value: ZIndicesProperty)

This function sets the z-index CSS property of an element for all media devices at once.

open fun zIndex( sm: ZIndicesProperty? = null, md: ZIndicesProperty? = null, lg: ZIndicesProperty? = null, xl: ZIndicesProperty? = null)

This function sets the z-index CSS property of an element for each media device independently.

Properties

lgProperties

abstract val lgProperties: StringBuilder

collects the properties for large screens

mdProperties

abstract val mdProperties: StringBuilder

collects the properties for middle-sized screens

smProperties

abstract val smProperties: StringBuilder

collects the properties for small screens

xlProperties

abstract val xlProperties: StringBuilder

collects the properties for extra-large screens

Inheritors

StyleParamsImpl