ListBox
Wrapped Material DropdownMenu with Skapa features, used to display select options
Note: for group header use the constructor that use ListBoxItemsParams
Parameters
Whether the ListBox is currently open and visible to the user
list of items to be drawn as options.
Composable function of how each item is going to be drawn.
Called when the user requests to dismiss the ListBox, such as by tapping outside the ListBox's bounds
Modifier to be applied to the ListBox.
the padding applied to the content of this ListBox
set this to false to opt-out from the vertical WindowInsets.
option callback that is triggered when on option es selected. Selected object comes as a parameter of the callback. Provide null in case the item should not be clickable or you want to handle the click with itemContent composable
Type Parameters
The type of items in the list.
See also
Samples
net.ikea.skapa.ui.samples.ListBoxSampleWrapped Material DropdownMenu with Skapa features, used to display select options
Parameters
Whether the ListBox is currently open and visible to the user
ListBoxItemsParams is group of parameters represents a list of items that Implement ListBoxItemHeader interface and is used to separate the items by headers
Called when the user requests to dismiss the ListBox, such as by tapping outside the ListBox's bounds
Modifier to be applied to the ListBox.
set this to false to opt-out from the vertical WindowInsets.
Type Parameters
The type of items in the list that implement ListBoxItemHeader.
Samples
var expanded by remember { mutableStateOf(false) }
var itemsSelected by remember { mutableStateOf(false) }
var selectValue by remember { mutableStateOf(ListBoxSample.triggerHint) }
SkapaTheme2(isSystemInDarkTheme()) {
Box {
Pill(
label = selectValue,
selected = itemsSelected,
leadingItem = null,
trailingIconId = null,
badgeValue = null
) {
expanded = true
}
ListBox(
expanded = expanded,
itemParams = ListBoxItemsParams(
items = ListBoxSample.headerList,
itemContent = {
ListViewItem(
title = it.label,
trailingControl = ListViewItemControls.RadioButton(it.label == selectValue),
textStyle = ListViewItemTextStyle.Regular,
onClick = null,
size = ListViewItemSize.Small
)
},
onItemClick = {
selectValue = it.label
expanded = false
itemsSelected = true
}
),
onDismissRequest = {
expanded = false
},
modifier = Modifier.width(ListBoxSample.maxListWidth)
)
}
}