SuperArrow

SuperArrow is a directional indicator component in Miuix, typically used for navigation or displaying additional content. It provides a title, summary, and right arrow icon with click interaction support, commonly used in settings, menu items, or list items.

Import

import top.yukonga.miuix.kmp.extra.SuperArrow

Basic Usage

The SuperArrow component provides basic click navigation functionality:

SuperArrow(
    title = "Setting Item",
    onClick = { /* Handle click event */ }
)

Arrow with Summary

SuperArrow(
    title = "Wireless Network",
    summary = "Connected to WIFI-HOME",
    onClick = { /* Handle click event */ }
)

Component States

Disabled State

SuperArrow(
    title = "Disabled Item",
    summary = "This item is currently unavailable",
    enabled = false,
    onClick = { /* Won't be triggered */ }
)

Hold Down State

SuperArrow supports controlling the hold-down state through the holdDownState parameter, typically used for visual feedback when displaying popup dialogs:

val showDialog = remember { mutableStateOf(false) }

Scaffold {
    SuperArrow(
        title = "Open Dialog",
        summary = "Click to show dialog",
        onClick = { showDialog.value = true },
        holdDownState = showDialog.value
    )
    // Define dialog elsewhere
    SuperDialog(
        title = "Dialog",
        show = showDialog,
        onDismissRequest = { showDialog.value = false }
    ) {
        // Dialog content
    }
}

Properties

SuperArrow Properties

Property Name	Type	Description	Default Value	Required
title	String	Arrow item title	-	Yes
titleColor	BasicComponentColors	Title text color configuration	BasicComponentDefaults.titleColor()	No
summary	String?	Arrow item summary description	null	No
summaryColor	BasicComponentColors	Summary text color configuration	BasicComponentDefaults.summaryColor()	No
leftAction	@Composable (() -> Unit)?	Custom left content	null	No
rightText	String?	Right text content	null	No
rightActionColor	RightActionColors	Right text and arrow color config	SuperArrowDefaults.rightActionColors()	No
modifier	Modifier	Modifier applied to component	Modifier	No
insideMargin	PaddingValues	Internal content padding	BasicComponentDefaults.InsideMargin	No
onClick	(() -> Unit)?	Callback triggered on click	null	No
holdDownState	Boolean	Whether component is held down	false	No
enabled	Boolean	Whether component is interactive	true	No

SuperArrowDefaults Object

The SuperArrowDefaults object provides default values and color configurations for the arrow component.

Methods

Method Name	Type	Description
rightActionColors	RightActionColors	Creates color config for right text and arrow

RightActionColors Class

Parameter	Type	Description
color	Color	Color in normal state
disabledColor	Color	Color in disabled state

Advanced Usage

With Left Icon

SuperArrow(
    title = "Personal Information",
    summary = "View and edit your profile",
    leftAction = {
        Icon(
            imageVector = MiuixIcons.Useful.Personal,
            contentDescription = "Personal Icon",
            tint = MiuixTheme.colorScheme.onBackground,
            modifier = Modifier.padding(end = 16.dp)
        )
    },
    onClick = { /* Handle click event */ }
)

With Right Text

SuperArrow(
    title = "Storage Space",
    summary = "Manage app storage space",
    rightText = "12.5 GB",
    onClick = { /* Handle click event */ }
)

Using with Dialog

val showDialog = remember { mutableStateOf(false) }
var language by remember { mutableStateOf("Simplified Chinese") }

Scaffold {
    SuperArrow(
        title = "Language Settings",
        summary = "Select app display language",
        rightText = language,
        onClick = { showDialog.value = true },
        holdDownState = showDialog.value
    )
    SuperDialog(
        title = "Select Language",
        show = showDialog,
        onDismissRequest = { showDialog.value = false }
    ) {
        // Dialog content
        Card {
            SuperArrow(
                title = "Simplified Chinese",
                onClick = {
                    language = "Simplified Chinese"
                    showDialog.value = false
                }
            )
            SuperArrow(
                title = "English",
                onClick = {
                    language = "English"
                    showDialog.value = false
                }
            )
        }
        Row(
            horizontalArrangement = Arrangement.SpaceBetween
        ) {
            TextButton(
                text = "Cancel",
                onClick = { showDialog.value = false },
                modifier = Modifier.weight(1f).padding(top = 8.dp)
            )
        }
    }
}

Custom Colors

SuperArrow(
    title = "Custom Colors",
    titleColor = BasicComponentDefaults.titleColor(
        color = MiuixTheme.colorScheme.primary
    ),
    summary = "Using custom colors",
    summaryColor = BasicComponentDefaults.summaryColor(
        color = MiuixTheme.colorScheme.secondary
    ),
    rightActionColor = RightActionColors(
        color = MiuixTheme.colorScheme.primary,
        disabledColor = MiuixTheme.colorScheme.disabledOnSecondaryVariant
    ),
    onClick = { /* Handle click event */ }
)