Skip to content

In library, rename the public methods prefixed by ouds #1346

@pylapp

Description

@pylapp

Context

We got some user feedbacks about the naming of our public API, specially the methods, prefixed by ouds.
Indeed, prefixing our components by OUDS (like OUDSButton) and public variable by ouds (like oudsHorizontalSizeClass) is done and helps to find which stuff is from the OUDS Swift Package.
We applied the same logic for the methods like oudsBackground.

However some users have the feeling the prefix of methods is boring and heavy.
For exemple, the oudsBackgroundColor method can be replaced by bckgroundColor()with a token as parameter.
With documentation and stronglty typed parameters, no ambiguity will remain.

Definition of Done

  • Add as many functions without ouds prefix as functions with ouds rpefix, make the older ones call the new ones, deprecated the older ones
  • Ad OUDSButtonStyleis not public, rename to StyleForButton
  • Update documentation
  • Update MIGRATION guide
  • Update CHANGELOG
  • Ensure the design toolbox is updated with code samples
  • Tests for all paltforms

Metadata

Metadata

Assignees

Labels

#️⃣ REX and feebacksAfterr discussions with returns of experiences and feedbacks from users🧑‍💻 Developer eXperienceRelated to improvements of developer experience thanks to feedbacks)🧰 library

Type

Projects

Status

In Progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions