Skip to content

docs: improve a11y_invalid_attribute warning documentation #16461

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

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

Conversation

brennercruvinel
Copy link

This addresses the confusion mentioned in #15654 where users questioned why this warning was being shown.

Changes

  • Enhanced explanation of why empty href, #, and javascript: URLs are problematic for accessibility
  • Provided clear before/after examples showing common mistakes
  • Added practical alternatives including using buttons for actions and proper styling examples
  • Included suggestions for placeholder links during development

Test plan

  • All existing validator tests pass
  • Documentation is properly formatted
  • Changeset created following project standards

Fixes #15654

Enhance documentation for href validation warnings to better explain accessibility concerns and provide clear alternatives. This addresses confusion from issue sveltejs#15654.

Changes:
- Explain why href="#", empty href, and javascript: URLs are problematic
- Provide practical alternatives (buttons for actions, valid hrefs for navigation)
- Include styling examples for making buttons look like links
- Add development placeholder suggestions
Copy link

changeset-bot bot commented Jul 21, 2025

⚠️ No Changeset found

Latest commit: 3bde6d2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

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

Successfully merging this pull request may close these issues.

Incorrect a11y invalid href attribute warning
2 participants