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

Docs: Play function updates to the canvas example #30365

Merged
merged 3 commits into from
Jan 29, 2025

Conversation

kirjs
Copy link
Contributor

@kirjs kirjs commented Jan 23, 2025

Replace getByRole('another-element') -> getByRole('button') As another-element is not a proper aria-role

Closes #

What I did

Replace getByRole('another-element') -> getByRole('button') As another-element is not a proper aria-role

This is purely docs change.

Checklist for Contributors

Testing

N/A

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Greptile Summary

Updates documentation examples to use the proper ARIA role 'button' instead of the invalid 'another-element' in play function examples, improving accessibility standards and correctness.

  • Modified docs/_snippets/my-component-play-function-with-canvas.md to replace getByRole('another-element') with getByRole('button')
  • Ensures proper ARIA role usage across framework examples (Angular, Svelte, Web Components)

💡 (2/5) Greptile learns from your feedback when you react with 👍/👎!

Replace getByRole('another-element') -> getByRole('button')
As `another-element` is not a proper aria-role
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

@jonniebigodes jonniebigodes self-assigned this Jan 27, 2025
@jonniebigodes jonniebigodes added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch ci:docs Run the CI jobs for documentation checks only. labels Jan 29, 2025
Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

@kirjs, thanks for putting together this pull request and helping us improve the documentation by catching this small typo in the examples. Appreciate it 🙏 !
I've checked, and everything is good on my end. I will gladly merge this.

Hope you have a fantastic day.

Stay safe

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

@jonniebigodes jonniebigodes changed the title Update my-component-play-function-with-canvas.md Docs: Play function updates to the canvas example Jan 29, 2025
@jonniebigodes jonniebigodes merged commit c9a7dfa into storybookjs:next Jan 29, 2025
5 checks passed
shilman pushed a commit that referenced this pull request Feb 1, 2025
Docs: Play function updates to the canvas example
(cherry picked from commit c9a7dfa)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Feb 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs Run the CI jobs for documentation checks only. documentation patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants