mirror of
https://github.com/gradio-app/gradio.git
synced 2025-03-31 12:20:26 +08:00
Fix component events matrix in docs (#4863)
* fix events matrix * regenerate json * remove ordered_events * remove hardcoded events * mistake * add end to docs
This commit is contained in:
Ali Abdalla
GitHub
parent
6436e4ea5b
commit
5d080cdb74
@ -223,7 +223,7 @@ class Clearable(EventListener):
|
||||
"""
|
||||
|
||||
|
||||
@document("*play", "*pause", "*stop", inherit=True)
|
||||
@document("*play", "*pause", "*stop", "*end", inherit=True)
|
||||
class Playable(EventListener):
|
||||
def __init__(self):
|
||||
self.play = EventListenerMethod(self, "play")
|
||||
|
||||
@ -1,8 +1,9 @@
|
||||
import json
|
||||
import os
|
||||
from gradio_client.documentation import generate_documentation, document_cls
|
||||
from gradio.events import EventListener
|
||||
from gradio.events import EventListener, EventListenerMethod
|
||||
from ..guides import guides
|
||||
import inspect
|
||||
|
||||
DIR = os.path.dirname(__file__)
|
||||
DEMOS_DIR = os.path.abspath(os.path.join(DIR, "../../../../../demo"))
|
||||
@ -54,35 +55,26 @@ def add_demos():
|
||||
|
||||
add_demos()
|
||||
|
||||
ordered_events = [
|
||||
"Change()",
|
||||
"Click()",
|
||||
"Submit()",
|
||||
"Edit()",
|
||||
"Clear()",
|
||||
"Play()",
|
||||
"Pause()",
|
||||
"Stream()",
|
||||
"Blur()",
|
||||
"Upload()",
|
||||
]
|
||||
|
||||
|
||||
def add_supported_events():
|
||||
def create_events_matrix():
|
||||
events = []
|
||||
for c in EventListener.__subclasses__():
|
||||
methods = c().__dict__
|
||||
for m in methods:
|
||||
if m[:1] != '_' and isinstance(methods[m], EventListenerMethod) and m not in events:
|
||||
events.append(m)
|
||||
component_events = {}
|
||||
for component in docs["component"]:
|
||||
component["events_list"] = []
|
||||
event_listener_props = dir(EventListener)
|
||||
for listener in EventListener.__subclasses__():
|
||||
if not issubclass(component["class"], listener):
|
||||
continue
|
||||
for prop in dir(listener):
|
||||
if prop not in event_listener_props:
|
||||
component["events_list"].append(prop + "()")
|
||||
if component["events_list"]:
|
||||
component["events"] = ", ".join(component["events_list"])
|
||||
component_event_list = []
|
||||
for event in events:
|
||||
for fn in component["fns"]:
|
||||
if event == fn["name"]:
|
||||
component_event_list.append(event)
|
||||
component_events[component["name"]] = component_event_list
|
||||
|
||||
|
||||
return events, component_events
|
||||
|
||||
|
||||
add_supported_events()
|
||||
events, component_events = create_events_matrix()
|
||||
|
||||
|
||||
def add_guides():
|
||||
@ -267,7 +259,8 @@ def organize_docs(d):
|
||||
c_keys[i + 1]
|
||||
]["name"]
|
||||
|
||||
organized["ordered_events"] = ordered_events
|
||||
organized["events_matrix"] = component_events
|
||||
organized["events"] = events
|
||||
|
||||
with open(JS_CLIENT_README, "r") as f:
|
||||
readme_content = f.read()
|
||||
@ -279,4 +272,4 @@ docs = organize_docs(docs)
|
||||
|
||||
def generate(json_path):
|
||||
with open(json_path, "w+") as f:
|
||||
json.dump(docs, f)
|
||||
json.dump(docs, f)
|
||||
File diff suppressed because one or more lines are too long
@ -6,7 +6,8 @@ let helpers = docs_json.docs.helpers;
|
||||
let routes = docs_json.docs.routes;
|
||||
let py_client = docs_json.docs["py-client"];
|
||||
|
||||
let ordered_events = docs_json.docs.ordered_events;
|
||||
let events = docs_json.docs.events;
|
||||
let events_matrix = docs_json.docs.events_matrix;
|
||||
|
||||
export async function load() {
|
||||
return {
|
||||
@ -14,6 +15,7 @@ export async function load() {
|
||||
helpers,
|
||||
routes,
|
||||
py_client,
|
||||
ordered_events
|
||||
events,
|
||||
events_matrix
|
||||
};
|
||||
}
|
||||
|
||||
@ -8,7 +8,8 @@
|
||||
let components: Record<string, any> = data.components;
|
||||
let helpers = data.helpers;
|
||||
let routes = data.routes;
|
||||
let ordered_events = data.ordered_events;
|
||||
let events = data.events;
|
||||
let events_matrix = data.events_matrix;
|
||||
let py_client = data.py_client;
|
||||
</script>
|
||||
|
||||
@ -100,24 +101,15 @@
|
||||
</div>
|
||||
|
||||
<div class="max-h-96 overflow-y-scroll my-6">
|
||||
<table class="table-fixed w-full leading-loose">
|
||||
<table class="table-fixed leading-loose">
|
||||
<thead class="text-center sticky top-0">
|
||||
<tr>
|
||||
<th class="p-3 bg-white w-1/5" />
|
||||
<th class="p-3 font-normal bg-white border-t border-l"
|
||||
>Change</th
|
||||
>
|
||||
<th class="p-3 font-normal bg-white border-t">Click</th>
|
||||
<th class="p-3 font-normal bg-white border-t">Submit</th>
|
||||
<th class="p-3 font-normal bg-white border-t">Edit</th>
|
||||
<th class="p-3 font-normal bg-white border-t">Clear</th>
|
||||
<th class="p-3 font-normal bg-white border-t">Play</th>
|
||||
<th class="p-3 font-normal bg-white border-t">Pause</th>
|
||||
<th class="p-3 font-normal bg-white border-t">Stream</th>
|
||||
<th class="p-3 font-normal bg-white border-t">Blur</th>
|
||||
<th class="p-3 font-normal bg-white border-t border-r"
|
||||
>Upload</th
|
||||
>
|
||||
<th class="p-3 bg-white w-1/5 sticky left-0" />
|
||||
{#each events as event}
|
||||
<th class="p-3 font-normal bg-white border-t border-l"
|
||||
>{event}</th
|
||||
>
|
||||
{/each}
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody
|
||||
@ -125,14 +117,14 @@
|
||||
>
|
||||
{#each Object.entries(components) as [name, obj] (name)}
|
||||
<tr class="group hover:bg-gray-200/60">
|
||||
<td class="p-3 w-1/5 bg-white">
|
||||
<th class="p-3 w-1/5 bg-white sticky z-2 left-0 font-normal">
|
||||
<a href={obj.name.toLowerCase()} class="thin-link"
|
||||
>{obj.name}</a
|
||||
>
|
||||
</td>
|
||||
{#each ordered_events as event}
|
||||
</th>
|
||||
{#each events as event}
|
||||
<td class="p-3 text-gray-700 break-words text-center">
|
||||
{#if obj.events_list.includes(event.toLowerCase())}
|
||||
{#if events_matrix[obj.name].includes(event.toLowerCase())}
|
||||
<p class="text-orange-500">✓</p>
|
||||
{:else}
|
||||
<p class="text-gray-300">✕</p>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -19,7 +19,6 @@ let helpers = docs_json.docs.helpers;
|
||||
let routes = docs_json.docs.routes;
|
||||
let py_client = docs_json.docs["py-client"];
|
||||
let js_client = docs_json.js_client;
|
||||
let ordered_events = docs_json.docs.ordered_events;
|
||||
|
||||
function plugin() {
|
||||
return function transform(tree: any) {
|
||||
@ -48,10 +47,10 @@ function highlight(code: string, lang: string | undefined) {
|
||||
|
||||
const highlighted = _lang
|
||||
? `<pre class="language-${lang}"><code>${Prism.highlight(
|
||||
code,
|
||||
Prism.languages[_lang],
|
||||
_lang
|
||||
)}</code></pre>`
|
||||
code,
|
||||
Prism.languages[_lang],
|
||||
_lang
|
||||
)}</code></pre>`
|
||||
: code;
|
||||
|
||||
return highlighted;
|
||||
@ -117,7 +116,6 @@ export async function load({ params }: any) {
|
||||
components,
|
||||
helpers,
|
||||
routes,
|
||||
py_client,
|
||||
ordered_events
|
||||
py_client
|
||||
};
|
||||
}
|
||||
|
||||
@ -8,7 +8,6 @@
|
||||
let components = data.components;
|
||||
let helpers = data.helpers;
|
||||
let routes = data.routes;
|
||||
let ordered_events = data.ordered_events;
|
||||
let py_client = data.py_client;
|
||||
|
||||
let readme_html = data.readme_html;
|
||||
|
||||
@ -5,14 +5,12 @@ let components = docs_json.docs.components;
|
||||
let helpers = docs_json.docs.helpers;
|
||||
let routes = docs_json.docs.routes;
|
||||
let py_client = docs_json.docs["py-client"];
|
||||
let ordered_events = docs_json.docs.ordered_events;
|
||||
|
||||
export async function load() {
|
||||
return {
|
||||
components,
|
||||
helpers,
|
||||
routes,
|
||||
py_client,
|
||||
ordered_events
|
||||
py_client
|
||||
};
|
||||
}
|
||||
|
||||
@ -6,7 +6,6 @@
|
||||
let components = data.components;
|
||||
let helpers = data.helpers;
|
||||
let routes = data.routes;
|
||||
let ordered_events = data.ordered_events;
|
||||
let py_client = data.py_client;
|
||||
</script>
|
||||
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -7,15 +7,19 @@ export const redirects = {
|
||||
"/using-flagging": "/guides/using-flagging",
|
||||
"/named-entity-recognition": "/guides/named-entity-recognition",
|
||||
"/real-time-speech-recognition": "/guides/real-time-speech-recognition",
|
||||
"/eveloping-faster-with-reload-mode": "/guides/eveloping-faster-with-reload-mode",
|
||||
"/create-your-own-friends-with-a-gan": "/guides/create-your-own-friends-with-a-gan",
|
||||
"/setting-up-a-demo-for-maximum-performance": "/guides/setting-up-a-demo-for-maximum-performance",
|
||||
"/eveloping-faster-with-reload-mode":
|
||||
"/guides/eveloping-faster-with-reload-mode",
|
||||
"/create-your-own-friends-with-a-gan":
|
||||
"/guides/create-your-own-friends-with-a-gan",
|
||||
"/setting-up-a-demo-for-maximum-performance":
|
||||
"/guides/setting-up-a-demo-for-maximum-performance",
|
||||
"/building-a-pictionary-app": "/guides/building-a-pictionary-app",
|
||||
"/creating-a-chatbot": "/guides/creating-a-chatbot",
|
||||
"/how-to-use-D-model-component": "/guides/how-to-use-D-model-component",
|
||||
"/creating-a-new-component": "/guides/creating-a-new-component",
|
||||
"/running-background-tasks": "/guides/running-background-tasks",
|
||||
"/custom-interpretations-with-blocks": "/guides/custom-interpretations-with-blocks",
|
||||
"/custom-interpretations-with-blocks":
|
||||
"/guides/custom-interpretations-with-blocks",
|
||||
"/reactive-interfaces": "/guides/reactive-interfaces",
|
||||
"/four-kinds-of-interfaces": "/guides/four-kinds-of-interfaces",
|
||||
"/interface-state": "/guides/interface-state",
|
||||
@ -25,16 +29,21 @@ export const redirects = {
|
||||
"/quickstart": "/guides/quickstart",
|
||||
"/sharing-your-app": "/guides/sharing-your-app",
|
||||
"/connecting-to-a-database": "/guides/connecting-to-a-database",
|
||||
"/creating-a-realtime-dashboard-from-google-sheets": "/guides/creating-a-realtime-dashboard-from-google-sheets",
|
||||
"/creating-a-realtime-dashboard-from-google-sheets":
|
||||
"/guides/creating-a-realtime-dashboard-from-google-sheets",
|
||||
"/plot-component-for-maps": "/guides/plot-component-for-maps",
|
||||
"/creating-a-dashboard-from-bigquery-data": "/guides/creating-a-dashboard-from-bigquery-data",
|
||||
"/using-gradio-for-tabular-workflows": "/guides/using-gradio-for-tabular-workflows",
|
||||
"/creating-a-dashboard-from-bigquery-data":
|
||||
"/guides/creating-a-dashboard-from-bigquery-data",
|
||||
"/using-gradio-for-tabular-workflows":
|
||||
"/guides/using-gradio-for-tabular-workflows",
|
||||
"/image-classification-in-pytorch": "/guides/image-classification-in-pytorch",
|
||||
"/using-hugging-face-integrations": "/guides/using-hugging-face-integrations",
|
||||
"/Gradio-and-ONNX-on-Hugging-Face": "/guides/Gradio-and-ONNX-on-Hugging-Face",
|
||||
"/image-classification-with-vision-transformers": "/guides/image-classification-with-vision-transformers",
|
||||
"/image-classification-with-vision-transformers":
|
||||
"/guides/image-classification-with-vision-transformers",
|
||||
"/Gradio-and-Wandb-Integration": "/guides/Gradio-and-Wandb-Integration",
|
||||
"/image-classification-in-tensorflow": "/guides/image-classification-in-tensorflow",
|
||||
"/image-classification-in-tensorflow":
|
||||
"/guides/image-classification-in-tensorflow",
|
||||
"/Gradio-and-Comet": "/guides/Gradio-and-Comet",
|
||||
"/introduction_to_blocks": "/guides/quickstart#more-complexity",
|
||||
"/adding_examples_to_your_app": "/guides/key-features#example-inputs",
|
||||
@ -53,15 +62,19 @@ export const redirects = {
|
||||
"/using_flagging": "/guides/using-flagging",
|
||||
"/named_entity_recognition": "/guides/named-entity-recognition",
|
||||
"/real_time_speech_recognition": "/guides/real-time-speech-recognition",
|
||||
"/developing_faster_with_reload_mode": "/guides/developing-faster-with-reload-mode",
|
||||
"/create_your_own_friends_with_a_gan": "/guides/create-your-own-friends-with-a-gan",
|
||||
"/setting_up_a_demo_for_maximum_performance": "/guides/setting-up-a-demo-for-maximum-performance",
|
||||
"/developing_faster_with_reload_mode":
|
||||
"/guides/developing-faster-with-reload-mode",
|
||||
"/create_your_own_friends_with_a_gan":
|
||||
"/guides/create-your-own-friends-with-a-gan",
|
||||
"/setting_up_a_demo_for_maximum_performance":
|
||||
"/guides/setting-up-a-demo-for-maximum-performance",
|
||||
"/building_a_pictionary_app": "/guides/building-a-pictionary-app",
|
||||
"/creating_a_chatbot": "/guides/creating-a-chatbot",
|
||||
"/how_to_use_3D_model_component": "/guides/how-to-use-3D-model-component",
|
||||
"/creating_a_new_component": "/guides/creating-a-new-component",
|
||||
"/running_background_tasks": "/guides/running-background-tasks",
|
||||
"/custom_interpretations_with_blocks": "/guides/custom-interpretations-with-blocks",
|
||||
"/custom_interpretations_with_blocks":
|
||||
"/guides/custom-interpretations-with-blocks",
|
||||
"/reactive_interfaces": "/guides/reactive-interfaces",
|
||||
"/more_on_examples_and_flagging": "/guides/more-on-examples",
|
||||
"/interface_state": "/guides/interface-state",
|
||||
@ -69,14 +82,19 @@ export const redirects = {
|
||||
"/key_features": "/guides/key-features",
|
||||
"/sharing_your_app": "/guides/sharing-your-app",
|
||||
"/connecting_to_a_database": "/guides/connecting-to-a-database",
|
||||
"/creating_a_realtime_dashboard_from_google_sheets": "/guides/creating-a-realtime-dashboard-from-google-sheets",
|
||||
"/creating_a_realtime_dashboard_from_google_sheets":
|
||||
"/guides/creating-a-realtime-dashboard-from-google-sheets",
|
||||
"/plot_component_for_maps": "/guides/plot-component-for-maps",
|
||||
"/creating_a_dashboard_from_bigquery_data": "/guides/creating-a-dashboard-from-bigquery-data",
|
||||
"/using_gradio_for_tabular_workflows": "/guides/using-gradio-for-tabular-workflows",
|
||||
"/creating_a_dashboard_from_bigquery_data":
|
||||
"/guides/creating-a-dashboard-from-bigquery-data",
|
||||
"/using_gradio_for_tabular_workflows":
|
||||
"/guides/using-gradio-for-tabular-workflows",
|
||||
"/image_classification_in_pytorch": "/guides/image-classification-in-pytorch",
|
||||
"/using_hugging_face_integrations": "/guides/using-hugging-face-integrations",
|
||||
"/Gradio_and_ONNX_on_Hugging_Face": "/guides/Gradio-and-ONNX-on-Hugging-Face",
|
||||
"/image_classification_with_vision_transformers": "/guides/image-classification-with-vision-transformers",
|
||||
"/image_classification_with_vision_transformers":
|
||||
"/guides/image-classification-with-vision-transformers",
|
||||
"/Gradio_and_Wandb_Integration": "/guides/Gradio-and-Wandb-Integration",
|
||||
"/image_classification_in_tensorflow": "/guides/image-classification-in-tensorflow"
|
||||
"/image_classification_in_tensorflow":
|
||||
"/guides/image-classification-in-tensorflow"
|
||||
};
|
||||
|
||||
@ -1 +1 @@
|
||||
{"version": "3.36.0"}
|
||||
{"version": "3.36.1"}
|
||||
Loading…
x
Reference in New Issue
Block a user