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

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.

OudsTheme

object OudsTheme

Object that stores tokens values for the current 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:ReadOnlyComposable

@get:Composable

val OudsBorderKeyToken.Radius.value: Dp

Converts an OUDS border radius token to the local border radius value provided by the theme.

@get:ReadOnlyComposable

@get:Composable

val OudsBorderKeyToken.Style.value: OudsBorderStyle

Converts an OUDS border style token to the local OudsBorderStyle value provided by the theme.

@get:ReadOnlyComposable

@get:Composable

val OudsBorderKeyToken.Width.value: Dp

Converts an OUDS border width token to the local border width value provided by the theme.

@get:ReadOnlyComposable

@get:Composable

val OudsColorKeyToken.value: Color

Converts an OUDS color token to the local color value provided by the theme.

@get:ReadOnlyComposable

@get:Composable

val OudsEffectKeyToken.value: Int

Converts an OUDS effect token to the local effect value provided by the theme.

@get:ReadOnlyComposable

@get:Composable

val OudsElevationKeyToken.value: Dp

Converts an OUDS elevation token to the local elevation value provided by the theme.

@get:Composable

val OudsGridKeyToken.value: Dp

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

@get:ReadOnlyComposable

@get:Composable

val OudsOpacityKeyToken.value: Float

Converts an OUDS opacity token to the local opacity value provided by the theme.

@get:Composable

val OudsSizeKeyToken.value: Dp

@get:Composable

val OudsSpaceKeyToken.value: Dp

Converts an OUDS space token to the local space value provided by the theme.

@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

This function is equivalent to isSystemInDarkTheme except it takes the OUDS theme setting into account instead of the system one.

OudsTheme

@Composable

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

OudsTheme is the theme to apply to your screens in a Jetpack Compose application. Use it at the top of your application in replacement of the MaterialTheme. Cause OUDS supports multi-theme, you should pass the OUDS supported theme used by your application.

OudsThemeTweak

@Composable

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

Tweaks the current OUDS theme and displays given content according to the selected tweak.