core/com.orange.ouds.core.component

Package-level declarations

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

Types

Link copied to clipboard
object OudsBadge

Contains classes to build an OudsBadge.

Link copied to clipboard
object OudsBadgeDefaults

Default values for OudsBadge.

Link copied to clipboard
object OudsButton

Contains classes to build an OudsButton.

Link copied to clipboard
object OudsButtonDefaults

Default values for OudsButton.

Link copied to clipboard
object OudsChip

Contains classes to build an OudsFilterChip or an OudsSuggestionChip.

Link copied to clipboard
object OudsColoredBox

Contains classes to build an OudsColoredBox.

Link copied to clipboard
object OudsControlItem

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

Link copied to clipboard
object OudsDivider

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
object OudsLinkDefaults

Contains the default values used by OUDS links.

Link copied to clipboard
object OudsTag

Contains classes to build an OudsTag.

Link copied to clipboard
object OudsTagDefaults

Default values for OudsTag.

Functions

Link copied to clipboard
@Composable
fun OudsBadge(modifier: Modifier = Modifier, status: OudsBadge.Status = OudsBadgeDefaults.Status, size: OudsBadge.Size = OudsBadgeDefaults.Size)
@Composable
fun OudsBadge(icon: OudsBadge.Icon, modifier: Modifier = Modifier, status: OudsBadge.Status = OudsBadgeDefaults.Status, size: OudsBadge.Size = OudsBadgeDefaults.Size)
@Composable
fun OudsBadge(count: Int, modifier: Modifier = Modifier, status: OudsBadge.Status = OudsBadgeDefaults.Status, size: OudsBadge.Size = OudsBadgeDefaults.Size)

The badge is a small UI element used to highlight status, notifications, or categorization within an interface. It is often displayed as a label or indicator with a distinct background color and text.

Link copied to clipboard
@Composable
fun OudsButton(icon: OudsButton.Icon, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, loader: OudsButton.Loader? = null, hierarchy: OudsButton.Hierarchy = OudsButtonDefaults.Hierarchy, interactionSource: MutableInteractionSource? = null)
@Composable
fun OudsButton(label: String, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, loader: OudsButton.Loader? = null, hierarchy: OudsButton.Hierarchy = OudsButtonDefaults.Hierarchy, interactionSource: MutableInteractionSource? = null)
@Composable
fun OudsButton(icon: OudsButton.Icon, label: String, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, loader: OudsButton.Loader? = null, hierarchy: OudsButton.Hierarchy = OudsButtonDefaults.Hierarchy, interactionSource: MutableInteractionSource? = null)

Buttons are interactive elements designed to trigger specific actions or events when tapped by a user.

Link copied to clipboard
@Composable
fun OudsCheckbox(checked: Boolean, onCheckedChange: (Boolean) -> Unit?, modifier: Modifier = Modifier, enabled: Boolean = true, error: Boolean = false, interactionSource: MutableInteractionSource? = null)

Checkboxes are input controls that allow users to select one or more options from a number of choices.

Link copied to clipboard
@Composable
fun OudsCheckboxItem(checked: Boolean, label: String, onCheckedChange: (Boolean) -> Unit?, modifier: Modifier = Modifier, helperText: String? = null, icon: OudsControlItem.Icon? = null, divider: Boolean = true, reversed: Boolean = false, enabled: Boolean = true, readOnly: Boolean = false, error: Boolean = false, interactionSource: MutableInteractionSource? = null)

Checkboxes are input controls that allow users to select one or more options from a number of choices.

Link copied to clipboard
@Composable
fun OudsColoredBox(color: OudsColoredBox.Color, modifier: Modifier = Modifier, contentAlignment: Alignment = Alignment.TopStart, propagateMinConstraints: Boolean = false, content: @Composable BoxScope.() -> Unit)

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

Link copied to clipboard
@Composable
fun OudsFilterChip(selected: Boolean, onClick: () -> Unit, icon: OudsChip.Icon, modifier: Modifier = Modifier, enabled: Boolean = true, interactionSource: MutableInteractionSource? = null)
@Composable
fun OudsFilterChip(selected: Boolean, onClick: () -> Unit, label: String, modifier: Modifier = Modifier, enabled: Boolean = true, interactionSource: MutableInteractionSource? = null)
@Composable
fun OudsFilterChip(selected: Boolean, onClick: () -> Unit, label: String, icon: OudsChip.Icon, modifier: Modifier = Modifier, enabled: Boolean = true, interactionSource: MutableInteractionSource? = null)

Chips help people enter information, make selections, filter content, or trigger actions. Chips can show multiple interactive elements together in the same area, such as a list of selectable movie times, or a series of email contacts.

Link copied to clipboard
@Composable
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
@Composable
fun OudsLink(label: String, onClick: () -> Unit, modifier: Modifier = Modifier, size: OudsLink.Size = OudsLinkDefaults.Size, enabled: Boolean = true)
@Composable
fun OudsLink(label: String, icon: OudsLink.Icon, onClick: () -> Unit, modifier: Modifier = Modifier, size: OudsLink.Size = OudsLinkDefaults.Size, enabled: Boolean = true)

Links are interactive elements that allow users to navigate to a new screen, website, or a specific section within the current screen.

@Composable
fun OudsLink(label: String, arrow: OudsLink.Arrow, onClick: () -> Unit, modifier: Modifier = Modifier, size: OudsLink.Size = OudsLinkDefaults.Size, enabled: Boolean = true)

An OUDS link which displays an arrow before (OudsLink.Arrow.Back) or after (OudsLink.Arrow.Next) a label.

Link copied to clipboard
@Composable
fun OudsRadioButton(selected: Boolean, onClick: () -> Unit?, modifier: Modifier = Modifier, enabled: Boolean = true, error: Boolean = false, interactionSource: MutableInteractionSource? = null)

Radio buttons are input controls that allow users to select a single option from a set of mutually exclusive choices.

Link copied to clipboard
@Composable
fun OudsRadioButtonItem(selected: Boolean, label: String, onClick: () -> Unit?, modifier: Modifier = Modifier, additionalLabel: String? = null, helperText: String? = null, icon: OudsControlItem.Icon? = null, divider: Boolean = true, outlined: Boolean = false, reversed: Boolean = false, enabled: Boolean = true, readOnly: Boolean = false, error: Boolean = false, interactionSource: MutableInteractionSource? = null)

Radio buttons are input controls that allow users to select a single option from a set of mutually exclusive choices.

Link copied to clipboard
@Composable
fun OudsSuggestionChip(onClick: () -> Unit, icon: OudsChip.Icon, modifier: Modifier = Modifier, enabled: Boolean = true, interactionSource: MutableInteractionSource? = null)
@Composable
fun OudsSuggestionChip(onClick: () -> Unit, label: String, modifier: Modifier = Modifier, enabled: Boolean = true, interactionSource: MutableInteractionSource? = null)
@Composable
fun OudsSuggestionChip(onClick: () -> Unit, label: String, icon: OudsChip.Icon, modifier: Modifier = Modifier, enabled: Boolean = true, interactionSource: MutableInteractionSource? = null)

Chips help people enter information, make selections, filter content, or trigger actions. Chips can show multiple interactive elements together in the same area, such as a list of selectable movie times, or a series of email contacts.

Link copied to clipboard
@Composable
fun OudsSwitch(checked: Boolean, onCheckedChange: (Boolean) -> Unit?, modifier: Modifier = Modifier, enabled: Boolean = true, 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
@Composable
fun OudsSwitchItem(checked: Boolean, label: String, onCheckedChange: (Boolean) -> Unit?, modifier: Modifier = Modifier, helperText: String? = null, icon: OudsControlItem.Icon? = null, divider: Boolean = true, 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
@Composable
fun OudsTag(label: String, modifier: Modifier = Modifier, icon: OudsTag.Icon? = null, hierarchy: OudsTag.Hierarchy = OudsTagDefaults.Hierarchy, status: OudsTag.Status = OudsTagDefaults.Status, shape: OudsTag.Shape = OudsTagDefaults.Shape, size: OudsTag.Size = OudsTagDefaults.Size, loader: OudsTag.Loader? = null)

A tag is a small element that shows short info like a label, keyword, or category. It helps users quickly find, group, or understand content.

Link copied to clipboard
@Composable
fun OudsTriStateCheckbox(state: ToggleableState, onClick: () -> Unit?, modifier: Modifier = Modifier, enabled: Boolean = true, error: Boolean = false, interactionSource: MutableInteractionSource? = null)

Checkboxes are input controls that allow users to select one or more options from a number of choices.

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

Checkboxes are input controls that allow users to select one or more options from a number of choices.

Link copied to clipboard
@Composable
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.