Repository navigation
docs(vue): use TypeScript and destructured typed props in Vue examples - #693
Merged
cpojer merged 1 commit intoNov 3, 2026
Merged
Conversation
React examples use TSX, but several Vue examples omitted `lang="ts"`.
Add it to every Vue example with a script block.
Replace implicit `defineProps<Props>()` calls and the runtime
`defineProps({ posts: Array })` declaration with reactive props
destructure and a type declaration, so each example shows where its
template bindings come from.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
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.
Summary
Vue examples in the docs were inconsistent with the React (TSX) examples next to them, and several relied on implicit props.
lang="ts"to every Vue example that has a script block (islands.md×2,markdown.md,layouts.md).defineProps<Props>()and the runtimedefineProps({ posts: Array })with reactive props destructure plus a type declaration:loaders.md:const { users } = defineProps<Props>(),const { projects, usage } = defineProps<Props>()type-safety.md:const { users } = defineProps<Props>()islands.md:const { posts } = defineProps<{ posts: { slug: string; title: string }[] }>()@void/vuealready requiresvue@^3.5, where reactive props destructure is stable.Verification
const { … } = defineProps()withvue/compiler-sfc. Non-island pages have theirdefinePropstype argument removed byvoid-vue:pages-transform. Template references compile to_ctx.*, and script references compile to__props.*.playground/vue-pagespages (users/index.vue,deferred.vue,blog/index.island.vue) to the same destructured form, then ranpackages/vue/test/integration/vue-pages-client.test.ts. 38/38 passed in dev and preview, including SSR, hydration without Vue warnings, deferred props, HMR, and islands. The playground changes were reverted; this PR only touches docs.vp fmt --checkpasses on the changed files.🤖 Generated with Claude Code