improve the documentation for `js` parameter in `Blocks`, `Interface`, `ChatInterface` #8105

abidlabs · 2024-04-23T18:10:16Z

I tried to use this parameter and was confused on how to set it up. Thanks @dawoodkhan82 @pngwn for clarifying, I've carried over your comments to the docstrings here.

gradio-pr-bot · 2024-04-23T18:10:55Z

🪼 branch checks and previews

•	Name	Status	URL
	Spaces	ready!	Spaces preview
	Website	failed!	Details
🦄	Changes	detecting...

Install Gradio from this PR

pip install https://gradio-builds.s3.amazonaws.com/037545f1eece2e63516d3f3037599c0a30e48091/gradio-4.27.0-py3-none-any.whl

Install Gradio Python Client from this PR

pip install "gradio-client @ git+https://github.com/gradio-app/gradio@037545f1eece2e63516d3f3037599c0a30e48091#subdirectory=client/python"

gradio-pr-bot · 2024-04-23T18:12:14Z

🦄 change detected

This Pull Request includes changes to the following packages.

Package	Version
`gradio`	`patch`

Maintainers can select this checkbox to manually select packages to update.

With the following changelog entry.

improve the documentation for js parameter in Blocks, Interface, ChatInterface

Maintainers or the PR author can modify the PR title to modify this entry.

Something isn't right?

Maintainers can change the version label to modify the version bump.
If the bot has failed to detect any changes, or if this pull request needs to update multiple packages to different versions or requires a more comprehensive changelog entry, maintainers can update the changelog file directly.

dawoodkhan82

Thanks for fixing!

pngwn

Small typos but looks good! Thanks @abidlabs!

pngwn · 2024-04-23T20:16:12Z

gradio/blocks.py

@@ -716,8 +716,8 @@ def __init__(
            mode: A human-friendly name for the kind of Blocks or Interface being created. Used internally for analytics.
            title: The tab title to display when this is opened in a browser window.
            css: Custom css as a string or path to a css file. This css will be included in the demo webpage.
-            js: Custom js or path to js file to run when demo is first loaded. This javascript will be included in the demo webpage.
-            head: Custom html to insert into the head of the demo webpage. This can be used to add custom meta tags, scripts, stylesheets, etc. to the page.
+            js: Custom js as a string or path to a js file. The custom js should in the form of a single js function. This function will automatically be executed when the page loads. For more flexibility, use the head parameter to insert js inside <script> tags.


Suggested change

js: Custom js as a string or path to a js file. The custom js should in the form of a single js function. This function will automatically be executed when the page loads. For more flexibility, use the head parameter to insert js inside <script> tags.

js: Custom js as a string or path to a js file. The custom js should be in the form of a single js function. This function will automatically be executed when the page loads. For more flexibility, use the head parameter to insert js inside <script> tags.

pngwn · 2024-04-23T20:16:44Z

gradio/chat_interface.py

@@ -94,8 +94,8 @@ def __init__(
            description: a description for the interface; if provided, appears above the chatbot and beneath the title in regular font. Accepts Markdown and HTML content.
            theme: Theme to use, loaded from gradio.themes.
            css: Custom css as a string or path to a css file. This css will be included in the demo webpage.
-            js: Custom js or path to js file to run when demo is first loaded. This javascript will be included in the demo webpage.
-            head: Custom html to insert into the head of the demo webpage. This can be used to add custom meta tags, scripts, stylesheets, etc. to the page.
+            js: Custom js as a string or path to a js file. The custom js should in the form of a single js function. This function will automatically be executed when the page loads. For more flexibility, use the head parameter to insert js inside <script> tags.


Suggested change

js: Custom js as a string or path to a js file. The custom js should in the form of a single js function. This function will automatically be executed when the page loads. For more flexibility, use the head parameter to insert js inside <script> tags.

js: Custom js as a string or path to a js file. The custom js should be in the form of a single js function. This function will automatically be executed when the page loads. For more flexibility, use the head parameter to insert js inside <script> tags.

pngwn · 2024-04-23T20:17:04Z

gradio/interface.py

@@ -913,8 +913,8 @@ def __init__(
            theme: A Theme object or a string representing a theme. If a string, will look for a built-in theme with that name (e.g. "soft" or "default"), or will attempt to load a theme from the Hugging Face Hub (e.g. "gradio/monochrome"). If None, will use the Default theme.
            analytics_enabled: Whether to allow basic telemetry. If None, will use GRADIO_ANALYTICS_ENABLED environment variable or default to True.
            css: Custom css as a string or path to a css file. This css will be included in the demo webpage.
-            js: Custom js or path to js file to run when demo is first loaded. This javascript will be included in the demo webpage.
-            head: Custom html to insert into the head of the demo webpage. This can be used to add custom meta tags, scripts, stylesheets, etc. to the page.
+            js: Custom js as a string or path to a js file. The custom js should in the form of a single js function. This function will automatically be executed when the page loads. For more flexibility, use the head parameter to insert js inside <script> tags.


Suggested change

js: Custom js as a string or path to a js file. The custom js should in the form of a single js function. This function will automatically be executed when the page loads. For more flexibility, use the head parameter to insert js inside <script> tags.

js: Custom js as a string or path to a js file. The custom js should be in the form of a single js function. This function will automatically be executed when the page loads. For more flexibility, use the head parameter to insert js inside <script> tags.

pngwn · 2024-04-23T20:17:47Z

oh it merjd

abidlabs · 2024-04-23T20:19:44Z

whoops my bad, I will quickly fix in a follow up

* js docs * changes * fix typo

js docs

16b13d7

changes

3f04ccb

abidlabs added the v: patch A change that requires a patch release label Apr 23, 2024

abidlabs requested review from pngwn and dawoodkhan82 April 23, 2024 18:11

add changeset

037545f

dawoodkhan82 approved these changes Apr 23, 2024

View reviewed changes

abidlabs merged commit 006fa3c into main Apr 23, 2024
7 checks passed

abidlabs deleted the js-docs branch April 23, 2024 20:16

pngwn reviewed Apr 23, 2024

View reviewed changes

abidlabs mentioned this pull request Apr 23, 2024

fix typo from #8105 #8107

Merged

abidlabs added a commit that referenced this pull request Apr 23, 2024

fix typo from #8105 (#8107)

cbf2d4e

* js docs * changes * fix typo

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

improve the documentation for `js` parameter in `Blocks`, `Interface`, `ChatInterface` #8105

improve the documentation for `js` parameter in `Blocks`, `Interface`, `ChatInterface` #8105

abidlabs commented Apr 23, 2024 •

edited

gradio-pr-bot commented Apr 23, 2024 •

edited

gradio-pr-bot commented Apr 23, 2024

Something isn't right?

dawoodkhan82 left a comment

pngwn left a comment

pngwn Apr 23, 2024

pngwn Apr 23, 2024

pngwn Apr 23, 2024

pngwn commented Apr 23, 2024

abidlabs commented Apr 23, 2024

	js: Custom js as a string or path to a js file. The custom js should in the form of a single js function. This function will automatically be executed when the page loads. For more flexibility, use the head parameter to insert js inside <script> tags.
	js: Custom js as a string or path to a js file. The custom js should be in the form of a single js function. This function will automatically be executed when the page loads. For more flexibility, use the head parameter to insert js inside <script> tags.

improve the documentation for js parameter in Blocks, Interface, ChatInterface #8105

improve the documentation for js parameter in Blocks, Interface, ChatInterface #8105

Conversation

abidlabs commented Apr 23, 2024 • edited

gradio-pr-bot commented Apr 23, 2024 • edited

🪼 branch checks and previews

gradio-pr-bot commented Apr 23, 2024

🦄 change detected

This Pull Request includes changes to the following packages.

With the following changelog entry.

Something isn't right?

dawoodkhan82 left a comment

Choose a reason for hiding this comment

pngwn left a comment

Choose a reason for hiding this comment

pngwn Apr 23, 2024

Choose a reason for hiding this comment

pngwn Apr 23, 2024

Choose a reason for hiding this comment

pngwn Apr 23, 2024

Choose a reason for hiding this comment

pngwn commented Apr 23, 2024

abidlabs commented Apr 23, 2024

improve the documentation for `js` parameter in `Blocks`, `Interface`, `ChatInterface` #8105

improve the documentation for `js` parameter in `Blocks`, `Interface`, `ChatInterface` #8105

abidlabs commented Apr 23, 2024 •

edited

gradio-pr-bot commented Apr 23, 2024 •

edited