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

TypeScript version of pds-toolkit-react #9177

Merged
merged 13 commits into from
Sep 23, 2024
Merged

TypeScript version of pds-toolkit-react #9177

merged 13 commits into from
Sep 23, 2024

Conversation

rachelwhitton
Copy link
Member

@rachelwhitton rachelwhitton commented Aug 14, 2024

Replaces #9113

This PR:

  • resets history to ff1c299
  • sync main

Summary

We have recently updated the PDS toolkit to be compatible with TypeScript. This PR updates to the lastest version and tests that the bundle is working correctly — which it is!

New tag colors

This update also introduces a few new changes to the Tag component including truncation for long tag names, an expanded palette of colors (20 total now), and the tags each now have a title attribute included.

Left: proposed tag colors (preview link) ------- Right: current tag colors (live link)

353899018-55cc3a47-df40-465f-a4c8-8d1fc7d89fbd

@rachelwhitton rachelwhitton requested a review from a team as a code owner August 14, 2024 19:29
@rachelwhitton rachelwhitton self-assigned this Aug 14, 2024
@rachelwhitton rachelwhitton changed the title Rewrite history from pds-ts-test TypeScript version of pds-toolkit-react Aug 14, 2024
@rachelwhitton
Copy link
Member Author

rachelwhitton commented Aug 14, 2024

Outstanding discussion blocking merge:

From @IngridKwok

The reddish hues for "Action required" and "Security" are effective and appropriate.
I have concerns regarding the color contrast for the "Deprecated", "User interface" and "WordPress" tags. The dark background combined with the current text color results in insufficient contrast, which may affect readability and accessibility. Defer to Mel for additional comments.

From @mel-miller

@IngridKwok -- all of the color combinations are technically accessible (they pass contrast minimums), but if you feel like it doesn't look contrasty enough maybe pick a different color?

UPDATE:
@IngridKwok If we do pick different colors for those, here's what I suggest.

  • Drupal/Modules, WordPress/Plugins, and General/Deprecated will share the same colors
  • Frees up color-11 to be used for User Interface
Screenshot 2024-08-14 at 3 27 44 PM

If you prefer the colors on the right, let me know and I'll update this PR

@rachelwhitton rachelwhitton added Site: Site Structure Issue or PR with the docs app stack and/or live site dependencies Pull requests that update a dependency file Type: release-notes labels Aug 14, 2024
Copy link

⚡ Deployed with Pantheon Decoupled

This build was successfully deployed with Pantheon. You can track the build logs here.

👀 Preview: https://pr-9177-documentation.appa.pantheon.site
🛠️ Manage in Pantheon: https://dashboard.pantheon.io/site/2b30153f-e8b1-4427-b076-6109e704ba5d/overview

@rachelwhitton rachelwhitton added the Process: Blocked Issue or PR is blocked by something out of scope for the Docs team label Aug 15, 2024
@rachelwhitton
Copy link
Member Author

rachelwhitton commented Aug 15, 2024

Blocked: New error after selecting a category filter, introduced by syncing the main branch. The error is not observed on the preview environment, it is only observed locally
Screenshot 2024-08-14 at 3 19 34 PM

Mel has a likely fix and will review with Gus

@rachelwhitton rachelwhitton removed their assignment Aug 15, 2024
@rachelwhitton
Copy link
Member Author

I reviewed colors with Ingrid in a DM and the alternative suggested above is preferred

Remove `updateQueryStrings()` call — this had been moved to the template file.
Copy link

⚡ Deployed with Pantheon Decoupled

This build was successfully deployed with Pantheon. You can track the build logs here.

👀 Preview: https://pr-9177-documentation.appa.pantheon.site
🛠️ Manage in Pantheon: https://dashboard.pantheon.io/site/2b30153f-e8b1-4427-b076-6109e704ba5d/overview

Copy link

⚡ Deployed with Pantheon Decoupled

This build was successfully deployed with Pantheon. You can track the build logs here.

👀 Preview: https://pr-9177-documentation.appa.pantheon.site
🛠️ Manage in Pantheon: https://dashboard.pantheon.io/site/2b30153f-e8b1-4427-b076-6109e704ba5d/overview

1 similar comment
Copy link

⚡ Deployed with Pantheon Decoupled

This build was successfully deployed with Pantheon. You can track the build logs here.

👀 Preview: https://pr-9177-documentation.appa.pantheon.site
🛠️ Manage in Pantheon: https://dashboard.pantheon.io/site/2b30153f-e8b1-4427-b076-6109e704ba5d/overview

@rachelwhitton
Copy link
Member Author

that seems to have fixed the error, but now when i click to filter by category, the popup disappears before i can interact with it. if i click it again, it stays open

Screen.Recording.2024-08-15.at.1.36.13.PM.mov

reassigning to @gfbollingerHakuna per slack discussion with mel

@gfbollingerHakuna
Copy link
Contributor

Hi @rachelwhitton, I couldn't fully reproduce the issue, but I assume the problem occurs when you open the Popover before the data is fully loaded. This might cause the parent to re-render and close the Popover. I added a small snippet to disable the Popover button in the meantime. Let me know what you think and if it works for you. Thanks!

Copy link

⚡ Deployed with Pantheon Decoupled

This build was successfully deployed with Pantheon. You can track the build logs here.

👀 Preview: https://pr-9177-documentation.appa.pantheon.site
🛠️ Manage in Pantheon: https://dashboard.pantheon.io/site/2b30153f-e8b1-4427-b076-6109e704ba5d/overview

Copy link

⚡ Deployed with Pantheon Decoupled

This build was successfully deployed with Pantheon. You can track the build logs here.

👀 Preview: https://pr-9177-documentation.appa.pantheon.site
🛠️ Manage in Pantheon: https://dashboard.pantheon.io/site/2b30153f-e8b1-4427-b076-6109e704ba5d/overview

@rachelwhitton
Copy link
Member Author

I'm still see the same issue locally, @jazzsequence are you able to reproduce what I'm seeing?

@rachelwhitton
Copy link
Member Author

I noticed if I interact with the cookie banner before the filter things work fine. But if I do not interact with the cookie banner first, that's when I see the issue

Screen.Recording.2024-08-22.at.10.51.18.AM.mov

@jazzsequence
Copy link
Contributor

jazzsequence commented Aug 28, 2024

I can reproduce the same behavior that @rachelwhitton notes. Specifically:

  1. I load the release notes page
  2. I click on the filter by category dropdown
  3. The cookies banner disappears (without interaction)
  4. The filter by category dropdown disappears before I can interact with it

After this, subsequent attempts to use the filter by category dropdown work fine.

Alternately:

  1. I load the release notes page
  2. I click accept cookies (or close the banner, or go into cookie settings)
  3. The cookies banner disappears
  4. The filter by category dropdown works as expected.

This seems like a layer/z-index thing maybe? It seems to only happen when the cookies banner exists (because it's on top). If you interact with the dropdown while the cookies banner is visible, the dropdown cancels the cookies banner out while closing both simultaneously.

Tested in codespaces on this branch.

https://www.loom.com/share/4dad8eff76194a028ab696ce6353d1d9?sid=8771748d-8492-4988-adf8-bff10c1f127a

@rachelwhitton
Copy link
Member Author

@gfbollingerHakuna can you take a look at the recent comments and let us know? cc @mel-miller

@gfbollingerHakuna
Copy link
Contributor

Hi @rachelwhitton. First of all, I apologize for the delayed response. I wasn’t receiving GitHub notifications due to a trusted domain issue (I didn't have my pantheon.io email linked with my github account), so I completely missed your comments.

Are you still experiencing the issue? I ran a couple of checks in my local environment and on the staging link provided via GitHub, but I can’t reproduce it now, even though I was able to earlier. Here’s my Loom: https://www.loom.com/share/fd9b15c7af9c4094a7d49c17d1ada29b.

I noticed that the cookies banner is coming from an external script provided by OneTrust. I’m thinking the issue might have been on their end regarding z-index styles, and maybe they’ve fixed it? Let me know your thoughts and if you’re still encountering the bug. I’ll keep an eye on it. Thanks!

@rachelwhitton
Copy link
Member Author

rachelwhitton commented Sep 23, 2024

@gfbollingerHakuna yes I'm still experiencing this issue when running the docs site locally on this branch. I'm now realizing I also see the issue on the main branch when working locally. I thought I tested that originally but maybe not. @jazzsequence can you check to see if you also see this issue on the main branch? or if you only see it on this branch locally?

@jazzsequence
Copy link
Contributor

I am still able to reproduce the issue on main described in #9177 (comment)

@jazzsequence
Copy link
Contributor

I will note as an addendum to ☝️ that I had to actually delete the stored cookies I had in order to reproduce. If you've saved the cookies, the banner doesn't appear, which is the whole issue.

@rachelwhitton rachelwhitton merged commit d398893 into main Sep 23, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file Process: Blocked Issue or PR is blocked by something out of scope for the Docs team Site: Site Structure Issue or PR with the docs app stack and/or live site Type: release-notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants