Skip to content

Docs: Cant find callbacks #1166

@zehawki

Description

@zehawki

Is there an existing issue for this?

  • I have searched the existing issues

Which documentation could use some work?

mux-uploader, mux-uploader-react

Is this a discrepancy or an improvement?

improvement

🖊 Describe what you'd like to see change in the documentation

https://github.com/muxinc/elements/blob/HEAD/packages/mux-uploader-react/REFERENCE.md#callbacks:
<MuxUploader/> has a number of callbacks for monitoring upload state. For example, a callback for 'uploaderstart' event is onUploadStart. See mux-uploader's reference for a list of events.

Very mysterious. uploaderstart is called onUploadStart. Ok. So whats the mapping for the rest of the events?

💡 Describe how you think this change will help the documentation

It will make mux-uploader-react useful. I can never understand how companies expect their wares to be used without solid documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions