OudsCheckboxItem
OUDS Checkbox design guidelines
An OUDS checkbox item is a layout containing an OudsCheckbox, an associated text and several other optional elements. It can be used in a list as a list item or as a single element to validate general conditions for example. By clicking on a checkbox item, the user changes the checked state of its checkbox.
If you want to use a standalone checkbox please use com.orange.ouds.core.component.OudsCheckbox.
If you need an indeterminate state for the item's checkbox, please use OudsTriStateCheckboxItem.
Parameters
Controls checked state of the item's checkbox.
The main text of the checkbox item.
Callback invoked on checkbox item click. If null, then this is passive and relies entirely on a higher-level component to control the checked state.
Modifier applied to the layout of the checkbox item.
Optional text displayed below the main text.
Optional icon displayed in the item. By default, it has a trailing position. If inverted is set to true, it is displayed as a leading element.
Controls the display of a divider at the bottom of the checkbox item.
When false, the checkbox has a leading position and the optional icon has a trailing position. It is inverted otherwise.
Controls the enabled state of the checkbox item. When false, the checkbox, the text and the optional icon are disabled, and the item will not be clickable.
Controls the read only state of the checkbox item. When true the item's checkbox is disabled but the text and the icon remain in enabled color. Note that if it is set to true and enabled is set to false, the checkbox item will be displayed in disabled state.
Controls the error state of the checkbox item.
Optional hoisted MutableInteractionSource for observing and emitting Interactions for the item's checkbox. Note that if null is provided, interactions will still happen internally.
Samples
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.ui.state.ToggleableState
import com.orange.ouds.core.component.OudsCheckboxItem
import com.orange.ouds.core.component.OudsTriStateCheckboxItem
fun main() {
//sampleStart
var checked by remember { mutableStateOf(false) }
OudsCheckboxItem(
checked = checked,
text = "Terms of use",
helperText = "By checking this box, I acknowledge having read the conditions of use.",
onCheckedChange = { value -> checked = value },
divider = false
)
//sampleEnd
}