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

feat/930-extend-toNewsKitIcon-types #931

Merged
merged 6 commits into from
Jun 21, 2024

Conversation

KayKostadinov
Copy link
Contributor

closes #930

What

  1. Background - why this is needed
    This is needed due to an update in the https://github.com/emotion-icons package. Bootstrapping a project with node 18 and react types 18 resolves the type EmotionIcon for the emotion icons. This results is a type error when passing them to the toNewsKitIcon transformer function.

  2. What did you do
    Extend toNewsKitIcon parameter types to include EmotionIcon.

  3. What does the reviewers should expect

I have done:

  • Written unit tests against changes
  • Written functional tests against the component and/or NewsKit site
  • Updated relevant documentation

I have tested manually:

  • The feature's functionality is working as expected on Chrome, Firefox, Safari and Edge
  • The screen reader reads and flows through the elements as expected.
  • There are no new errors in the browser console coming from this PR.
  • When visual test is not added, it renders correctly on different browsers and mobile viewports (Safari, Firefox, small mobile viewport, tablet)
  • The Playground feature is working as expected

Before:

After:

Who should review this PR:

How to test:

@KayKostadinov KayKostadinov requested a review from a team as a code owner May 31, 2024 07:26
@github-actions github-actions bot added the feature This change contains a new feature label May 31, 2024
pdimova
pdimova previously approved these changes May 31, 2024
@@ -46,6 +46,11 @@ const testsConfig = files
disabledRules = disabledRulesObj.value.elements.map(node => node.value);
}

if (title === 'cardcomposable') {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've added these because the component loads dynamically brightcove video players with repeating aria IDs and this is flagged by the accessibility tests. I can see the same rules were disabled for "title": "video player" component, likely due to the same reason. Since this is loaded by a runtime script the test is flaky.

@KayKostadinov KayKostadinov merged commit 5f41952 into main Jun 21, 2024
32 of 36 checks passed
@KayKostadinov KayKostadinov deleted the feat/930-extend-toNewsKitIcon-types branch June 21, 2024 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature This change contains a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Extend toNewsKitIcon parameter types
5 participants