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

[PANGOO-2594][BpkNavigationTabGroup]Fix BPK NavTabGroup Warning #3618

Merged
merged 3 commits into from
Sep 30, 2024

Conversation

kerrie625
Copy link
Contributor

@kerrie625 kerrie625 commented Sep 26, 2024

There is warning For BPK NavTabGroup.So need to fix.

image

Remember to include the following changes:

  • Ensure the PR title includes the name of the component you are changing so it's clear in the release notes for consumers of the changes in the version e.g [KOA-123][BpkButton] Updating the colour
  • README.md (If you have created a new component)
  • Component README.md
  • Tests
  • Accessibility tests
    • The following checks were performed:
      • Ability to navigate using a keyboard only
      • Zoom functionality (Deque University explanation):
        • The page SHOULD be functional AND readable when only the text is magnified to 200% of its initial size
        • Pages must reflow as zoom increases up to 400% so that content continues to be presented in only one column i.e. Content MUST NOT require scrolling in two directions (both vertically and horizontally)
      • Ability to navigate using a screen reader only
  • Storybook examples created/updated
  • For breaking changes or deprecating components/properties, migration guides added to the description of the PR. If the guide has large changes, consider creating a new Markdown page inside the component's docs folder and link it here

@kerrie625 kerrie625 added the minor Non breaking change label Sep 26, 2024
Copy link

Visit https://backpack.github.io/storybook-prs/3618 to see this build running in a browser.

Copy link

github-actions bot commented Sep 26, 2024

Warnings
⚠️

Package source files (e.g. packages/package-name/src/Component.js) were updated, but snapshots weren't. Have you checked that the tests still pass?

⚠️

Package source files (e.g. packages/package-name/src/Component.tsx) were updated, but type files weren't. Have you checked that no types have changed?

Browser support

If this is a visual change, make sure you've tested it in multiple browsers.

Generated by 🚫 dangerJS against 930fd3f

@@ -92,7 +92,6 @@ const SimpleCanvasDefault = () => (
onItemClick={() => {}}
selectedIndex={0}
type={NAVIGATION_TAB_GROUP_TYPES.CanvasDefault}
ariaLabel="Navigation tabs"
Copy link
Contributor

@amburrrshand amburrrshand Sep 26, 2024

Choose a reason for hiding this comment

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

Why did you decide to remove the ariaLabel?

Copy link
Contributor Author

@kerrie625 kerrie625 Sep 26, 2024

Choose a reason for hiding this comment

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

Thanks @amburrrshand .Not remove it, Just change ariaLabel as optional. And this example is used for test props without ariaLabel

Copy link
Member

Choose a reason for hiding this comment

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

What is the reasoning to make it optional?

Surely by doing this we are decreasing Accessibility for travellers?

Copy link
Contributor Author

@kerrie625 kerrie625 Sep 26, 2024

Choose a reason for hiding this comment

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

When checking header tabs on production, I found the navigation tabs did not include ariaLabel before. So I think it needs to change this ariaLabel to option. Is it reasonable for consumer decide to whether pass this ariaLabel?

Copy link
Contributor

Choose a reason for hiding this comment

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

In this case, I think it's best practice for accessibility standards to not have it as optional

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@olliecurtis @amburrrshand Thank you for your advice. I have reverted the ariaLabel as required.

Copy link

Visit https://backpack.github.io/storybook-prs/3618 to see this build running in a browser.

Copy link

Visit https://backpack.github.io/storybook-prs/3618 to see this build running in a browser.

Copy link
Contributor

@amburrrshand amburrrshand left a comment

Choose a reason for hiding this comment

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

LGTM

@amburrrshand amburrrshand merged commit 76d814d into main Sep 30, 2024
9 checks passed
@amburrrshand amburrrshand deleted the PANGOO-2594 branch September 30, 2024 07:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
minor Non breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants