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

fix: improve sd-headline a11y #1729

Open
wants to merge 12 commits into
base: next
Choose a base branch
from

Conversation

paulovareiro29
Copy link
Contributor

@paulovareiro29 paulovareiro29 commented Dec 12, 2024

Description:

Closes #1504

This PR addresses:

  • Default story headline changed to h2.
  • Rephrase sd-headline stories description to explain why semantics and styles are disconnected
  • Add a template to show real life examples from disconnected headlines

Definition of Reviewable:

  • Documentation is created/updated
  • Stories (features, a11y) are created/updated
  • relevant tickets are linked

Copy link

changeset-bot bot commented Dec 12, 2024

🦋 Changeset detected

Latest commit: a0bbdf0

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

github-actions bot commented Dec 12, 2024

🚀 Storybook has been deployed for branch fix_improve-sd-headline-a11y

@paulovareiro29 paulovareiro29 changed the base branch from main to next December 13, 2024 11:07
@smfonseca smfonseca changed the base branch from next to main December 13, 2024 14:22
@mariohamann mariohamann changed the base branch from main to next December 19, 2024 12:18
@paulovareiro29 paulovareiro29 marked this pull request as ready for review December 20, 2024 11:10
@MartaPintoTeixeira
Copy link
Contributor

Template feedback - Example A:
"Active and passive management ..." - should be an sd-leadtext
"We are a fundamentally active asset manager" - should be sd-headline/text-xl (we do not have 2xl. where does it come from?)

Other then these please check spacing between elements.

@MartaPintoTeixeira
Copy link
Contributor

Template feedback - Example B:

For the teasers there is no isent in figma. please remove it.
Other then these please check spacing between elements.

@MartaPintoTeixeira
Copy link
Contributor

Please align with @auroraVasconcelos to see if before this quote:
"Separating semantics from styles allows developers to use appropriate tags (e.g, h1 to h6 or p) for structure, ensuring consistent design, accessibility, and flexibility across use cases. H-tags are applied in the CMS following semantic headline order."

You need to put "Accessibility hint:"

@MartaPintoTeixeira
Copy link
Contributor

In docs:
for the 1st sample (the one after the component description" in figma we have "Lorem ipsum sic semper" please change it.
for the inverted sample in figma we have "Lorem ipsum sic semper" please change it.

@paulovareiro29
Copy link
Contributor Author

"We are a fundamentally active asset manager" - should be sd-headline/text-xl (we do not have 2xl. where does it come from?)

@MartaPintoTeixeira Using text-xl changes text to black, instead of the brand blue. In figma it is in blue. How should we handle it?
Should I force the blue color? Imo forcing goes against having a design system..

@coraliefeil coraliefeil removed their assignment Jan 7, 2025
@MartaPintoTeixeira
Copy link
Contributor

MartaPintoTeixeira commented Jan 8, 2025

Hi @paulovareiro29,

In that case I believe we need to create a new ticket to edit sd-headline style in a way that it allows the user to use primary or black. As you can read in figma in the "do's": "The text/primary colour can be used to emphasize the hierarchy between headlines." meaning the user should be able to use primary or black in all sizes. I will speak with @coraliefeil tomorrow about this so we create a ticket to handle the issue.

@mariohamann
Copy link
Contributor

Hi @paulovareiro29,

In that case I believe we need to create a new ticket to edit sd-headline style in a way that it allows the user to use primary or black. As you can read in figma in the "do's": "The text/primary colour can be used to emphasize the hierarchy between headlines." meaning the user should be able to use primary or black in all sizes. I will speak with @coraliefeil tomorrow about this so we create a ticket to handle the issue.

@MartaPintoTeixeira You're right, that it's written there. But to my knowledge, it's not correct. That's why we built the component in this way in Figma and Code. If this would interchangeable, we would need a property for that. Otherwise @paulovareiro29 you're right, it would have to be overridden manually.

@MartaPintoTeixeira
Copy link
Contributor

MartaPintoTeixeira commented Jan 10, 2025

@paulovareiro29 please force the xl to be blue as in figma.
please double check the template in figma and look for this changes:

  • spacing between elements
  • new title added: "Empowering Sustainable Growth"

Please mark with an emoji once you finish this requests.
So I can quickly follow up.

@paulovareiro29
Copy link
Contributor Author

@MartaPintoTeixeira spacings and new headline has been addressed.

There is just one topic to be addressed:
In the second template, in design between sections, there is a spacing of 86px. By default, we do not have 86px to apply as a spacing. What I have done was to apply 32px + 48px = 80px spacing.
Could you apply this difference in design?

mariohamann
mariohamann previously approved these changes Jan 13, 2025
@mariohamann mariohamann self-requested a review January 13, 2025 13:39
@mariohamann mariohamann dismissed their stale review January 13, 2025 13:39

For reasons

@mariohamann mariohamann removed their request for review January 13, 2025 13:40
@mariohamann mariohamann removed their assignment Jan 13, 2025
@mariohamann
Copy link
Contributor

mariohamann commented Jan 13, 2025

I hand reviewing over to @auroraVasconcelos

@MartaPintoTeixeira
Copy link
Contributor

@MartaPintoTeixeira spacings and new headline has been addressed.

There is just one topic to be addressed: In the second template, in design between sections, there is a spacing of 86px. By default, we do not have 86px to apply as a spacing. What I have done was to apply 32px + 48px = 80px spacing. Could you apply this difference in design?

Works for me @paulovareiro29 i will adjust figma to match storybook.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 👀 In review
Development

Successfully merging this pull request may close these issues.

feat[dev]: ✨ implement A11y improvements to sd-headline
7 participants