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(val width: OudsBorders.Width, val radius: OudsBorders.Radius, val style: OudsBorders.Style)

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

OudsBorderStyle

enum OudsBorderStyle : Enum<OudsBorderStyle>

Available border styles in OUDS.

OudsColorMode

data class OudsColorMode

The color mode associated with a colored background. This defines how content is displayed when it is layout on a colored background.

OudsColorScheme

data class OudsColorScheme(val action: OudsColorScheme.Action, val always: OudsColorScheme.Always, val background: OudsColorScheme.Background, val border: OudsColorScheme.Border, val content: OudsColorScheme.Content, val opacity: OudsColorScheme.Opacity, val overlay: OudsColorScheme.Overlay, repository: OudsColorScheme.Repository, val surface: OudsColorScheme.Surface, modes: OudsColorScheme.Modes)

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

OudsComponents

data class OudsComponents(val navigationBar: OudsComponents.NavigationBar)

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

OudsEffects

data class OudsEffects(val blurDrag: Int)

Holds the visual effects defined in the OUDS theme.

OudsElevations

data class OudsElevations(val none: Dp, val default: Dp, val drag: Dp, val emphasized: Dp, val raised: Dp, val sticky: Dp)

Holds the elevation values defined in the OUDS theme.

OudsGrids

data class OudsGrids(val minWidth: Dp, val maxWidth: Dp, val margin: Dp, val columnGap: Dp)

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

OudsOpacities

data class OudsOpacities(val disabled: Float, val invisible: Float, val weakest: Float, val weaker: Float, val weak: Float, val medium: Float, val strong: Float, val opaque: Float)

Holds the opacity values defined in the OUDS theme.

OudsSizes

data class OudsSizes(val icon: OudsSizes.Icon, val maxWidth: OudsSizes.MaxWidth, val minInteractiveArea: Dp)

Holds the size values defined in the OUDS theme.

OudsSpaces

data class OudsSpaces(val fixed: OudsSpaces.Fixed, val scaled: OudsSpaces.Scaled, val paddingInline: OudsSpaces.PaddingInline, val paddingBlock: OudsSpaces.PaddingBlock, val inset: OudsSpaces.Inset, val columnGap: OudsSpaces.ColumnGap, val rowGap: OudsSpaces.RowGap)

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(val display: OudsTypography.Display, val heading: OudsTypography.Heading, val body: OudsTypography.Body, val label: OudsTypography.Label)

Holds the typography styles defined in the OUDS theme.

Properties

materialDarkColorScheme

val OudsMaterialColorTokens.materialDarkColorScheme: ColorScheme

materialLightColorScheme

val OudsMaterialColorTokens.materialLightColorScheme: ColorScheme

takeUnlessHairline

val Dp.takeUnlessHairline: Dp?

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

value

@get:Composable

val OudsTypographyKeyToken.value: TextStyle

Converts an OUDS typography token to the local typography value provided by the theme. Note that the typography value returned varies depending on the window size.

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.

outerBorder

fun Modifier.outerBorder(width: Dp, color: Color, shape: Shape = RectangleShape, insetWidth: Dp = Dp.Unspecified, insetColor: Color = Color.Unspecified): Modifier

Modify element to add an outer border (drawn outside the element) with appearance specified with a width, a color and a shape.