Skip to content

add ability to override default dropzone placeholder #395

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

sirius-den
Copy link

@sirius-den sirius-den commented Jun 4, 2025

Added support for a customizable placeholder in the dropzone component using a named slot, while preserving default text for backward compatibility.

This allows parent components to inject custom instructional text or UI elements in the dropzone area via the placeholder named slot. If no custom slot is provided, the component falls back to the original default message: "Click to upload or drag and drop."

This enhances flexibility for different use cases (e.g., internationalization, branding, or richer UI) without breaking existing implementations.

Summary by CodeRabbit

  • New Features
    • Added support for customizing the dropzone placeholder text in the file input component via a named slot. The default placeholder remains unchanged unless overridden.
  • Documentation
    • Updated file input component docs with an example showing how to customize the dropzone placeholder text.

Copy link

netlify bot commented Jun 4, 2025

Deploy Preview for sensational-seahorse-8635f8 ready!

Name Link
🔨 Latest commit 6574a38
🔍 Latest deploy log https://app.netlify.com/projects/sensational-seahorse-8635f8/deploys/684011fbd578700008178602
😎 Deploy Preview https://deploy-preview-395--sensational-seahorse-8635f8.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

coderabbitai bot commented Jun 4, 2025

Walkthrough

A named slot called dropzonePlaceholder was added to the file input component's dropzone text area, replacing the previously hardcoded placeholder text. This allows users of the component to customize the placeholder content while retaining the original text as a fallback default. The documentation was updated with an example demonstrating how to use this slot.

Changes

File(s) Change Summary
src/components/FwbFileInput/FwbFileInput.vue Replaced hardcoded dropzone placeholder text with a named slot dropzonePlaceholder for customization.
docs/components/fileInput.md Added documentation example showing usage of the dropzonePlaceholder slot to customize dropzone text.

Poem

A slot for your words, so clever and neat,
The dropzone now welcomes what you wish to greet.
No longer just "Click"—your message can show,
In the land of the files, let your custom text flow!
🐇✨


📜 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 6ba1280 and 6574a38.

📒 Files selected for processing (1)
  • docs/components/fileInput.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • docs/components/fileInput.md

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 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.

Copy link
Contributor

@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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 570e238 and 6ba1280.

📒 Files selected for processing (1)
  • src/components/FwbFileInput/FwbFileInput.vue (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - sensational-seahorse-8635f8
  • GitHub Check: Header rules - sensational-seahorse-8635f8
  • GitHub Check: Pages changed - sensational-seahorse-8635f8

Comment on lines +46 to +49
<slot name="dropzonePlaceholder">
<span class="font-semibold">Click to upload</span>
or drag and drop
</slot>
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Verification agent

🧩 Analysis chain

Well-implemented slot customization with minor naming discrepancy.

The named slot implementation is technically sound and successfully enables dropzone placeholder customization while maintaining backward compatibility. The default content preserves the original functionality.

However, there's a naming inconsistency: the PR objectives mention a slot named "placeholder," but the implementation uses "dropzonePlaceholder." Consider verifying this naming choice aligns with the intended API design.


🏁 Script executed:

#!/bin/bash
# Verify if there are any references to the slot name in documentation or tests
rg -i "dropzonePlaceholder|placeholder.*slot" --type md --type vue --type ts --type js

Length of output: 116


Let’s re-run the search using file globs so .vue files are included:


🏁 Script executed:

#!/bin/bash
# Search for slot references in docs, code, and tests
rg -i "dropzonePlaceholder|placeholder.*slot" --glob "*.vue" --glob "*.md" --glob "*.ts" --glob "*.js"

Length of output: 510


Align slot naming and update documentation

There’s an inconsistency between FwbAvatar (uses a placeholder slot) and FwbFileInput (introduces dropzonePlaceholder), and no docs reference the new slot. Please:

• Decide on a consistent API—either rename the slot in FwbFileInput to placeholder
• or update any related docs/tests to mention dropzonePlaceholder
• Ensure all Markdown docs (e.g. under docs/components/) and example usages are updated to reflect the chosen slot name

🤖 Prompt for AI Agents
In src/components/FwbFileInput/FwbFileInput.vue around lines 46 to 49, there is
a slot named "dropzonePlaceholder" which is inconsistent with the "placeholder"
slot used in FwbAvatar and documentation. To fix this, rename the slot from
"dropzonePlaceholder" to "placeholder" in the component code, and update all
related Markdown documentation and example usages under docs/components/ and any
tests to reflect this consistent slot name.

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.

1 participant