Skip to content

feat(nuxt): accept hideDelay and resetDelay props for loading indicator #31532

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.

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

Merged
merged 1 commit into from
Apr 3, 2025

Conversation

danielroe
Copy link
Member

🔗 Linked issue

resolves #26637

📚 Description

this allows configuring hideDelay and resetDelay which were previously only configurable with useLoadingIndicator()

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 25, 2025
Copy link

coderabbitai bot commented Mar 25, 2025

Walkthrough

The changes update the NuxtLoadingIndicator component by introducing two numeric properties, hideDelay and resetDelay, with default values of 500 and 400 respectively. These properties are added to the component's props definition and are subsequently passed as arguments to the useLoadingIndicator function within the component's setup method. The modifications extend the configuration options available for controlling the timing of the loading indicator without altering the component’s existing behaviour.

✨ Finishing Touches
  • 📝 Generate Docstrings

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.
    • 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 plan to trigger planning for file edits and PR creation.
  • @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.

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 (1)
packages/nuxt/src/app/components/nuxt-loading-indicator.ts (1)

15-22: Consider adding JSDoc comments for improved developer experience.

Adding JSDoc comments to describe what these timing parameters control would help other developers understand their purpose without having to look at the implementation of useLoadingIndicator.

+    /**
+     * Delay in ms before hiding the loading indicator after completion
+     */
     hideDelay: {
       type: Number,
       default: 500,
     },
+    /**
+     * Delay in ms before resetting the loading indicator state
+     */
     resetDelay: {
       type: Number,
       default: 400,
     },
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 965b409 and fc28e23.

📒 Files selected for processing (1)
  • packages/nuxt/src/app/components/nuxt-loading-indicator.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: code
  • GitHub Check: codeql (javascript-typescript)
  • GitHub Check: build
  • GitHub Check: codeql (actions)
🔇 Additional comments (2)
packages/nuxt/src/app/components/nuxt-loading-indicator.ts (2)

15-22: Well-structured addition of new props.

The addition of hideDelay and resetDelay props with appropriate types and default values aligns well with the existing pattern in this component. These new props enhance configurability of the loading indicator timing behaviour.


44-45: Correctly integrating new props with the loading indicator.

The new props are properly passed to the useLoadingIndicator function, enabling component-level configuration of these timing parameters.

Copy link

pkg-pr-new bot commented Mar 25, 2025

Open in Stackblitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: fc28e23

Copy link

codspeed-hq bot commented Mar 25, 2025

CodSpeed Performance Report

Merging #31532 will not alter performance

Comparing feat/indicator-delays (fc28e23) with main (965b409)

Summary

✅ 10 untouched benchmarks

@userquin
Copy link
Member

userquin commented Mar 26, 2025

Shouldn't we allow change also the transition and transformOrigin (ltr/rtl direction)?

@danielroe
Copy link
Member Author

@userquin this is already possible:

<NuxtLoadingIndicator :style="{ transformOrigin: 'right', transition: 'height 1s' }" />

@danielroe danielroe merged commit eef0250 into main Apr 3, 2025
47 checks passed
@danielroe danielroe deleted the feat/indicator-delays branch April 3, 2025 15:17
@github-actions github-actions bot mentioned this pull request Apr 3, 2025
@github-actions github-actions bot mentioned this pull request Apr 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

weird behavior with loading indicator component
2 participants
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