Less use of utility methods depending to color scheme for colors and elevations

[pylapp]

Context

The OUDS core maintainers team got some remarks from potentiel users who looked inside the library (@fsuc at least).
One of the remark is about the use of some methods depending to color scheme.

Samples

For example for colors uses:

// To know if the device is in light mode or dark mode
@Environment(\.colorScheme) private var colorScheme

// The current theme
@Environment(\.theme) private var theme

// Define a background
content.background(theme.colors.colorSurfaceStatusNeutralMuted.color(for: colorScheme))

// Define a foreground style
someView.foregroundStyle(theme.colors.colorContentDefault.color(for: colorScheme))

// Define a foreground color
someView.foregroundColor(theme.colors.colorContentStatusInfo.color(for: colorScheme))

// Define an accent color
someView.accentColor(theme.colors.colorContentBrandPrimary.color(for: colorScheme))

But also for elevation uses:

// To know if the device is in light mode or dark mode
@Environment(\.colorScheme) private var colorScheme

// The current theme
@Environment(\.theme) private var theme

// Define a box shadow effect
someView.shadow(elevation: theme.elevations.elevationRaised.elevation(for: colorScheme))

Issue

The comments we got were about the use of color(for:) and elevation(for:) used after having got the suitable multiple tokens through the suitable providers through the theme. That's long and users may not want to use this method. We agree this use is a bit long even if Xcode has autocompletion.

Fix proposal

The core maintaners team plans to enrich the OUDS iOS API so as to void to use each time the color(for:) and elevation(for:) methods. These methods remain in the lib as still used and helpful in other cases.

Evolutions are the ones below, and should be merged with issue #146 (pull request #575)

For colors:

// Previously to know if the device is in light mode or dark mode
@Environment(\.colorScheme) private var colorScheme
// Not needed now

// The current theme
@Environment(\.theme) private var theme

// Define a background
// Previously:
content.background(theme.colors.colorSurfaceStatusNeutralMuted.color(for: colorScheme))
// Now:
content.oudsBackground(theme.colors.colorSurfaceStatusNeutralMuted)

// Define a foreground style
// Previously:
someView.foregroundStyle(theme.colors.colorContentDefault.color(for: colorScheme))
// Now:
someView.oudsForegroundStyle(theme.colors.colorContentDefault)

// Define a foreground color
// Previously:
someView.foregroundColor(theme.colors.colorContentStatusInfo.color(for: colorScheme))
// Now:
someView.oudsForegroundColor(theme.colors.colorContentStatusInfo)

// Define an accent color
// Previously:
someView.accentColor(theme.colors.colorContentBrandPrimary.color(for: colorScheme))
// Now:
someView.oudsAccentColor(theme.colors.colorContentBrandPrimary)

For elevations:

// Previously to know if the device is in light mode or dark mode
@Environment(\.colorScheme) private var colorScheme
// Not needed now

// The current theme
@Environment(\.theme) private var theme

// Define a box shadow effect
someView.oudsShadow(theme.elevations.elevationRaised)

[pylapp]

@fsuc Let us know if this type of evolution is more interesting from your point of view ;)

[fsuc]

Seems good to me 👍

[pylapp]

Delivered with version 0.13.0 (#606)