Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove display:block hint style as we're switching from span to div #1856

Closed
2 tasks done
Tracked by #2274
vanitabarrett opened this issue Jul 8, 2020 · 0 comments · Fixed by #2437
Closed
2 tasks done
Tracked by #2274

Remove display:block hint style as we're switching from span to div #1856

vanitabarrett opened this issue Jul 8, 2020 · 0 comments · Fixed by #2437
Assignees
Milestone

Comments

@vanitabarrett
Copy link
Contributor

vanitabarrett commented Jul 8, 2020

What

Remove display: block from the hint component styles - this is a breaking change.

Why

In #1855 we switched the hint component from having a wrapping span to having a wrapping div. This was to allow block-level HTML elements to be passed in and render as valid HTML. However, we left the display: block CSS on the wrapping element as otherwise this would be a breaking change that required users to update their HTML.

Further details

Related to #2083, but the outcome of that card shouldn't impact this work unless we decide to switch back to an inline element.

Who needs to know about this

Developers, Tech Writer

Done when

  • display: block has been removed from the hint component styles
  • "Details of breaking change" section below completed to help with writing release notes

Details of breaking change

  • which users are affected: users using the hint component HTML
  • the change that’s been made: (in 3.8.0) we switched the hint component to use div instead of span to allow block elements inside hints. We’re removing the styling which made the span behave like a block element
  • changes users will have to make: update the hint HTML to use a
    rather than a
  • impact of users not making those changes: their hints may not be styled correctly
@vanitabarrett vanitabarrett added this to the v4.0.0 milestone Jul 8, 2020
@EoinShaughnessy EoinShaughnessy changed the title Remove display:block hint style as we're switching from span to div Remove display:block hint style as we're switching from span to div Sep 14, 2021
@vanitabarrett vanitabarrett self-assigned this Nov 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging a pull request may close this issue.

1 participant