-
Notifications
You must be signed in to change notification settings - Fork 30
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
love it
There was a problem hiding this 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"`. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
🚀 Styleguide deploy preview ready! |
📬Published Alpha Packages:@codecademy/[email protected] |
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
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