Repository navigation
docs(vue): Clarify DataClientPlugin defaults, custom Controller typing, $dataClient - #4188
Merged
Merged
Conversation
…g, $dataClient Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UiokfS7nQAzJUYQzPDZHdw
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully 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
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.
Requested by Nathaniel · project thread
Motivation
A review of /vue/api/DataClientPlugin (added in #4143) against the docs rules (
markdown-formatting.mdc,skills-sync.mdc, thepackages-documentationskill) and checked againstpackages/vue/src/providers. Links, imports (@data-client/vueonly), framework handling and skill references were already correct. Three spots gave readers too little to act on:managerslisted only the development defaults, so production behavior wasn't stated. React'sDataProviderpage lists both.Controllersection said "cast to use its additional members" with no example.useController()and$dataClientare typed asController, and that can't be changed by augmentation.$dataClientmentioned Options API use but notthis.$dataClient, and didn't say it comes typed out of the box (the plugin augmentsComponentCustomProperties).Solution
this.$dataClientand say it's typed asController.yarn build:skills).Docs only, so no changeset.
🤖 Generated with Claude Code
https://claude.ai/code/session_01UiokfS7nQAzJUYQzPDZHdw
Generated by Claude Code
Note
Low Risk
Documentation-only changes with no runtime, API, or security impact.
Overview
Documentation-only updates to DataClientPlugin (source
DataClientPlugin.vue.mdplus synced agent skill references) so Vue setup guidance matches runtime behavior and TypeScript reality.The managers section now lists Default Production (
NetworkManager+SubscriptionManager) alongside the existing development defaults, mirroring how React docs describe both environments.The custom Controller option clarifies that
useController()and$dataClientstill type as baseControllereven when a subclass is configured, and adds a shortas MyControllercast example for calling extended methods.The $dataClient section names
this.$dataClientfor Options API usage and states the global is typed asControllerwithout extra augmentation setup.Reviewed by Cursor Bugbot for commit f019b7b. Bugbot is set up for automated code reviews on this repo. Configure here.