core/com.orange.ouds.core.theme

Package-level declarations

This package contains the logic for the OudsTheme composable, including the OudsThemeTweak mechanism and the implementation of the theme contract that injects visual data into the application.

Types

OudsBorders

data class OudsBorders

Holds all the border-related properties defined in the OUDS theme.

OudsBorderStyle

enum OudsBorderStyle : Enum<OudsBorderStyle>

Available border styles in OUDS.

OudsColorScheme

data class OudsColorScheme

Holds all the colour-related properties defined in the OUDS theme.

OudsComponents

data class OudsComponents

Holds component-specific tokens that are exposed for public use.

OudsEffects

data class OudsEffects

Holds the visual effects defined in the OUDS theme.

OudsElevations

data class OudsElevations

Holds the elevation values defined in the OUDS theme.

OudsGrids

data class OudsGrids

Holds the grid-related properties defined in the OUDS theme.

OudsOpacities

data class OudsOpacities

Holds the opacity values defined in the OUDS theme.

OudsSizes

data class OudsSizes

Holds the size values defined in the OUDS theme.

OudsSpaces

data class OudsSpaces

Holds the spacing values defined in the OUDS theme.

OudsTheme

object OudsTheme

Object that stores tokens values for the current theme.

OudsTypography

data class OudsTypography

Holds the typography styles defined in the OUDS theme.

Properties

takeUnlessHairline

val Dp.takeUnlessHairline: Dp?

Returns this if it is not equal to Dp.Hairline, otherwise returns null.

Functions

dashedBorder

fun Modifier.dashedBorder(width: Dp, color: Color, shape: Shape = RectangleShape, intervals: List<Dp> = listOf(width * 2, width * 2), phase: Dp = 0.dp): Modifier

Modify element to add a dashed border styled with appearance specified with a width, a color and a shape, and clip it.

dottedBorder

fun Modifier.dottedBorder(width: Dp, color: Color, shape: Shape = RectangleShape): Modifier

Modify element to add a dotted border styled with appearance specified with a width, a color and a shape, and clip it.

isOudsInDarkTheme

@Composable

@ReadOnlyComposable

fun isOudsInDarkTheme(): Boolean

Determines if the OUDS theme is currently in dark mode.

OudsTheme

@Composable

fun OudsTheme(theme: OudsThemeContract, darkThemeEnabled: Boolean = isSystemInDarkTheme(), content: @Composable () -> Unit)

Applies the OUDS theme to the composable hierarchy.

OudsThemeTweak

@Composable

fun OudsThemeTweak(tweak: OudsTheme.Tweak, content: @Composable () -> Unit)

Modifies the current OUDS theme configuration and applies it to the given content.