search

GovAlta / ui-components

ui-components contains the code you need to start building a user interface for Government of Alberta platforms and services.
Apache License 2.0
14 stars 24 forks source link

Breaking Changes #1780

Open ArakTaiRoth opened 4 months ago

ArakTaiRoth commented 4 months ago

Info

This story is intended to gather all breaking changes we potentially want to make to our components. This is to be used when we have to make a breaking change to one of our libraries, we can include more to make it more "worthwhile".

When adding a breaking change under one of our libraries, please include as much context as possible, as it could be many months before we ever even look at these, and memories suck.

Web Components

  1. Make the header property required for Modal component
    • Included in React components as well
  2. Make the arialabel property required for Badge component if content property isn't provided
    • This is also included under React components
  3. Remove prefix and suffix properties for Input component
    • This also needs to be included under React components
  4. Remove width property from Modal component
    • This also needs to be included under React components
  5. Remove nocolor variant type from Icon Button component (used by input and modal components)
    • This also needs to be included under React components
  6. Replace all "status" types "important" with "warning" to align to token naming convention
    • Applies to the following components:
      • Badge
      • Callout
      • Notification banner
  7. Remove the following deprecated properties for the "icon" component (currently used by dropdown component)
    • ariacontrols
    • ariaexpanded

Angular Components

React Components

  1. Remove the inclusion of web-components from the React library. This means teams would have to manually include the web-components library in their project.
twjeffery commented 4 months ago

Update to typography has been waiting on a breaking change. https://github.com/GovAlta/ui-components/issues/1410

This is an update to:

Design issue here: https://goa-dio.atlassian.net/browse/DDIDS-1399?atlOrigin=eyJpIjoiNDU4MDlhNTQwN2Y0NGMzZWIyMmNhYjc2MmQ3ODM3MTAiLCJwIjoiaiJ9

Design file here: https://www.figma.com/file/7xYbs6rAM4cwBdalPNE8lH/Text-combinations---spacing?type=design&node-id=0-1&mode=design