feat(FileUpload): add `previewFile` prop by mdotme ยท Pull Request #5935 ยท nuxt/ui
๐ Walkthrough
Walkthrough
A new optional previewFile prop is added to the FileUpload component to control whether file previews are generated and displayed. The createObjectUrl function's return type is updated from string to string | undefined to reflect that it may not generate a blob URL. When previewFile is false, the function returns undefined; otherwise, it creates and returns a blob URL as before. Minor default value adjustments accompany the new prop.
Estimated code review effort
๐ฏ 2 (Simple) | โฑ๏ธ ~8 minutes
๐ฅ Pre-merge checks | โ 5
โ Passed checks (5 passed)
| Check name | Status | Explanation |
|---|---|---|
| Description check | โ Passed | The description is related to the changeset, indicating the PR resolves issue #5918 and documents the type of change (enhancement and new feature). |
| Linked Issues check | โ Passed | The PR fully addresses issue #5918 by implementing a previewFile prop to disable image previews, allowing consistent placeholder behavior across file types. |
| Out of Scope Changes check | โ Passed | All changes are directly related to implementing the previewFile prop feature requested in issue #5918; no out-of-scope modifications detected. |
| Docstring Coverage | โ Passed | No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. |
| Title check | โ Passed | The title accurately and concisely summarizes the main change: adding a new previewFile prop to the FileUpload component. |
โ๏ธ Tip: You can configure your own custom pre-merge checks in the settings.
โจ Finishing touches
- ๐ Generate docstrings
๐งช Generate unit tests (beta)
- Create PR with unit tests
- Post copyable unit tests in a comment
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.
Comment @coderabbitai help to get the list of available commands and usage tips.