Element

interface Element : Modifier(source)

A single element within a Modifier chain.

Inheritors

Functions

Link copied to clipboard
fun Modifier.accentColor(color: CSSColorValue): Modifier
Link copied to clipboard
fun Modifier.alignContent(alignContent: AlignContent): Modifier
Link copied to clipboard
fun Modifier.alignItems(alignItems: AlignItems): Modifier
Link copied to clipboard
fun Modifier.alignSelf(alignSelf: AlignSelf): Modifier
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Modifier.ariaHidden(value: Boolean = true): Modifier
Link copied to clipboard
fun Modifier.ariaInvalid(value: Boolean = true): Modifier
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Modifier.attr(attr: String, value: String): Modifier

A convenience method for defining a single attribute key/value pair.

Link copied to clipboard
fun Modifier.attrs(vararg attrValues: Pair<String, String>): Modifier

A convenience method for defining multiple, general attribute key/value pairs.

Link copied to clipboard
fun Modifier.attrsModifier(attrs: AttrsScope<*>.() -> Unit): Modifier
Link copied to clipboard
Link copied to clipboard

fun Modifier.background(color: CSSColorValue?, vararg backgrounds: Background.Repeatable): Modifier

Configure an element's background appearance.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Modifier.backgroundColor(color: CSSColorValue): Modifier
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Modifier.border(width: CSSLengthNumericValue? = null, style: LineStyle? = null, color: CSSColorValue? = null): Modifier
Link copied to clipboard
fun Modifier.borderBottom(width: CSSLengthNumericValue? = null, style: LineStyle? = null, color: CSSColorValue? = null): Modifier
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Modifier.borderLeft(width: CSSLengthNumericValue? = null, style: LineStyle? = null, color: CSSColorValue? = null): Modifier
Link copied to clipboard
fun Modifier.borderRight(width: CSSLengthNumericValue? = null, style: LineStyle? = null, color: CSSColorValue? = null): Modifier
Link copied to clipboard
fun Modifier.borderTop(width: CSSLengthNumericValue? = null, style: LineStyle? = null, color: CSSColorValue? = null): Modifier
Link copied to clipboard
Link copied to clipboard
fun Modifier.boxClasses(contentAlignment: Alignment = BoxDefaults.ContentAlignment): Modifier

Add classes that tell the browser to display this element as a column.

Link copied to clipboard
Link copied to clipboard

Creates a box-shadow property with a single shadow. The property accepts either the BoxShadow.None value, the default global keywords, which indicates no shadows, or a list of shadows, created by using BoxShadow.of, ordered front to back.

The box-shadow property attaches one or more drop shadows to the box. The property accepts either the BoxShadow.None value, which indicates no shadows, or a list of shadows, created by using BoxShadow.of, ordered front to back.

fun Modifier.boxShadow(offsetX: CSSLengthNumericValue = 0.px, offsetY: CSSLengthNumericValue = 0.px, blurRadius: CSSLengthNumericValue? = null, spreadRadius: CSSLengthNumericValue? = null, color: CSSColorValue? = null, inset: Boolean = false): Modifier

Creates a single shadowed box-shadow to the desired element.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Modifier.caretColor(color: CSSColorValue): Modifier
Link copied to clipboard
fun Modifier.classNames(vararg classes: String): Modifier
Link copied to clipboard
Link copied to clipboard
fun Modifier.color(color: CSSColorValue): Modifier
Link copied to clipboard
Link copied to clipboard
fun Modifier.columnClasses(verticalArrangement: Arrangement.Vertical = ColumnDefaults.VerticalArrangement, horizontalAlignment: Alignment.Horizontal = ColumnDefaults.HorizontalAlignment): Modifier

Add classes that tell the browser to display this element as a column.

Link copied to clipboard
fun Modifier.columnRule(width: CSSLengthNumericValue? = null, style: LineStyle? = null, color: CSSColorValue? = null): Modifier
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Modifier.dataAttr(name: String, value: String): Modifier

Define a single HTML data attribute.

Link copied to clipboard
fun Modifier.dataAttrs(vararg nameValues: Pair<String, String>): Modifier

Declare one or more HTML data attributes

Link copied to clipboard
fun Modifier.dir(dirType: DirType): Modifier
Link copied to clipboard
fun Modifier.disabled(value: Boolean = true): Modifier
Link copied to clipboard
fun Modifier.display(value: DisplayStyle): Modifier
Link copied to clipboard
fun Modifier.draggable(draggable: Draggable): Modifier
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Modifier.filter(vararg filters: CSSFilter): Modifier
Link copied to clipboard
Link copied to clipboard
fun Modifier.flexDirection(flexDirection: FlexDirection): Modifier
Link copied to clipboard
fun Modifier.flexFlow(flexDirection: FlexDirection, flexWrap: FlexWrap): Modifier
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Modifier.flexWrap(flexWrap: FlexWrap): Modifier
Link copied to clipboard
Link copied to clipboard
open override fun <R> fold(initial: R, operation: (R, Modifier.Element) -> R): R

Run through all elements from left to right and apply operation on each one in order.

Link copied to clipboard
fun Modifier.font(scope: FontScope.() -> Unit): Modifier
Link copied to clipboard
fun Modifier.fontFamily(vararg values: String): Modifier
Link copied to clipboard
Link copied to clipboard
fun Modifier.fontVariant(alternates: FontVariantAlternates? = null, caps: FontVariantCaps? = null, eastAsian: FontVariantEastAsian? = null, emoji: FontVariantEmoji? = null, ligatures: FontVariantLigatures? = null, numeric: FontVariantNumeric? = null, position: FontVariantPosition? = null): Modifier
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Modifier.gridArea(rowStart: String, columnStart: String): Modifier
fun Modifier.gridArea(rowStart: String, columnStart: String, rowEnd: String): Modifier
fun Modifier.gridArea(rowStart: String, columnStart: String, rowEnd: String, columnEnd: String): Modifier
Link copied to clipboard
fun Modifier.gridAutoFlow(value: GridAutoFlow): Modifier
Link copied to clipboard
Link copied to clipboard
fun Modifier.gridColumn(start: Int, end: Int = start + 1): Modifier
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Modifier.gridItem(row: Int, column: Int, width: Int? = null, height: Int? = null): Modifier

A convenience modifier for specifying both row and column indices at the same time.

Link copied to clipboard
fun Modifier.gridRow(start: Int, end: Int = start + 1): Modifier
fun Modifier.gridRow(start: Int, end: String): Modifier
fun Modifier.gridRow(start: String, end: Int): Modifier
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Modifier.id(value: String): Modifier
Link copied to clipboard
Link copied to clipboard
fun Modifier.justifyContent(justifyContent: JustifyContent): Modifier
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Modifier.listStyle(type: ListStyleType? = null, position: ListStylePosition? = null, image: ListStyleImage? = null): Modifier
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Modifier.onAnimationEnd(listener: (SyntheticAnimationEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onAnimationIteration(listener: (SyntheticAnimationEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onAnimationStart(listener: (SyntheticAnimationEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onBlur(listener: (SyntheticFocusEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onClick(listener: (SyntheticMouseEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onContextMenu(listener: (SyntheticMouseEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onCopy(listener: (SyntheticClipboardEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onCut(listener: (SyntheticClipboardEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onDoubleClick(listener: (SyntheticMouseEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onDrag(listener: (SyntheticDragEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onDragEnd(listener: (SyntheticDragEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onDragEnter(listener: (SyntheticDragEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onDragLeave(listener: (SyntheticDragEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onDragOver(listener: (SyntheticDragEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onDragStart(listener: (SyntheticDragEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onDrop(listener: (SyntheticDragEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onFocus(listener: (SyntheticFocusEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onFocusIn(listener: (SyntheticFocusEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onFocusOut(listener: (SyntheticFocusEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onKeyDown(listener: (SyntheticKeyboardEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onKeyUp(listener: (SyntheticKeyboardEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onMouseDown(listener: (SyntheticMouseEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onMouseEnter(listener: (SyntheticMouseEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onMouseLeave(listener: (SyntheticMouseEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onMouseMove(listener: (SyntheticMouseEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onMouseOut(listener: (SyntheticMouseEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onMouseOver(listener: (SyntheticMouseEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onMouseUp(listener: (SyntheticMouseEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onPaste(listener: (SyntheticClipboardEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onScroll(listener: (SyntheticEvent<EventTarget>) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onTouchCancel(listener: (SyntheticTouchEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onTouchEnd(listener: (SyntheticTouchEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onTouchMove(listener: (SyntheticTouchEvent) -> Unit): Modifier
Link copied to clipboard
fun Modifier.onTouchStart(listener: (SyntheticTouchEvent) -> Unit): Modifier
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Modifier.onWheel(listener: (SyntheticMouseEvent) -> Unit): Modifier
Link copied to clipboard
Link copied to clipboard
fun Modifier.order(value: Int): Modifier
Link copied to clipboard
fun Modifier.outline(width: CSSLengthNumericValue? = null, style: LineStyle? = null, color: CSSColorValue? = null): Modifier
Link copied to clipboard
fun Modifier.outlineColor(value: CSSColorValue): Modifier
Link copied to clipboard
Link copied to clipboard
fun Modifier.outlineStyle(value: LineStyle): Modifier
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Modifier.placeContent(alignContent: AlignContent, justifyContent: JustifyContent): Modifier
Link copied to clipboard
fun Modifier.placeItems(alignItems: AlignItems, justifyItems: JustifyItems): Modifier
Link copied to clipboard
fun Modifier.placeSelf(alignSelf: AlignSelf, justifySelf: JustifySelf): Modifier
Link copied to clipboard
Link copied to clipboard
fun Modifier.position(position: Position): Modifier
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Modifier.rotate(a: CSSAngleValue): Modifier
fun Modifier.rotate(x: Number, y: Number, z: Number, a: CSSAngleValue): Modifier
Link copied to clipboard
fun Modifier.rotateX(ax: CSSAngleValue): Modifier
Link copied to clipboard
fun Modifier.rotateY(ay: CSSAngleValue): Modifier
Link copied to clipboard
fun Modifier.rotateZ(az: CSSAngleValue): Modifier
Link copied to clipboard
fun Modifier.rowClasses(horizontalArrangement: Arrangement.Horizontal = RowDefaults.HorizontalArrangement, verticalAlignment: Alignment.Vertical = RowDefaults.VerticalAlignment): Modifier

Add classes that tell the browser to display this element as a row.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun <T : StylePropertyValue> Modifier.setVariable(variable: StyleVariable.PropertyValue<T>, value: T?): Modifier

Set the value of a variable.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Modifier.styleModifier(styles: StyleScope.() -> Unit): Modifier
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun Modifier.textShadow(vararg textShadows: CSSTextShadow): Modifier
fun Modifier.textShadow(offsetX: CSSLengthNumericValue, offsetY: CSSLengthNumericValue, blurRadius: CSSLengthNumericValue? = null, color: CSSColorValue? = null): Modifier
Link copied to clipboard
Link copied to clipboard
open infix fun then(other: Modifier): Modifier

Concatenates this modifier with another, returning a new modifier representing the chain.

Link copied to clipboard
fun Modifier.thenIf(condition: Boolean, other: Modifier): Modifier

Like then but the other modifier is only applied if the condition is true.

inline fun Modifier.thenIf(condition: Boolean, lazyProduce: () -> Modifier): Modifier

Like the version of thenIf which takes in a modifier directly, but it produces that modifier lazily.

Link copied to clipboard
inline fun <T> Modifier.thenIfNotNull(value: T?, consume: (T) -> Modifier): Modifier
Link copied to clipboard
fun Modifier.thenUnless(condition: Boolean, other: Modifier): Modifier

Like thenIf but with an inverted condition.

inline fun Modifier.thenUnless(condition: Boolean, lazyProduce: () -> Modifier): Modifier

Like the version of thenUnless which takes in a modifier directly, but it produces that modifier lazily.

Link copied to clipboard
Link copied to clipboard
fun <A : AttrsScope<Element>> Modifier.toAttrs(finalHandler: A.() -> Unit? = null): A.() -> Unit

Convert a Modifier into an AttrsScope which Compose HTML tags take as an argument, e.g. use it like so:

Link copied to clipboard
Link copied to clipboard
fun Modifier.toStyles(finalHandler: StyleScope.() -> Unit? = null): StyleScope.() -> Unit

Convert a Modifier into a StyleScope which can be used to initialize a StyleSheet, for example.

Link copied to clipboard
Link copied to clipboard
fun Modifier.transform(transformContext: TransformBuilder.() -> Unit): Modifier
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard