Skip to content

docs(vue): Clarify DataClientPlugin defaults, custom Controller typing, $dataClient - #4188

Merged
ntucker merged 1 commit into
masterfrom
claude/project-thread-23yw1u
Oct 5, 2026
Merged

ntucker merged 1 commit into
masterfrom
claude/project-thread-23yw1u

Conversation

@ntucker

@ntucker ntucker commented Oct 5, 2026 •

Copy link
Copy Markdown
Collaborator

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, the packages-documentation skill) and checked against packages/vue/src/providers. Links, imports (@data-client/vue only), framework handling and skill references were already correct. Three spots gave readers too little to act on:

  • managers listed only the development defaults, so production behavior wasn't stated. React's DataProvider page lists both.
  • The custom Controller section said "cast to use its additional members" with no example. useController() and $dataClient are typed as Controller, and that can't be changed by augmentation.
  • $dataClient mentioned Options API use but not this.$dataClient, and didn't say it comes typed out of the box (the plugin augments ComponentCustomProperties).

Solution

  • Add the "Default Production" managers list.
  • Add a short cast example:
import { useController } from '@data-client/vue';

const ctrl = useController() as MyController;
ctrl.doSomething();
  • Name this.$dataClient and say it's typed as Controller.
  • Regenerate skill references (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.md plus 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 $dataClient still type as base Controller even when a subclass is configured, and adds a short as MyController cast example for calling extended methods.

The $dataClient section names this.$dataClient for Options API usage and states the global is typed as Controller without extra augmentation setup.

Reviewed by Cursor Bugbot for commit f019b7b. Bugbot is set up for automated code reviews on this repo. Configure here.

…g, $dataClient

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UiokfS7nQAzJUYQzPDZHdw
@ntucker ntucker self-assigned this Oct 5, 2026
@changeset-bot

changeset-bot Bot commented Oct 5, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: f019b7b

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

@vercel

vercel Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs-site Ready Ready Preview Oct 5, 2026 5:30pm UTC

Request Review

@ntucker
ntucker merged commit 7013dc5 into master Oct 5, 2026
23 checks passed
@ntucker
ntucker deleted the claude/project-thread-23yw1u branch October 5, 2026 17:32

This branch was successfully deployed

1 active deployment
Preview — f019b7bf Deployed Oct 5, 2026 by vercel[bot]
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.

2 participants