feat(nuxt): add route announcer to default app.vue #32621

danielroe · 2025-07-15T13:39:12Z

🔗 Linked issue

resolves #32576

📚 Description

this adds a route announcer to the default app.vue used when there is a pages/ directory

bolt-new-by-stackblitz · 2025-07-15T13:39:15Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-07-15T13:41:23Z

Walkthrough

A new component, <NuxtRouteAnnouncer />, has been inserted into the app.vue template within the <NuxtLayout> element, positioned before the existing <NuxtPage /> component. No other changes to the template structure or logic have been made, and there are no alterations to exported or public entities.

📜 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 e35e1cc and 5d93913.

📒 Files selected for processing (1)

packages/nuxt/src/pages/runtime/app.vue (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

**/*.vue

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

.github/copilot-instructions.md

**/*.{ts,tsx,vue}

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

.github/copilot-instructions.md

🧠 Learnings (2)

📓 Common learnings

Learnt from: huang-julien
PR: nuxt/nuxt#29366
File: packages/nuxt/src/app/components/nuxt-root.vue:16-19
Timestamp: 2024-12-12T12:36:34.871Z
Learning: In `packages/nuxt/src/app/components/nuxt-root.vue`, when optimizing bundle size by conditionally importing components based on route metadata, prefer using inline conditional imports like:

```js
const IsolatedPage = route?.meta?.isolate ? defineAsyncComponent(() => import('#build/isolated-page.mjs')) : null
```

instead of wrapping the import in a computed property or importing the component unconditionally.

Learnt from: GalacticHypernova
PR: nuxt/nuxt#26468
File: packages/nuxt/src/components/plugins/loader.ts:24-24
Timestamp: 2024-11-05T15:22:54.759Z
Learning: In `packages/nuxt/src/components/plugins/loader.ts`, the references to `resolve` and `distDir` are legacy code from before Nuxt used the new unplugin VFS and will be removed.

packages/nuxt/src/pages/runtime/app.vue (2)

Learnt from: huang-julien
PR: nuxt/nuxt#29366
File: packages/nuxt/src/app/components/nuxt-root.vue:16-19
Timestamp: 2024-12-12T12:36:34.871Z
Learning: In `packages/nuxt/src/app/components/nuxt-root.vue`, when optimizing bundle size by conditionally importing components based on route metadata, prefer using inline conditional imports like:

```js
const IsolatedPage = route?.meta?.isolate ? defineAsyncComponent(() => import('#build/isolated-page.mjs')) : null
```

instead of wrapping the import in a computed property or importing the component unconditionally.

Learnt from: GalacticHypernova
PR: nuxt/nuxt#26468
File: packages/nuxt/src/components/plugins/loader.ts:24-24
Timestamp: 2024-11-05T15:22:54.759Z
Learning: In `packages/nuxt/src/components/plugins/loader.ts`, the references to `resolve` and `distDir` are legacy code from before Nuxt used the new unplugin VFS and will be removed.

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

GitHub Check: code
GitHub Check: build

🔇 Additional comments (1)

packages/nuxt/src/pages/runtime/app.vue (1)

3-3: Excellent accessibility enhancement!

The addition of <NuxtRouteAnnouncer /> is a well-placed accessibility improvement that will help screen readers and other assistive technologies announce route changes to users. The positioning before <NuxtPage /> ensures it's available across all pages whilst maintaining the clean template structure.

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch feat/announcer

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.

❤️ Share

🪧 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai auto-generate unit tests to generate unit tests 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.

pkg-pr-new · 2025-07-15T13:42:55Z

Open in StackBlitz

@nuxt/kit

npm i https://pkg.pr.new/@nuxt/kit@32621

nuxt

npm i https://pkg.pr.new/nuxt@32621

@nuxt/rspack-builder

npm i https://pkg.pr.new/@nuxt/rspack-builder@32621

@nuxt/schema

npm i https://pkg.pr.new/@nuxt/schema@32621

@nuxt/vite-builder

npm i https://pkg.pr.new/@nuxt/vite-builder@32621

@nuxt/webpack-builder

npm i https://pkg.pr.new/@nuxt/webpack-builder@32621

commit: 5d93913

codspeed-hq · 2025-07-15T13:54:56Z

CodSpeed Performance Report

Merging #32621 will not alter performance

_{Comparing feat/announcer (5d93913) with main (e35e1cc)}

Summary

✅ 10 untouched benchmarks

feat(nuxt): add route announcer to default app.vue

5d93913

danielroe requested a review from TheAlexLichter July 15, 2025 13:39

github-actions bot added 4.x enhancement labels Jul 15, 2025

TheAlexLichter approved these changes Jul 15, 2025

View reviewed changes

danielroe merged commit 9bf809d into main Jul 15, 2025
47 checks passed

danielroe deleted the feat/announcer branch July 15, 2025 14:37

github-actions bot mentioned this pull request Jul 15, 2025

v4.0.0 #27716

Merged

danielroe added a commit that referenced this pull request Jul 25, 2025

feat(nuxt): add route announcer to default app.vue (#32621)

01d8e6a

github-actions bot mentioned this pull request Jul 25, 2025

v3.18.0 #32713

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(nuxt): add route announcer to default app.vue #32621

feat(nuxt): add route announcer to default app.vue #32621

Uh oh!

danielroe commented Jul 15, 2025

Uh oh!

bolt-new-by-stackblitz bot commented Jul 15, 2025

Uh oh!

coderabbitai bot commented Jul 15, 2025

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Jul 15, 2025

Uh oh!

codspeed-hq bot commented Jul 15, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

feat(nuxt): add route announcer to default app.vue #32621

feat(nuxt): add route announcer to default app.vue #32621

Uh oh!

Conversation

danielroe commented Jul 15, 2025

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Jul 15, 2025

Uh oh!

coderabbitai bot commented Jul 15, 2025

Walkthrough

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Jul 15, 2025

Uh oh!

codspeed-hq bot commented Jul 15, 2025

CodSpeed Performance Report

Merging #32621 will not alter performance

Summary

Uh oh!

Uh oh!

Uh oh!

CodeRabbit Configuration File (`.coderabbit.yaml`)