Skip to content
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

Incomplete documentation for features such as folder upload in Box Uploader element #2727

Open
Yao-Yuan opened this issue Oct 15, 2021 · 1 comment

Comments

@Yao-Yuan
Copy link

Please fill out the following template so we can reproduce and fix your issue as quickly as possible!

Note: if your issue includes a potential security vulnerability, please do not file it here. Instead, email the issue to [email protected] for support.

Note: if your issue involves previewing files, please report the issue here.

Environment:

  • Elements version: 13.0.0

Desktop (please complete the following information):
N.A.

  • OS: [e.g. Windows 10]
  • Browser [e.g. chrome, safari]
  • Version [e.g. 22]

Smartphone (please complete the following information):
N.A.

  • Device: [e.g. iPhone6]
  • OS: [e.g. iOS8.1]
  • Browser [e.g. stock browser, safari]
  • Version [e.g. 22]

Steps to reproduce the problem:
N.A.
What is the expected behavior? (Screenshots can be helpful here)
Documentation provides the full overview of the features and properties that can be configured.
What went wrong? (Screenshots, console logs, or HAR files can be helpful here)
The documentation is incomplete/outdated.
For example, we are trying to make use of Box Explorer as a Javascript library. We could not find any documentation on Folder upload feature but from the code and our testing, it is working.

Link to application or sample code:

If relevant, link to file (or attach file here)

Expected behavior
A clear and concise description of what you expected to happen.
We are expecting to have proper documentation on the developer guide or github readme.

For example, we would like to see important possible properties like "isFolderUploadEnabled" ( from https://github.com/box/box-ui-elements/blob/master/src/elements/content-uploader/ContentUploader.js)
at mentioned place.

Screenshots
N.A.

Additional context
Add any other context about the problem here.
N.A.

@silent-e
Copy link

It is also missing information on the beforeUpload event.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants