Skip to content

Document the _js parameter in events #1720

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

Closed
1 task done
freddyaboulton opened this issue Jul 6, 2022 · 0 comments · Fixed by #1857
Closed
1 task done

Document the _js parameter in events #1720

freddyaboulton opened this issue Jul 6, 2022 · 0 comments · Fixed by #1857
Assignees
Labels
docs/website Related to documentation or website
Milestone

Comments

@freddyaboulton
Copy link
Collaborator

freddyaboulton commented Jul 6, 2022

  • I have searched to see if a similar issue already exists.

Is your feature request related to a problem? Please describe.
As a gradio user, the _js parameter for event updates is not documented in the website. It is not clear to me what it's for and how to use it.

Describe the solution you'd like
I think we should write a guide on how to use the _js parameter in practice. It's used under the hood by interfaces in the reset button as well as in the block_js_methods demo so those can be motivating examples.

Additional context
Similar to #1368 but I argue it's different. #1368 talks about documenting the event signatures in the Docs page. I think we should go into how _js works via examples/demos.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs/website Related to documentation or website
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants