kvision/io.kvision.core/Style

Style

open class Style(selector: String? = null, pClass: PClass? = null, pElement: PElement? = null, mediaQuery: String? = null, val parentStyle: Style? = null, init: Style.() -> Unit? = null) : StyledComponent

CSS style object.

Parameters

selector

optional name of the CSS selector, it will be generated if not specified

pClass

CSS pseudo class

pElement

CSS pseudo element

mediaQuery

CSS media query

parentStyle

parent CSS style object

init

an initializer extension function

Inheritors

InheritingStyle

Constructors

Style

constructor(selector: String? = null, pClass: PClass? = null, pElement: PElement? = null, mediaQuery: String? = null, parentStyle: Style? = null, init: Style.() -> Unit? = null)

Types

Companion

object Companion

Properties

alignContent

open var alignContent: AlignContent?

CSS flexbox/grid content alignment.

alignItems

open var alignItems: AlignItems?

CSS flexbox/grid items alignment.

alignSelf

open var alignSelf: AlignItems?

CSS flexbox items self-alignment.

background

open var background: Background?

Background of the current component.

border

open var border: Border?

Border of the current component.

borderBottom

open var borderBottom: Border?

Bottom border of the current component.

borderLeft

open var borderLeft: Border?

Left border of the current component.

borderRadius

open var borderRadius: <Error class: unknown class><Number, UNIT>?

CSS border radius.

borderRadiusList

open var borderRadiusList: List<<Error class: unknown class><Number, UNIT>>?

List of CSS border radius values.

borderRight

open var borderRight: Border?

Right border of the current component.

borderTop

open var borderTop: Border?

Top border of the current component.

bottom

open var bottom: <Error class: unknown class><Number, UNIT>?

Bottom edge of the current component.

boxShadow

open var boxShadow: BoxShadow?

Box shadow of the current component.

boxShadowList

open var boxShadowList: List<BoxShadow>?

List of box shadows of the current component.

clear

open var clear: Clear?

CSS clear float of the current component.

color

open var color: Color?

Text color for the current component.

colorHex

open var colorHex: Int?

Text color for the current component given in hex format (write only).

colorName

open var colorName: Col?

Text color for the current component given with named constant (write only).

cursor

open var cursor: Cursor?

CSS cursor shape over the current component.

customPClass

var customPClass: String?

The name of the custom CSS pseudo class.

display

open var display: Display?

CSS display of the current component.

flexBasis

open var flexBasis: <Error class: unknown class><Number, UNIT>?

CSS flexbox item basis.

flexDirection

open var flexDirection: FlexDirection?

CSS flexbox direction.

flexGrow

open var flexGrow: Int?

CSS flexbox item grow.

flexShrink

open var flexShrink: Int?

CSS flexbox item shrink.

flexWrap

open var flexWrap: FlexWrap?

CSS flexbox wrap mode.

float

open var float: PosFloat?

CSS position float of the current component.

fontFamily

open var fontFamily: String?

CSS font family of the current component.

fontSize

open var fontSize: <Error class: unknown class><Number, UNIT>?

CSS font size of the current component.

fontStyle

open var fontStyle: FontStyle?

CSS font style of the current component.

fontVariant

open var fontVariant: FontVariant?

CSS font variant of the current component.

fontWeight

open var fontWeight: FontWeight?

CSS font weight of the current component.

gridArea

open var gridArea: String?

CSS grid area.

gridAutoColumns

open var gridAutoColumns: String?

CSS grid auto columns.

gridAutoFlow

open var gridAutoFlow: GridAutoFlow?

CSS grid auto flow.

gridAutoRows

open var gridAutoRows: String?

CSS grid auto rows.

gridColumnEnd

open var gridColumnEnd: String?

CSS grid column end.

gridColumnGap

open var gridColumnGap: Int?

CSS grid column gap.

gridColumnStart

open var gridColumnStart: Int?

CSS grid column start.

gridRowEnd

open var gridRowEnd: String?

CSS grid row end.

gridRowGap

open var gridRowGap: Int?

CSS grid row gap.

gridRowStart

open var gridRowStart: Int?

CSS grid row start.

gridTemplateAreas

open var gridTemplateAreas: List<String>?

CSS grid areas template.

gridTemplateColumns

open var gridTemplateColumns: String?

CSS grid columns template.

gridTemplateRows

open var gridTemplateRows: String?

CSS grid rows template.

height

open var height: <Error class: unknown class><Number, UNIT>?

Height of the current component.

justifyContent

open var justifyContent: JustifyContent?

CSS flexbox/grid content justification.

justifyItems

open var justifyItems: JustifyItems?

CSS grid items justification.

justifySelf

open var justifySelf: JustifyItems?

CSS grid items self-justification.

left

open var left: <Error class: unknown class><Number, UNIT>?

Left edge of the current component.

letterSpacing

open var letterSpacing: <Error class: unknown class><Number, UNIT>?

CSS Text letter spacing of the current component.

lineBreak

open var lineBreak: LineBreak?

CSS line break of the current component.

lineHeight

open var lineHeight: <Error class: unknown class><Number, UNIT>?

CSS Text line height of the current component.

listStyle

open var listStyle: ListStyle?

List style of the current component.

margin

open var margin: <Error class: unknown class><Number, UNIT>?

Margin of the current component.

marginBottom

open var marginBottom: <Error class: unknown class><Number, UNIT>?

Bottom margin of the current component.

marginLeft

open var marginLeft: <Error class: unknown class><Number, UNIT>?

Left margin of the current component.

marginRight

open var marginRight: <Error class: unknown class><Number, UNIT>?

Right margin of the current component.

marginTop

open var marginTop: <Error class: unknown class><Number, UNIT>?

Top margin of the current component.

maxHeight

open var maxHeight: <Error class: unknown class><Number, UNIT>?

Maximal height of the current component.

maxWidth

open var maxWidth: <Error class: unknown class><Number, UNIT>?

Maximal width of the current component.

mediaQuery

var mediaQuery: String?

The CSS media query.

minHeight

open var minHeight: <Error class: unknown class><Number, UNIT>?

Minimal height of the current component.

minWidth

open var minWidth: <Error class: unknown class><Number, UNIT>?

Minimal width of the current component.

opacity

open var opacity: Double?

Opacity of the current component.

order

open var order: Int?

CSS flexbox item order.

outline

open var outline: Outline?

Outline of the current component.

overflow

open var overflow: Overflow?

CSS overflow of the current component.

overflowWrap

open var overflowWrap: OverflowWrap?

CSS overflow-wrap of the current component.

overflowX

open var overflowX: Overflow?

CSS overflow-x of the current component.

overflowY

open var overflowY: Overflow?

CSS overflow-y of the current component.

padding

open var padding: <Error class: unknown class><Number, UNIT>?

Padding of the current component.

paddingBottom

open var paddingBottom: <Error class: unknown class><Number, UNIT>?

Bottom padding of the current component.

paddingLeft

open var paddingLeft: <Error class: unknown class><Number, UNIT>?

Left padding of the current component.

paddingRight

open var paddingRight: <Error class: unknown class><Number, UNIT>?

Right padding of the current component.

paddingTop

open var paddingTop: <Error class: unknown class><Number, UNIT>?

Top padding of the current component.

parentStyle

val parentStyle: Style? = null

pClass

var pClass: PClass?

The CSS pseudo class.

pElement

var pElement: PElement?

The CSS pseudo element.

position

open var position: Position?

CSS position of the current component.

resize

open var resize: Resize?

CSS resize of the current component.

right

open var right: <Error class: unknown class><Number, UNIT>?

Right edge of the current component.

selector

val selector: String

The name of the CSS selector.

textAlign

open var textAlign: TextAlign?

CSS Text align of the current component.

textDecoration

open var textDecoration: TextDecoration?

CSS Text decoration of the current component.

textDirection

open var textDirection: Direction?

CSS Text direction of the current component.

textIndent

open var textIndent: <Error class: unknown class><Number, UNIT>?

CSS Text indent of the current component.

textOverflow

open var textOverflow: TextOverflow?

CSS Text overflow of the current component.

textShadow

open var textShadow: TextShadow?

CSS Text shadow of the current component.

textTransform

open var textTransform: TextTransform?

CSS Text transform of the current component.

top

open var top: <Error class: unknown class><Number, UNIT>?

Top edge of the current component.

transition

open var transition: Transition?

CSS transition effect for the current component.

transitionList

open var transitionList: List<Transition>?

List of CSS transition effects for the current component.

unicodeBidi

open var unicodeBidi: UnicodeBidi?

CSS Text unicode-bidi of the current component.

verticalAlign

open var verticalAlign: VerticalAlign?

CSS Text vertical align of the current component.

whiteSpace

open var whiteSpace: WhiteSpace?

CSS Text white space of the current component.

width

open var width: <Error class: unknown class><Number, UNIT>?

Width of the current component.

wordBreak

open var wordBreak: WordBreak?

CSS word break of the current component.

wordSpacing

open var wordSpacing: <Error class: unknown class><Number, UNIT>?

CSS Text word spacing of the current component.

zIndex

open var zIndex: Int?

Z-index of the current component.

Functions

getSnStyle

open fun getSnStyle(): dynamic

Returns CSS style attributes.

getStyle

fun getStyle(name: String): String?

Returns the value of a custom CSS style.

inheritingStyle

fun Style.inheritingStyle(selector: String? = null, pClass: PClass? = null, pElement: PElement? = null, mediaQuery: String? = null, init: InheritingStyle.() -> Unit? = null): Style

DSL builder extension function for cascading styles.

removeStyle

fun removeStyle(name: String)

Removes the value of a custom CSS style.

setStyle

fun setStyle(name: String, value: String)

Sets the value of a custom CSS style.

style

fun Style.style(selector: String? = null, pClass: PClass? = null, pElement: PElement? = null, mediaQuery: String? = null, init: Style.() -> Unit? = null): Style

DSL builder extension function for cascading styles.