Gradio HTML Advanced Component
## Installation
```bash
pip install gradio_htmlplus
```
## Usage
```python
import gradio as gr
import pandas as pd
import numpy as np
import uuid
# Import the custom component and the HTML generator
from gradio_htmlplus import HTMLPlus
from leaderboard import generate_leaderboard_html
# Generate Mock Data
def create_mock_leaderboard_data(num_rows=15):
"""
Creates a pandas DataFrame with random data for the leaderboard demo.
Args:
num_rows (int): The number of rows to generate.
Returns:
pd.DataFrame: A DataFrame containing mock leaderboard data.
"""
data = {
'run_id': [str(uuid.uuid4()) for _ in range(num_rows)],
'model': [f'model-v{i}-{np.random.choice(["alpha", "beta", "gamma"])}' for i in range(num_rows)],
'agent_type': np.random.choice(['tool', 'code', 'both'], num_rows),
'provider': np.random.choice(['litellm', 'transformers'], num_rows),
'success_rate': np.random.uniform(40, 99.9, num_rows),
'total_tests': np.random.randint(50, 100, num_rows),
'avg_steps': np.random.uniform(3, 8, num_rows),
'avg_duration_ms': np.random.uniform(1500, 5000, num_rows),
'total_tokens': np.random.randint(10000, 50000, num_rows),
'total_cost_usd': np.random.uniform(0.01, 0.2, num_rows),
'co2_emissions_g': np.random.uniform(0.5, 5, num_rows),
'gpu_utilization_avg': [np.random.uniform(60, 95) if i % 2 == 0 else None for i in range(num_rows)],
'timestamp': pd.to_datetime(pd.Timestamp.now() - pd.to_timedelta(np.random.rand(num_rows), unit='D')),
'submitted_by': [f'user_{np.random.randint(1, 5)}' for _ in range(num_rows)],
}
df = pd.DataFrame(data)
df['successful_tests'] = (df['total_tests'] * (df['success_rate'] / 100)).astype(int)
df['failed_tests'] = df['total_tests'] - df['successful_tests']
return df
with gr.Blocks(css=".gradio-container { max-width: 95% !important; }") as demo:
gr.Markdown("# 🏆 Interactive Leaderboard with Action Buttons")
gr.Markdown("Click on any row in the table to view its complete data, or click a button for a specific action.")
# Create and display the initial table
leaderboard_df = create_mock_leaderboard_data(15)
leaderboard_html = generate_leaderboard_html(leaderboard_df)
html_table = HTMLPlus(
value=leaderboard_html,
# Define both the action button and the table row as selectable elements.
# The more specific selector should come first to ensure it's matched first.
selectable_elements=[".tm-action-button", "tr"]
)
clicked_data_output = gr.JSON(label="Selected Row Data")
action_log_output = gr.Textbox(label="Action Log", interactive=False)
def on_element_selected(evt: gr.SelectData):
"""
Handles select events from the HTMLPlus component. It differentiates actions
based on which CSS selector was matched (evt.index).
Args:
evt (gr.SelectData): The event data object, containing the matched
selector (`.index`) and the element's data
attributes (`.value`).
Returns:
tuple: A tuple of values to update the output components.
Uses gr.skip() to avoid updating a component.
"""
if evt.index == ".tm-action-button":
# This block handles clicks on the 'Delete' button.
action = evt.value.get('action')
run_id = evt.value.get('run-id') or "Unknown"
log_message = f"ACTION: Button '{action}' clicked for Run ID: {run_id[:8]}..."
# Update the log, but skip updating the JSON output.
return gr.skip(), log_message
elif evt.index == "tr":
# This block handles clicks on the table row itself.
data = evt.value
run_id = data.get('run-id') or "Unknown"
log_message = f"INFO: Row selected for Run ID: {run_id[:8]}..."
# The frontend sends all data attributes as strings.
# Convert numeric strings back to numbers for cleaner display.
numeric_keys = [
'success-rate', 'total-tests', 'avg-steps', 'avg-duration-ms',
'total-tokens', 'total-cost-usd', 'co2-emissions-g',
'gpu-utilization-avg', 'successful-tests', 'failed-tests'
]
for key in numeric_keys:
if key in data and data[key] not in ['None', None, '']:
try:
num_val = float(data[key])
if num_val.is_integer():
data[key] = int(num_val)
else:
data[key] = round(num_val, 4)
except (ValueError, TypeError):
pass # Leave as a string if conversion fails
# Update both the JSON output and the log.
return data, log_message
# A fallback for any unexpected event.
return gr.skip(), "Unknown action occurred."
# Connect the 'select' event to the callback function, mapping its
# return values to the two output components.
html_table.select(
fn=on_element_selected,
inputs=None,
outputs=[clicked_data_output, action_log_output]
)
if __name__ == "__main__":
demo.launch()
```
## `HTMLPlus`
### Initialization
| name | type | default | description |
|---|---|---|---|
value |
```python str | Callable | None ``` | None |
The HTMLPlus content to display. Only static HTMLPlus is rendered (e.g. no JavaScript. To render JavaScript, use the `js` or `head` parameters in the `Blocks` constructor). If a function is provided, the function will be called each time the app loads to set the initial value of this component. |
label |
```python str | I18nData | None ``` | None |
The label for this component. Is used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to. |
every |
```python Timer | float | None ``` | None |
Continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer. |
inputs |
```python Component | Sequence[Component] | set[Component] | None ``` | None |
Components that are used as inputs to calculate `value` if `value` is a function (has no effect otherwise). `value` is recalculated any time the inputs change. |
show_label |
```python bool ``` | False |
If True, the label will be displayed. If False, the label will be hidden. |
visible |
```python bool | Literal["hidden"] ``` | True |
If False, component will be hidden. If "hidden", component will be visually hidden and not take up space in the layout but still exist in the DOM |
elem_id |
```python str | None ``` | None |
An optional string that is assigned as the id of this component in the HTMLPlus DOM. Can be used for targeting CSS styles. |
elem_classes |
```python list[str] | str | None ``` | None |
An optional list of strings that are assigned as the classes of this component in the HTMLPlus DOM. Can be used for targeting CSS styles. |
render |
```python bool ``` | True |
If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later. |
key |
```python int | str | tuple[int | str, ...] | None ``` | None |
in a gr.render, Components with the same key across re-renders are treated as the same component, not a new component. Properties set in 'preserved_by_key' are not reset across a re-render. |
preserved_by_key |
```python list[str] | str | None ``` | "value" |
A list of parameters from this component's constructor. Inside a gr.render() function, if a component is re-rendered with the same key, these (and only these) parameters will be preserved in the UI (if they have been changed by the user or an event listener) instead of re-rendered based on the values provided during constructor. |
min_height |
```python int | None ``` | None |
The minimum height of the component, specified in pixels if a number is passed, or in CSS units if a string is passed. If HTMLPlus content exceeds the height, the component will expand to fit the content. |
max_height |
```python int | None ``` | None |
The maximum height of the component, specified in pixels if a number is passed, or in CSS units if a string is passed. If content exceeds the height, the component will scroll. |
container |
```python bool ``` | False |
If True, the HTMLPlus component will be displayed in a container. Default is False. |
padding |
```python bool ``` | True |
If True, the HTMLPlus component will have a certain padding (set by the `--block-padding` CSS variable) in all directions. Default is True. |
autoscroll |
```python bool ``` | False |
If True, will automatically scroll to the bottom of the component when the content changes, unless the user has scrolled up. If False, will not scroll to the bottom when the content changes. |
selectable_elements |
```python List[str] | None ``` | None |
A list of CSS selectors (e.g., ['tr', '.my-button']) for elements within the HTML that are selectable. When an element matching a selector is clicked, the `select` event is triggered. The event data will contain the selector that was matched and the data from the element. |