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

[LUNA-1331] [BpkCheckbox] Add ARIA label prop #3544

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

Scomcn
Copy link
Contributor

@Scomcn Scomcn commented Jul 19, 2024

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

Copy link

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

Copy link

github-actions bot commented Jul 19, 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?

Browser support

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

Generated by 🚫 dangerJS against 2a11d19

@Scomcn Scomcn marked this pull request as ready for review July 23, 2024 12:48
Copy link

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

@Scomcn Scomcn added the patch Patch production bug label Jul 25, 2024
Copy link

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

Copy link

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

Comment on lines +32 to +43

it('should render using label as aria-label if no ariaLabel prop provided', async () => {
render(<BpkCheckbox name="checkbox" label="Prefer directs" />);
const label = screen.getByLabelText('Prefer directs');
expect(label).toBeInTheDocument();
});

it('should render using ariaLabel prop as aria-label if prop provided', async () => {
render(<BpkCheckbox name="checkbox" label="Prefer directs" ariaLabel="aria label test string"/>);
const ariaLabel = screen.getByLabelText('aria label test string');
expect(ariaLabel).toBeInTheDocument();
});
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd maybe add another test that should render using ariaLabel when both aria-label and label are provided [completely optional to add]

@olliecurtis olliecurtis self-assigned this Jul 31, 2024
@olliecurtis
Copy link
Member

Will come back round to this as we recently had a similar query from Luna and aria label wasn't necessarily the best way to do this. Will dig out the conversation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
patch Patch production bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants