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(HiddenText): updated status to deprecated #2848

Merged
merged 6 commits into from
Apr 2, 2024
Merged

Conversation

LinKCoding
Copy link
Contributor

@LinKCoding LinKCoding commented Mar 15, 2024

Overview

This PR is to mark <HiddenText> as deprecated.
Also to update some confusing screenreader text.

This should only affect Gamut and no other repos

PR Checklist

  • Related to JIRA ticket: GM-625
  • I have run this code to verify it works
  • This PR includes testing instructions tests for the code change
  • The alpha package of this PR is passing end-to-end tests in all relevant Codecademy repositories

Testing Instructions

Visit the <HiddenText> (/?path=/docs/typography-hiddentext--hidden-text) component and see the notice that the status is now "deprecated".
Also Text (/?path=/docs/typography-text--text) and see that the screenreader example now shows less confusing visible text AND when inspecting that the text visible to screenreaders also make more sense.

PR Links and Envs

Repository PR Link PR Env
Monolith Monolith PR Monolith Env
Portal Portal Link Portal Env
Another Repo Another Link Another Env

@LinKCoding LinKCoding changed the title updated hiddentext and text stories fix(HiddenText): updated status to deprecated Mar 15, 2024
Copy link
Contributor

@dreamwasp dreamwasp left a comment

Choose a reason for hiding this comment

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

love it

@dreamwasp dreamwasp marked this pull request as ready for review April 2, 2024 14:07
@dreamwasp dreamwasp requested a review from a team as a code owner April 2, 2024 14:07
Copy link
Contributor

@dreamwasp dreamwasp left a comment

Choose a reason for hiding this comment

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

is this ready to ship? 🔥

Ideally those cases should be exceedingly rare; unfortunately, some of our older pages aren't set up well for this.

For newer pages, use [`<Text>` component](https://gamut.codecademy.com/iframe.html?id=typography-text--screenreader&viewMode=docs#highlight) and set `screenreader="true"`.
Copy link
Member

@jakemhiller jakemhiller Apr 2, 2024

Choose a reason for hiding this comment

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

should we add @ deprecated to the typescript comment above the HiddenText component?

Copy link
Member

Choose a reason for hiding this comment

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

That way it will show up as deprecated when it is used. We could also update the comment to include some of these instructions

@LinKCoding LinKCoding added the Ship It :shipit: Automerge this PR when possible label Apr 2, 2024
@codecademydev
Copy link
Collaborator

🚀 Styleguide deploy preview ready!

https://660c233e91cb4b36e1bf8d17--gamut-preview.netlify.app

Deploy Logs

@codecademydev
Copy link
Collaborator

📬Published Alpha Packages:

@codecademy/[email protected]
@codecademy/[email protected]
@codecademy/[email protected]

@codecademydev codecademydev merged commit ba04142 into main Apr 2, 2024
17 of 19 checks passed
@codecademydev codecademydev deleted the kl-gm-625 branch April 2, 2024 15:25
@codecademydev codecademydev removed the Ship It :shipit: Automerge this PR when possible label Apr 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants