docs(devtools-a11y): describe the plugin API that the package exports - #546
Open
AlemTuzlak wants to merge 1 commit into
Open
AlemTuzlak wants to merge 1 commit into
AlemTuzlak wants to merge 1 commit into
Conversation
The page showed createA11yPlugin with initial options, a Vue entry point, and exportToJSON/exportToCSV from the package root. None of these exist: the package exports only the react, solid, and angular entry points, the plugin helpers take no options, and the export helpers are internal. The page now shows an Angular quick start, describes the panel settings and where they are saved, and points to the Export buttons. Fixes #422
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 2 minutes. View limit detailsLimit details: You’ve used all 4 included reviews currently available. Review configuration: ⚙️ Run configurationConfiguration used: Repository: TanStack/devtools/.coderabbit.yaml Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
View your CI Pipeline Execution ↗ for commit eec8f8b
☁️ Nx Cloud last updated this comment at |
|
View your CI Pipeline Execution ↗ for commit eec8f8b
☁️ Nx Cloud last updated this comment at |
More templates
@tanstack/angular-devtools
@tanstack/devtools
@tanstack/devtools-a11y
@tanstack/devtools-bundler-core
@tanstack/devtools-client
@tanstack/devtools-rspack
@tanstack/devtools-ui
@tanstack/devtools-utils
@tanstack/devtools-vite
@tanstack/devtools-webmcp
@tanstack/devtools-event-bus
@tanstack/devtools-event-client
@tanstack/preact-devtools
@tanstack/react-devtools
@tanstack/solid-devtools
@tanstack/svelte-devtools
@tanstack/vue-devtools
commit: |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The accessibility plugin docs show
createA11yPlugin, but@tanstack/devtools-a11ydoes not export it. This PR corrects the page so that every snippet uses an API that the package really exports.🎯 Changes
createA11yPlugin({ threshold, ruleSet, ... }). No helper takes options. The section now describes the panel's Settings view and thelocalStoragekey.@tanstack/devtools-a11y/vue, which does not exist. It is now Quick Start (Angular), based onexamples/angular/a11y-devtools.exportToJSONandexportToCSVfrom the package root. The root is not exported, and the helpers are internal. The section now points to the Export JSON and Export CSV buttons.excludeSelectorsoption that does not exist.✅ Checklist
pnpm test:pr, or these tests do not apply to this pull request.🚀 Release Impact
Testing
Commands run
prettier --check docs/plugins/a11y.md: pass.packages/devtools-a11y/package.jsonexports and thereact,solid, andangularentry files.Manual test
docs/plugins/a11y.md.exportsofpackages/devtools-a11y/package.json.How this PR makes testing easy
Docs only. The Angular snippet matches
examples/angular/a11y-devtools/src/app/app.ts.Linked issues
Fixes #422
Risk / rollback
None. Docs only. To undo, revert this PR.
🤖 Generated with Claude Code