Skip to content

Divider

Divider is a basic layout component in Miuix used to separate content in lists and layouts. It provides both horizontal and vertical divider styles.

Import

kotlin
import top.yukonga.miuix.kmp.basic.HorizontalDivider // Horizontal divider
import top.yukonga.miuix.kmp.basic.VerticalDivider   // Vertical divider

Basic Usage

Horizontal Divider

Horizontal divider is used to separate vertically arranged content:

kotlin
Column {
    Text("Content Above")
    HorizontalDivider()
    Text("Content Below")
}

Vertical Divider

Vertical divider is used to separate horizontally arranged content:

kotlin
Row {
    Text("Left Content")
    VerticalDivider()
    Text("Right Content")
}

Properties

HorizontalDivider Properties

Property NameTypeDescriptionDefault ValueRequired
modifierModifierModifier applied to the dividerModifierNo
thicknessDpThickness of the dividerDividerDefaults.ThicknessNo
colorColorColor of the dividerDividerDefaults.DividerColorNo

VerticalDivider Properties

Property NameTypeDescriptionDefault ValueRequired
modifierModifierModifier applied to the dividerModifierNo
thicknessDpThickness of the dividerDividerDefaults.ThicknessNo
colorColorColor of the dividerDividerDefaults.DividerColorNo

DividerDefaults Object

The DividerDefaults object provides default values for the divider components.

Constants

Constant NameTypeDescriptionDefault Value
ThicknessDpDefault thickness of divider0.75.dp
DividerColorColorDefault color of dividerMiuixTheme.colorScheme.dividerLine

Advanced Usage

Custom Thickness Divider

kotlin
Column {
    Text("Content Above")
    HorizontalDivider(
        thickness = 2.dp
    )
    Text("Content Below")
}

Custom Color Divider

kotlin
Column {
    Text("Content Above")
    HorizontalDivider(
        color = Color.Red
    )
    Text("Content Below")
}

Divider with Padding

kotlin
Column {
    Text("Content Above")
    HorizontalDivider(
        modifier = Modifier.padding(horizontal = 16.dp)
    )
    Text("Content Below")
}

Using Vertical Divider Between Buttons

kotlin
Row(
    horizontalArrangement = Arrangement.SpaceBetween,
    verticalAlignment = Alignment.CenterVertically
) {
    Button(onClick = { /* Handle click event */ }) {
        Text("Cancel")
    }
    VerticalDivider(
        modifier = Modifier.height(24.dp)
    )
    Button(onClick = { /* Handle click event */ }) {
        Text("Confirm")
    }
}

Released under the Apache-2.0 License