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

[Visual Refresh] Update docs to reflect new tokens #8306

Merged

Conversation

mgadewoll
Copy link
Contributor

@mgadewoll mgadewoll commented Feb 4, 2025

Summary

Important

This PR merges into a feature branch.

Closes https://github.com/elastic/eui-private/issues/174

This PR updates the EUI and EUI+ docs to ensure the new and/or updated color tokens are reflected.

Changes

  • adds output and docs for additional new tokens (text tokens, background tokens, border tokens)
  • updates descriptions that mention computed color values, as Borealis is not generating colors anymore
  • removes docs for color utilities that are deprecated (not expected to be promoted anymore)
  • updates examples of color contrast to add additional color token options
  • [fix]: updates brand color values for DARK mode - aligning it with design (I'm not sure why this was wrong, it might have been wrongly updated in a rebase 🫠)
  • [cleanup]: updates (deprecated) token usages where new semantic tokens are available (e.g. dangerText -> textDanger or text -> textParagraph)

QA

  • review the EUI and EUI+ docs

@mgadewoll mgadewoll self-assigned this Feb 4, 2025
@mgadewoll mgadewoll marked this pull request as ready for review February 4, 2025 07:51
@mgadewoll mgadewoll requested a review from a team as a code owner February 4, 2025 07:51
@acstll acstll self-requested a review February 4, 2025 10:55
Copy link
Member

@tkajtoch tkajtoch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes are looking solid! 🚢

@acstll
Copy link
Contributor

acstll commented Feb 5, 2025

Thank you @mgadewoll! I only have 2 non-blocking comments regarding text:

  • the first paragraph in the Colors page has this statement (screenshot), I think it's no longer true, is it?
  • the Shades and Special colors are deprecated in the current site but not the new
  • extra: in the tokens table, I think it would be nice if the Sample for backgrounds and borders was not Aa but a "square" (this is maybe something for a new issue for EUI+?)

df68e3e3723764e6f3b47373dea8229d

@acstll acstll removed their request for review February 5, 2025 06:45
@mgadewoll
Copy link
Contributor Author

mgadewoll commented Feb 5, 2025

Thank you @mgadewoll! I only have 2 non-blocking comments regarding text:

  • the first paragraph in the Colors page has this statement (screenshot), I think it's no longer true, is it?
  • the Shades and Special colors are deprecated in the current site but not the new
  • extra: in the tokens table, I think it would be nice if the Sample for backgrounds and borders was not Aa but a "square" (this is maybe something for a new issue for EUI+?)

df68e3e3723764e6f3b47373dea8229d

@acstll Thanks for the notes!

the first paragraph in the Colors page has this statement (screenshot), I think it's no longer true, is it?

True! I missed that one 🫠
I'll update to conditionally switch in current EUI docs, as the text is still correct for Amsterdam. But I think we can update EUI+ docs to use Borealis-only wording. Wdyt?
Updated in this commit.

the Shades and Special colors are deprecated in the current site but not the new

True! I missed updating the description as it's not actually using the JSDoc string anymore 🤦‍♀️ Thanks for the catch!
Updated in this commit.

extra: in the tokens table, I think it would be nice if the Sample for backgrounds and borders was not Aa but a "square" (this is maybe something for a new issue for EUI+?)

Ah yes, good call! 👍
Updated in this commit.

@kibanamachine
Copy link

Preview staging links for this PR:

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

History

cc @mgadewoll

@acstll
Copy link
Contributor

acstll commented Feb 5, 2025

But I think we can update EUI+ docs to use Borealis-only wording. Wdyt?

👌

@mgadewoll mgadewoll merged commit 81e285f into elastic:eui-theme/borealis Feb 6, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants