Skip to content

MIGRATION_GUIDE.md

Latest commit

 

History

History
105 lines (73 loc) · 3.79 KB

MIGRATION_GUIDE.md

File metadata and controls

105 lines (73 loc) · 3.79 KB
Raw

Migration Guide

This guide helps you migrate between major versions of OUDS Android.

Migrating to 2.0.0

Breaking changes

Space inset token reorganization

The space inset token scale has been reorganized to align with the latest Orange Unified Design System specifications. A new larger small token has been introduced, and all smaller tokens have shifted down by one size level.

Impact: Applications using OudsTheme.spaces.inset.* properties will experience visual spacing changes unless code is updated.

Property name changes
Old property (v1.x) New property (v2.0) Action required
small extraSmall Replace small with extraSmall
extraSmall twoExtraSmall Replace extraSmall with twoExtraSmall
twoExtraSmall threeExtraSmall Replace twoExtraSmall with threeExtraSmall
threeExtraSmall fourExtraSmall Replace threeExtraSmall with fourExtraSmall
fourExtraSmall fiveExtraSmall Replace fourExtraSmall with fiveExtraSmall
N/A small New larger size available

Note: Actual spacing values depend on your theme (Orange, Sosh, etc.). The table above shows the property name mappings to maintain equivalent semantic sizes across the update.

Code examples

Before (v1.x):

Modifier.padding(OudsTheme.spaces.inset.small)

After (v2.0):

// To maintain the same semantic size:
Modifier.padding(OudsTheme.spaces.inset.extraSmall)

// Or use the new larger small size:
Modifier.padding(OudsTheme.spaces.inset.small)
Migration steps
  1. Search your codebase for usage of OudsTheme.spaces.inset.* properties
  2. Review each usage to determine the intended spacing value
  3. Update property names according to the table above to maintain current spacing values
  4. Test visually to ensure layouts appear as expected
  5. Consider using the new small where a slightly larger spacing would improve your design

Link component: paddingBlock structure change

The OudsComponents.Link.Space.paddingBlock property has changed from a single Dp value to a structured object.

Before (v1.x):

val padding = OudsTheme.components.link.space.paddingBlock // Dp

After (v2.0):

// paddingBlock is now a data class with multiple properties:
val padding = OudsTheme.components.link.space.paddingBlock.default // Dp
// Available properties: default, small, compactDensityDefault, compactDensitySmall
Migration steps
  1. Find usages of OudsTheme.components.link.space.paddingBlock
  2. Choose the appropriate property based on your use case
  3. Update references to access the specific property

Progress indicator: default status changed to Neutral

The default status parameter for OudsCircularProgressIndicator and OudsLinearProgressIndicator has been changed from Accent to Neutral.

Impact: Progress indicators without an explicit status parameter will now display using neutral colors instead of accent colors.

Before (v1.x):

OudsLinearProgressIndicator() // Uses Accent status

After (v2.0):

// Now uses Neutral status by default
OudsLinearProgressIndicator()

// To maintain v1.x appearance:
OudsLinearProgressIndicator(status = OudsProgressIndicatorStatus.Accent)
Migration steps
  1. Review all progress indicator usages in your codebase
  2. For brand-related operations, explicitly set status = OudsProgressIndicatorStatus.Accent
  3. Test visually to ensure progress indicators match your intended design

Version history

  • 2.0.0 - Space inset token reorganization, Link paddingBlock structure change, Progress indicator default status change
  • 1.x.x - Previous stable releases