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

Document file_engine in the docs guide on user input #101

Closed
MassiminoilTrace opened this issue Aug 9, 2023 · 2 comments
Closed

Document file_engine in the docs guide on user input #101

MassiminoilTrace opened this issue Aug 9, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@MassiminoilTrace
Copy link
Contributor

MassiminoilTrace commented Aug 9, 2023

At the https://dioxuslabs.com/learn/0.4/reference/user_input page, there's no mention on how to use input fields with type="file".
Trying to print the oninput event using the debug formatting didn't help either, as only empty "value" and "values" fields did show up.
Then I found the existence of the files field from the docs generated by cargo doc, in the dioxus::prelude::FormData. After more searching, I found this other example showing file upload https://github.com/Demonthos/dioxus/blob/master/examples/file_upload.rs

I would suggest documenting the file input feature inside the "user_input" guide page at https://dioxuslabs.com/learn/0.4/reference/user_input page.

Can I help in some way? Be warned that I'm not a native english speaker, so a checking might be needed anyway.

@ealmloff ealmloff added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 9, 2023
@ealmloff
Copy link
Member

ealmloff commented Aug 9, 2023

That sounds like a great addition! Most of dioxus' events mirror the web api, so we don't have documentation on all events in the reference. It makes sense to at least document the file engine because it is significantly different from what you may use in javascript.

Can I help in some way? Be warned that I'm not a native english speaker, so a checking might be needed anyway.

If you would like to add a section to the user_input documentation, I would be happy to check it!

@MassiminoilTrace
Copy link
Contributor Author

Closed with #102

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants