core/com.orange.ouds.core.theme

Package-level declarations

Contains the OudsTheme composable that can be used in your app to apply a chosen theme. The other files are used to build the theme and don't have to be used directly but only through the OudsTheme.

Properties

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

Link copied to clipboard
@Composable
fun OudsTheme(themeContract: OudsThemeContract, darkThemeEnabled: Boolean = isSystemInDarkTheme(), content: @Composable () -> Unit)

OudsTheme is the theme to apply to your screens in an Jetpack Compose application. Use it at the top of your application in replacement of the MaterialTheme. Cause OUDS support multi-theme, you should pass a themeContract as theme configuration to use an OUDS supported theme.

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

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