Repository navigation
feat!: remove deprecated onUpload callback from CldUploadWidget - #667
Merged
Merged
Conversation
onUpload has been deprecated in favor of onSuccess since #424 and only duplicated the success event. Remove the prop from CldUploadWidget and CldUploadButton, and update docs examples to use onSuccess. BREAKING CHANGE: The `onUpload` prop has been removed from CldUploadWidget and CldUploadButton. Use `onSuccess` instead. Note that the second argument is now an options object: `onUpload={(result, widget) => ...}` becomes `onSuccess={(result, { widget }) => ...}`.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Open
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Removes the deprecated
onUploadprop fromCldUploadWidgetandCldUploadButtonfor v7. It has been deprecated in favor ofonSuccesssince #424, and it only duplicated the success event, printing a deprecation warning in development.The docs examples that still used
onUploadnow useonSuccess, and the "onUpload (Deprecated)" row is removed from the configuration table. The uploading guide's examples also used an older(error, result, widget)signature that no longer matched the component, so they are corrected too.Migration: the second argument of
onSuccessis an options object, not the widget itself:Issue Ticket Number
No separate issue. Part of the v7.0.0 scope discussed in #523 (scope comment).
Type of change
Checklist
Testing
onUploadis now rejected on both components, and the documentedonSuccesspattern compiles.onSuccessfired once per upload on bothCldUploadWidgetandCldUploadButton, andwidget.close()from the options argument closed the widget.