Skip to content

docs: update example to useTemplateRef #31458

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Mar 19, 2025
Merged

docs: update example to useTemplateRef #31458

merged 2 commits into from
Mar 19, 2025
+1 −1

Conversation

sofuxro
Copy link
Contributor

@sofuxro sofuxro commented Mar 19, 2025

📚 Description

As of Vue 3.5 useTemplateRef (vuejs.org/guide/essentials/template-refs#accessing-the-refs‌​) is the way to reference a html element or component

@sofuxro
As of Vue 3.5 useTemplateRef
0727bb0 
As of Vue 3.5 useTemplateRef (vuejs.org/guide/essentials/template-refs#accessing-the-refs‌​) is the way to reference a html element or component
@sofuxro sofuxro requested a review from danielroe as a code owner March 19, 2025 17:07
@bolt-new-by-stackblitz Bolt.new (by StackBlitz)
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@github-actions github-actions bot added the 3.x label Mar 19, 2025
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Mar 19, 2025 •
edited
Loading

Walkthrough

The changes update the method used to create and handle a template reference in a Vue component. Instead of using the default reactive reference created by calling ref(), the code now imports and utilises the useTemplateRef function from Vue. This function is called with a specific identifier to initialise a new template reference. Consequently, the watch function has been updated to observe this new reference. Despite the modification in the reference creation approach, the overall logic of monitoring the component remains unchanged.

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.
📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0727bb0 and c3903b9.

📒 Files selected for processing (1)
  • docs/3.api/1.components/1.client-only.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/3.api/1.components/1.client-only.md
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed Mar 19, 2025
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
docs/3.api/1.components/1.client-only.md (2)

63-65: Adopt the Vue 3.5 API with useTemplateRef

The new import and initialisation of the template reference using useTemplateRef are implemented correctly. However, consider renaming myRef to nuxtWelcomeRef to mirror the reference name used in the template (i.e. <NuxtWelcome ref="nuxtWelcomeRef" />). This alignment will improve clarity and minimise potential confusion for future maintainers.

68-70: Verify watch callback usage for the new template reference

The updated watch function correctly observes the template reference and is configured to trigger only once when <NuxtWelcome /> is mounted. For improved maintainability, it may be worthwhile to include a brief explanatory comment on why the { once: true } option is used.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 853408a and 0727bb0.

📒 Files selected for processing (1)
  • docs/3.api/1.components/1.client-only.md (1 hunks)

danielroe
danielroe reviewed Mar 19, 2025
View reviewed changes
danielroe
danielroe reviewed Mar 19, 2025
View reviewed changes
danielroe
danielroe reviewed Mar 19, 2025
View reviewed changes
@danielroe danielroe changed the title As of Vue 3.5 useTemplateRef docs: update example to useTemplateRef Mar 19, 2025
@danielroe danielroe merged commit 2948e92 into nuxt:main Mar 19, 2025
7 of 8 checks passed
@github-actions github-actions bot mentioned this pull request Mar 19, 2025
Merged
danielroe pushed a commit that referenced this pull request Mar 19, 2025
@sofuxro @danielroe
docs: update example to useTemplateRef (#31458)
0a03381
@github-actions github-actions bot mentioned this pull request Mar 19, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@danielroe danielroe danielroe approved these changes

Assignees
No one assigned
Labels
3.x
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@sofuxro @danielroe
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy