Skip to content

Commit 36da6d0

Browse files
authored
Fix value synchronisation issue in gr.Dataframe (gradio-app#10918)
1 parent 83c709a commit 36da6d0

20 files changed

+971
-1202
lines changed

.changeset/wet-rockets-bow.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"@gradio/dataframe": patch
3+
"gradio": patch
4+
---
5+
6+
fix:Fix value synchronisation issue in gr.Dataframe

demo/dataframe_events/run.ipynb

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"cells": [{"cell_type": "markdown", "id": "302934307671667531413257853548643485645", "metadata": {}, "source": ["# Gradio Demo: dataframe_events"]}, {"cell_type": "code", "execution_count": null, "id": "272996653310673477252411125948039410165", "metadata": {}, "outputs": [], "source": ["!pip install -q gradio "]}, {"cell_type": "code", "execution_count": null, "id": "288918539441861185822528903084949547379", "metadata": {}, "outputs": [], "source": ["import gradio as gr\n", "import pandas as pd\n", "import numpy as np\n", "\n", "def update_dataframe():\n", " regular_df = pd.DataFrame(np.random.randint(1, 10, size=(5, 5)), columns=pd.Index([str(i) for i in range(5)]))\n", " wide_df = pd.DataFrame([\n", " [5, 22, 91, 17, 73, 38, 84, 46, 65, 10, 155, 122, 11, 144, 133],\n", " [81, 42, 13, 97, 33, 77, 59, 100, 29, 61, 213, 195, 142, 118, 127],\n", " [37, 71, 63, 102, 28, 94, 19, 55, 88, 44, 116, 139, 122, 150, 147],\n", " [104, 52, 49, 26, 83, 67, 31, 92, 79, 18, 241, 115, 159, 123, 137],\n", " [16, 95, 74, 68, 43, 101, 27, 85, 39, 57, 129, 148, 132, 111, 156]\n", " ], columns=pd.Index([f\"col_{i}\" for i in range(15)]))\n", " tall_df = pd.DataFrame(np.random.randint(1, 10, size=(50, 3)), columns=pd.Index([\"A\", \"B\", \"C\"]))\n", " return regular_df, wide_df, tall_df\n", "\n", "def clear_dataframes():\n", " regular_empty_df = pd.DataFrame([], columns=pd.Index([str(i) for i in range(5)]))\n", " wide_empty_df = pd.DataFrame([], columns=pd.Index([f\"col_{i}\" for i in range(15)]))\n", " tall_empty_df = pd.DataFrame([], columns=pd.Index([\"A\", \"B\", \"C\"]))\n", " return regular_empty_df, wide_empty_df, tall_empty_df\n", "\n", "def increment_select_counter(evt: gr.SelectData, count):\n", " count_val = 1 if count is None else count + 1\n", " return count_val, evt.index, evt.value\n", "\n", "with gr.Blocks() as demo:\n", " with gr.Row():\n", " with gr.Column(scale=1):\n", " initial_regular_df = pd.DataFrame(np.zeros((5, 5), dtype=int), columns=pd.Index([str(i) for i in range(5)]))\n", "\n", " df = gr.Dataframe(\n", " value=initial_regular_df,\n", " interactive=True,\n", " label=\"Interactive Dataframe\",\n", " show_label=True,\n", " elem_id=\"dataframe\",\n", " show_search=\"filter\",\n", " show_copy_button=True,\n", " show_row_numbers=True,\n", " static_columns=[4]\n", " )\n", "\n", " with gr.Column(scale=1):\n", " initial_wide_df = pd.DataFrame(np.zeros((5, 15), dtype=int), columns=pd.Index([f\"col_{i}\" for i in range(15)]))\n", "\n", " df_view = gr.Dataframe(\n", " value=initial_wide_df,\n", " interactive=False,\n", " label=\"Non-Interactive View (Scroll Horizontally)\",\n", " show_label=True,\n", " show_search=\"search\",\n", " elem_id=\"non-interactive-dataframe\",\n", " show_copy_button=True,\n", " show_row_numbers=True,\n", " show_fullscreen_button=True,\n", " )\n", "\n", " with gr.Row():\n", " initial_tall_df = pd.DataFrame(np.zeros((50, 3), dtype=int), columns=pd.Index([\"A\", \"B\", \"C\"]))\n", "\n", " df_tall = gr.Dataframe(\n", " value=initial_tall_df,\n", " interactive=False,\n", " label=\"Tall Dataframe (Scroll Vertically)\",\n", " show_label=True,\n", " elem_id=\"dataframe_tall\",\n", " show_copy_button=True,\n", " show_row_numbers=True,\n", " max_height=300,\n", " )\n", "\n", " with gr.Row():\n", " with gr.Column():\n", " update_btn = gr.Button(\"Update dataframe\", elem_id=\"update_btn\")\n", " clear_btn = gr.Button(\"Clear dataframe\", elem_id=\"clear_btn\")\n", "\n", " with gr.Row():\n", " change_events = gr.Number(\n", " value=0, label=\"Change events\", elem_id=\"change_events\"\n", " )\n", " input_events = gr.Number(value=0, label=\"Input events\", elem_id=\"input_events\")\n", " select_events = gr.Number(\n", " value=0, label=\"Select events\", elem_id=\"select_events\"\n", " )\n", "\n", " with gr.Row():\n", " selected_cell_index = gr.Textbox(\n", " label=\"Selected cell index\", elem_id=\"selected_cell_index\"\n", " )\n", " selected_cell_value = gr.Textbox(\n", " label=\"Selected cell value\", elem_id=\"selected_cell_value\"\n", " )\n", "\n", " update_btn.click(fn=update_dataframe, outputs=[df, df_view, df_tall])\n", " clear_btn.click(fn=clear_dataframes, outputs=[df, df_view, df_tall])\n", " df.change(fn=lambda x: x + 1, inputs=[change_events], outputs=[change_events])\n", " df.input(fn=lambda x: x + 1, inputs=[input_events], outputs=[input_events])\n", " df.select(\n", " fn=increment_select_counter,\n", " inputs=[select_events],\n", " outputs=[select_events, selected_cell_index, selected_cell_value],\n", " )\n", "\n", "if __name__ == \"__main__\":\n", " demo.launch()\n"]}], "metadata": {}, "nbformat": 4, "nbformat_minor": 5}
1+
{"cells": [{"cell_type": "markdown", "id": "302934307671667531413257853548643485645", "metadata": {}, "source": ["# Gradio Demo: dataframe_events"]}, {"cell_type": "code", "execution_count": null, "id": "272996653310673477252411125948039410165", "metadata": {}, "outputs": [], "source": ["!pip install -q gradio "]}, {"cell_type": "code", "execution_count": null, "id": "288918539441861185822528903084949547379", "metadata": {}, "outputs": [], "source": ["import gradio as gr\n", "import pandas as pd\n", "import numpy as np\n", "\n", "def update_dataframe():\n", " regular_df = pd.DataFrame(np.random.randint(1, 10, size=(5, 5)), columns=pd.Index([str(i) for i in range(5)]))\n", " wide_df = pd.DataFrame([\n", " [5, 22, 91, 17, 73, 38, 84, 46, 65, 10, 155, 122, 11, 144, 133],\n", " [81, 42, 13, 97, 33, 77, 59, 100, 29, 61, 213, 195, 142, 118, 127],\n", " [37, 71, 63, 102, 28, 94, 19, 55, 88, 44, 116, 139, 122, 150, 147],\n", " [104, 52, 49, 26, 83, 67, 31, 92, 79, 18, 241, 115, 159, 123, 137],\n", " [16, 95, 74, 68, 43, 101, 27, 85, 39, 57, 129, 148, 132, 111, 156]\n", " ], columns=pd.Index([f\"col_{i}\" for i in range(15)]))\n", " return regular_df, wide_df\n", "\n", "def clear_dataframes():\n", " regular_empty_df = pd.DataFrame([], columns=pd.Index([str(i) for i in range(5)]))\n", " wide_empty_df = pd.DataFrame([], columns=pd.Index([f\"col_{i}\" for i in range(15)]))\n", " return regular_empty_df, wide_empty_df\n", "\n", "def increment_select_counter(evt: gr.SelectData, count):\n", " count_val = 1 if count is None else count + 1\n", " return count_val, evt.index, evt.value\n", "\n", "with gr.Blocks() as demo:\n", " with gr.Row():\n", " with gr.Column(scale=1):\n", " initial_regular_df = pd.DataFrame(np.zeros((5, 5), dtype=int), columns=pd.Index([str(i) for i in range(5)]))\n", "\n", " df = gr.Dataframe(\n", " value=initial_regular_df,\n", " interactive=True,\n", " label=\"Interactive Dataframe\",\n", " show_label=True,\n", " elem_id=\"dataframe\",\n", " show_search=\"filter\",\n", " show_copy_button=True,\n", " show_row_numbers=True,\n", " static_columns=[4]\n", " )\n", "\n", " with gr.Column(scale=1):\n", " initial_wide_df = pd.DataFrame(np.zeros((5, 15), dtype=int), columns=pd.Index([f\"col_{i}\" for i in range(15)]))\n", "\n", " df_view = gr.Dataframe(\n", " value=initial_wide_df,\n", " interactive=False,\n", " label=\"Non-Interactive View (Scroll Horizontally)\",\n", " show_label=True,\n", " show_search=\"search\",\n", " elem_id=\"non-interactive-dataframe\",\n", " show_copy_button=True,\n", " show_row_numbers=True,\n", " show_fullscreen_button=True,\n", " )\n", "\n", " tall_df_value = [\n", " [\"DeepSeek Coder\", 79.3],\n", " [\"Llama 3.3\", 68.9],\n", " [\"Qwen 2.5\", 61.9],\n", " [\"Gemma 2\", 59.5],\n", " [\"GPT 2\", 18.3],\n", " ]\n", "\n", " def get_display_value(values):\n", " display_values = []\n", " medals = [\"\ud83e\udd47\", \"\ud83e\udd48\", \"\ud83e\udd49\"]\n", " for i, row in enumerate(values):\n", " if i < 3:\n", " display_values.append([f\"{medals[i]} {row[0]}\", row[1]])\n", " else:\n", " display_values.append([row[0], row[1]])\n", " return display_values\n", "\n", " display_value = get_display_value(tall_df_value)\n", "\n", " tall_df_value = {\n", " \"data\": tall_df_value,\n", " \"headers\": [\"Model\", \"% Correct (LeetCode Hard)\"],\n", " \"metadata\": {\n", " \"display_value\": display_value\n", " }\n", " }\n", "\n", " with gr.Row():\n", " df_tall = gr.Dataframe(\n", " value=tall_df_value,\n", " interactive=False,\n", " label=\"Tall Dataframe (Scroll Vertically)\",\n", " show_label=True,\n", " elem_id=\"dataframe_tall\",\n", " show_copy_button=True,\n", " show_row_numbers=True,\n", " max_height=300,\n", " )\n", "\n", " with gr.Row():\n", " with gr.Column():\n", " update_btn = gr.Button(\"Update dataframe\", elem_id=\"update_btn\")\n", " clear_btn = gr.Button(\"Clear dataframe\", elem_id=\"clear_btn\")\n", "\n", " with gr.Row():\n", " change_events = gr.Number(\n", " value=0, label=\"Change events\", elem_id=\"change_events\"\n", " )\n", " input_events = gr.Number(value=0, label=\"Input events\", elem_id=\"input_events\")\n", " select_events = gr.Number(\n", " value=0, label=\"Select events\", elem_id=\"select_events\"\n", " )\n", "\n", " with gr.Row():\n", " selected_cell_index = gr.Textbox(\n", " label=\"Selected cell index\", elem_id=\"selected_cell_index\"\n", " )\n", " selected_cell_value = gr.Textbox(\n", " label=\"Selected cell value\", elem_id=\"selected_cell_value\"\n", " )\n", "\n", " update_btn.click(fn=update_dataframe, outputs=[df, df_view])\n", " clear_btn.click(fn=clear_dataframes, outputs=[df, df_view, df_tall])\n", " df.change(fn=lambda x: x + 1, inputs=[change_events], outputs=[change_events])\n", " df.input(fn=lambda x: x + 1, inputs=[input_events], outputs=[input_events])\n", " df.select(\n", " fn=increment_select_counter,\n", " inputs=[select_events],\n", " outputs=[select_events, selected_cell_index, selected_cell_value],\n", " )\n", "\n", "if __name__ == \"__main__\":\n", " demo.launch()\n"]}], "metadata": {}, "nbformat": 4, "nbformat_minor": 5}

demo/dataframe_events/run.py

+32-8
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,12 @@ def update_dataframe():
1111
[104, 52, 49, 26, 83, 67, 31, 92, 79, 18, 241, 115, 159, 123, 137],
1212
[16, 95, 74, 68, 43, 101, 27, 85, 39, 57, 129, 148, 132, 111, 156]
1313
], columns=pd.Index([f"col_{i}" for i in range(15)]))
14-
tall_df = pd.DataFrame(np.random.randint(1, 10, size=(50, 3)), columns=pd.Index(["A", "B", "C"]))
15-
return regular_df, wide_df, tall_df
14+
return regular_df, wide_df
1615

1716
def clear_dataframes():
1817
regular_empty_df = pd.DataFrame([], columns=pd.Index([str(i) for i in range(5)]))
1918
wide_empty_df = pd.DataFrame([], columns=pd.Index([f"col_{i}" for i in range(15)]))
20-
tall_empty_df = pd.DataFrame([], columns=pd.Index(["A", "B", "C"]))
21-
return regular_empty_df, wide_empty_df, tall_empty_df
19+
return regular_empty_df, wide_empty_df
2220

2321
def increment_select_counter(evt: gr.SelectData, count):
2422
count_val = 1 if count is None else count + 1
@@ -56,11 +54,37 @@ def increment_select_counter(evt: gr.SelectData, count):
5654
show_fullscreen_button=True,
5755
)
5856

59-
with gr.Row():
60-
initial_tall_df = pd.DataFrame(np.zeros((50, 3), dtype=int), columns=pd.Index(["A", "B", "C"]))
57+
tall_df_value = [
58+
["DeepSeek Coder", 79.3],
59+
["Llama 3.3", 68.9],
60+
["Qwen 2.5", 61.9],
61+
["Gemma 2", 59.5],
62+
["GPT 2", 18.3],
63+
]
64+
65+
def get_display_value(values):
66+
display_values = []
67+
medals = ["🥇", "🥈", "🥉"]
68+
for i, row in enumerate(values):
69+
if i < 3:
70+
display_values.append([f"{medals[i]} {row[0]}", row[1]])
71+
else:
72+
display_values.append([row[0], row[1]])
73+
return display_values
74+
75+
display_value = get_display_value(tall_df_value)
6176

77+
tall_df_value = {
78+
"data": tall_df_value,
79+
"headers": ["Model", "% Correct (LeetCode Hard)"],
80+
"metadata": {
81+
"display_value": display_value
82+
}
83+
}
84+
85+
with gr.Row():
6286
df_tall = gr.Dataframe(
63-
value=initial_tall_df,
87+
value=tall_df_value,
6488
interactive=False,
6589
label="Tall Dataframe (Scroll Vertically)",
6690
show_label=True,
@@ -92,7 +116,7 @@ def increment_select_counter(evt: gr.SelectData, count):
92116
label="Selected cell value", elem_id="selected_cell_value"
93117
)
94118

95-
update_btn.click(fn=update_dataframe, outputs=[df, df_view, df_tall])
119+
update_btn.click(fn=update_dataframe, outputs=[df, df_view])
96120
clear_btn.click(fn=clear_dataframes, outputs=[df, df_view, df_tall])
97121
df.change(fn=lambda x: x + 1, inputs=[change_events], outputs=[change_events])
98122
df.input(fn=lambda x: x + 1, inputs=[input_events], outputs=[input_events])

js/dataframe/Dataframe.stories.svelte

+28
Original file line numberDiff line numberDiff line change
@@ -751,6 +751,34 @@
751751
}}
752752
/>
753753

754+
<Story
755+
name="Dataframe with display values"
756+
args={{
757+
values: [
758+
[95, 92, 88],
759+
[89, 90, 85],
760+
[92, 88, 91],
761+
[87, 85, 89],
762+
[91, 93, 90],
763+
[82, 81, 83]
764+
],
765+
headers: ["Model A", "Model B", "Model C"],
766+
display_value: [
767+
["🥇 95", "92", "88"],
768+
["🥈 89", "90", "85"],
769+
["🥉 92", "88", "91"],
770+
["87", "85", "89"],
771+
["91", "93", "90"],
772+
["82", "81", "83"]
773+
],
774+
label: "Model Performance with Medal Indicators",
775+
col_count: [3, "dynamic"],
776+
row_count: [6, "dynamic"],
777+
show_row_numbers: true,
778+
editable: false
779+
}}
780+
/>
781+
754782
<Story
755783
name="Dataframe with text wrapping, no max chars"
756784
args={{

js/dataframe/shared/CellMenu.svelte

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
import { onMount } from "svelte";
33
import CellMenuIcons from "./CellMenuIcons.svelte";
44
import type { I18nFormatter } from "js/utils/src";
5-
import type { SortDirection } from "./context/table_context";
5+
import type { SortDirection } from "./context/dataframe_context";
66
77
export let x: number;
88
export let y: number;

js/dataframe/shared/EditableCell.svelte

+9-20
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
right: string;
2222
display: boolean;
2323
}[];
24-
export let clear_on_focus = false;
2524
export let line_breaks = true;
2625
export let editable = true;
2726
export let is_static = false;
@@ -33,19 +32,18 @@
3332
export let wrap_text = false;
3433
3534
export let show_selection_buttons = false;
36-
export let coords: [number, number] | null = null;
35+
export let coords: [number, number];
3736
export let on_select_column: ((col: number) => void) | null = null;
3837
export let on_select_row: ((row: number) => void) | null = null;
3938
4039
const dispatch = createEventDispatcher<{
41-
blur: void;
40+
blur: { blur_event: FocusEvent; coords: [number, number] };
4241
keydown: KeyboardEvent;
4342
}>();
4443
4544
let is_expanded = false;
4645
4746
export let el: HTMLInputElement | null;
48-
$: _value = value;
4947
5048
function truncate_text(
5149
text: string | number,
@@ -73,32 +71,23 @@
7371
: display_content;
7472
7573
function use_focus(node: HTMLInputElement): any {
76-
if (clear_on_focus) {
77-
_value = "";
78-
}
79-
8074
requestAnimationFrame(() => {
8175
node.focus();
8276
});
8377
8478
return {};
8579
}
8680
87-
function handle_blur({
88-
currentTarget
89-
}: Event & {
90-
currentTarget: HTMLInputElement;
91-
}): void {
92-
value = currentTarget.value;
93-
dispatch("blur");
81+
function handle_blur(event: FocusEvent): void {
82+
dispatch("blur", {
83+
blur_event: event,
84+
coords: coords
85+
});
9486
}
9587
9688
function handle_keydown(event: KeyboardEvent): void {
9789
if (event.key === "Enter") {
98-
if (edit) {
99-
value = _value;
100-
dispatch("blur");
101-
} else if (!header) {
90+
if (!header) {
10291
is_expanded = !is_expanded;
10392
}
10493
}
@@ -119,7 +108,7 @@
119108
role="textbox"
120109
aria-label={is_static ? "Cell is read-only" : "Edit cell"}
121110
bind:this={el}
122-
bind:value={_value}
111+
bind:value
123112
class:header
124113
tabindex="-1"
125114
on:blur={handle_blur}

0 commit comments

Comments
 (0)