search

alphagov / govuk-frontend

GOV.UK Frontend contains the code you need to start building a user interface for government platforms and services.
https://frontend.design-system.service.gov.uk/
MIT License
1.18k stars 325 forks source link

Error summary component does not follow BEM conventions #1732

Open 36degrees opened 4 years ago

36degrees commented 4 years ago

The error summary component breaks the conventions we follow elsewhere.

It targets p elements within .govuk-error-summary__body:

https://github.com/alphagov/govuk-frontend/blob/6455d638d828874e6bef6ee020a257ec7370b43e/src/govuk/components/error-summary/_error-summary.scss#L28-L35

And it targets a elements within the wider .govuk-error-summary__list:

https://github.com/alphagov/govuk-frontend/blob/6455d638d828874e6bef6ee020a257ec7370b43e/src/govuk/components/error-summary/_error-summary.scss#L43-L57

Ideally the paragraph and the links would have their own classes which we would then target to apply styles.

Given this would be a breaking change, this may not be worth fixing at this point, but raising this for discussion and for consideration if we make wider changes to the component in the future.

Done when

Details of breaking change

NickColley commented 4 years ago

We do break out of BEM in a few components, commonly to remove margins on the bottom of :last-child children.

36degrees commented 4 years ago

Potentially one to look at alongside https://github.com/alphagov/govuk-design-system/issues/1137.

vanitabarrett commented 3 years ago

As discussed while prioritising v4.0.0 cards, this is a 'nice to have'. It would be good to tidy this up, but it doesn't seem to be causing issues for people at the moment and we'll potentially be asking users (who might already have a lot of release notes to look through) to make changes for something they're not aware of.

Let's wait and see how the release notes go.