Package-level declarations

Contains all OUDS basic components: OudsButton, OudsLink,...

Types

Link copied to clipboard
object OudsButton

Contains classes to build an OudsButton.

Link copied to clipboard

Default values for OudsButton.

Link copied to clipboard

Contains classes to build an OudsColoredBox.

Link copied to clipboard

Contains classes to build a control item: OudsCheckboxItem, OudsRadioButtonItem.

Link copied to clipboard

Contains classes to build an OudsHorizontalDivider or an OudsVerticalDivider.

Link copied to clipboard
object OudsLink

Contains classes to build an OudsLink.

Link copied to clipboard

Contains the default values used by OUDS links.

Functions

Link copied to clipboard
fun OudsButton(icon: OudsButton.Icon, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, style: OudsButton.Style = OudsButtonDefaults.Style, hierarchy: OudsButton.Hierarchy = OudsButtonDefaults.Hierarchy, interactionSource: MutableInteractionSource? = null)
fun OudsButton(label: String, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, style: OudsButton.Style = OudsButtonDefaults.Style, hierarchy: OudsButton.Hierarchy = OudsButtonDefaults.Hierarchy, interactionSource: MutableInteractionSource? = null)
fun OudsButton(icon: OudsButton.Icon, label: String, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, style: OudsButton.Style = OudsButtonDefaults.Style, hierarchy: OudsButton.Hierarchy = OudsButtonDefaults.Hierarchy, interactionSource: MutableInteractionSource? = null)
Link copied to clipboard
fun OudsCheckbox(checked: Boolean, onCheckedChange: (Boolean) -> Unit?, modifier: Modifier = Modifier, enabled: Boolean = true, error: Boolean = false, interactionSource: MutableInteractionSource? = null)
Link copied to clipboard
fun OudsCheckboxItem(checked: Boolean, label: String, onCheckedChange: (Boolean) -> Unit?, modifier: Modifier = Modifier, helperText: String? = null, icon: OudsControlItem.Icon? = null, divider: Boolean = false, reversed: Boolean = false, enabled: Boolean = true, readOnly: Boolean = false, error: Boolean = false, interactionSource: MutableInteractionSource? = null)
Link copied to clipboard
fun OudsColoredBox(color: OudsColoredBox.Color, modifier: Modifier = Modifier, contentAlignment: Alignment = Alignment.TopStart, propagateMinConstraints: Boolean = false, content: @Composable BoxScope.() -> Unit)

An OUDS colored box is a Box where content color is automatically adjusted to maximize the contrast with the chosen background color.

Link copied to clipboard
fun OudsHorizontalDivider(modifier: Modifier = Modifier, color: OudsDivider.Color = OudsDivider.Color.Default)

Dividers are used to visually structure an interface by clearly separating content sections. It helps to improve readability and content organization without introducing a strong hierarchy like a heading or a container would.

Link copied to clipboard
fun OudsLink(label: String, arrow: OudsLink.Arrow, onClick: () -> Unit, modifier: Modifier = Modifier, size: OudsLink.Size = OudsLinkDefaults.Size, enabled: Boolean = true)
fun OudsLink(label: String, icon: OudsLink.Icon?, onClick: () -> Unit, modifier: Modifier = Modifier, size: OudsLink.Size = OudsLinkDefaults.Size, enabled: Boolean = true)
Link copied to clipboard
fun OudsRadioButton(selected: Boolean, onClick: () -> Unit?, modifier: Modifier = Modifier, enabled: Boolean = true, error: Boolean = false, interactionSource: MutableInteractionSource? = null)
Link copied to clipboard
fun OudsRadioButtonItem(selected: Boolean, label: String, onClick: () -> Unit?, modifier: Modifier = Modifier, additionalLabel: String? = null, helperText: String? = null, icon: OudsControlItem.Icon? = null, divider: Boolean = false, outlined: Boolean = false, reversed: Boolean = false, enabled: Boolean = true, readOnly: Boolean = false, error: Boolean = false, interactionSource: MutableInteractionSource? = null)
Link copied to clipboard
fun OudsSwitch(checked: Boolean, onCheckedChange: (Boolean) -> Unit?, modifier: Modifier = Modifier, enabled: Boolean = true, interactionSource: MutableInteractionSource? = null)
Link copied to clipboard
fun OudsSwitchItem(checked: Boolean, label: String, onCheckedChange: (Boolean) -> Unit?, modifier: Modifier = Modifier, helperText: String? = null, icon: OudsControlItem.Icon? = null, divider: Boolean = false, reversed: Boolean = false, enabled: Boolean = true, readOnly: Boolean = false, error: Boolean = false, interactionSource: MutableInteractionSource? = null)

Switches allow the user to toggle between two states, typically "on" and "off". It is represented as a slider that changes its position or color to indicate the current state. Switches are used to enable or disable features, options, or settings in an intuitive and visual manner.

Link copied to clipboard
fun OudsTriStateCheckbox(state: ToggleableState, onClick: () -> Unit?, modifier: Modifier = Modifier, enabled: Boolean = true, error: Boolean = false, interactionSource: MutableInteractionSource? = null)
Link copied to clipboard
fun OudsTriStateCheckboxItem(state: ToggleableState, label: String, onClick: () -> Unit?, modifier: Modifier = Modifier, helperText: String? = null, icon: OudsControlItem.Icon? = null, divider: Boolean = false, reversed: Boolean = false, enabled: Boolean = true, readOnly: Boolean = false, error: Boolean = false, interactionSource: MutableInteractionSource? = null)
Link copied to clipboard
fun OudsVerticalDivider(modifier: Modifier = Modifier, color: OudsDivider.Color = OudsDivider.Color.Default)

Dividers are used to visually structure an interface by clearly separating content sections. It helps to improve readability and content organization without introducing a strong hierarchy like a heading or a container would.