Fix value synchronisation issue in gr.Dataframe #10918

hannahblair · 2025-04-01T12:07:06Z

Description

remove clear_on_focus since that was never being used
added a save_cell_value function to the context
ensure that changes are saved when a cell is blurred with a handle_blur function
add a test for changes on blur
ensure we're using display_values
add an e2e test for cell blur
add an e2e test and story for display_values

gradio-pr-bot · 2025-04-01T12:07:57Z

🪼 branch checks and previews

•	Name	Status	URL
	Spaces	ready!	Spaces preview
	Website	ready!	Website preview
	Storybook	ready!	Storybook preview
🦄	Changes	detected!	Details

Install Gradio from this PR

pip install https://gradio-pypi-previews.s3.amazonaws.com/29573e2d179daef030326a140afabf49899bf83b/gradio-5.23.3-py3-none-any.whl

Install Gradio Python Client from this PR

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

Install Gradio JS Client from this PR

npm install https://gradio-npm-previews.s3.amazonaws.com/29573e2d179daef030326a140afabf49899bf83b/gradio-client-1.14.1.tgz

Use Lite from this PR

<script type="module" src="https://gradio-lite-previews.s3.amazonaws.com/29573e2d179daef030326a140afabf49899bf83b/dist/lite.js""></script>

gradio-pr-bot · 2025-04-01T12:08:16Z

🦄 change detected

This Pull Request includes changes to the following packages.

Package	Version
`@gradio/dataframe`	`patch`
`gradio`	`patch`

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

With the following changelog entry.

Fix value synchronisation issue in gr.Dataframe

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.

…c-issue-df

Copilot

Pull Request Overview

This pull request addresses a value synchronization issue in gr.Dataframe by removing redundant logic that may be causing input inconsistencies.

Removed the clear_on_focus property from the selection context and its associated assignments.
Updated the changeset to document the minor fix.

Reviewed Changes

Copilot reviewed 2 out of 5 changed files in this pull request and generated no comments.

File	Description
js/dataframe/shared/context/selection_context.ts	Removed the clear_on_focus property and its assignment to prevent redundant value clearing behavior.
.changeset/wet-rockets-bow.md	Updated the changeset to reflect a minor fix in gr.Dataframe value synchronization.

Files not reviewed (3)

js/dataframe/shared/EditableCell.svelte: Language not supported
js/dataframe/shared/Table.svelte: Language not supported
js/dataframe/shared/TableCell.svelte: Language not supported

abidlabs · 2025-04-01T14:16:26Z

I tested with demo/matrix_transpose/run.py and seeing an issue where updates I make via the UI are not captured as the value of the dataframe:

Screen.Recording.2025-04-01.at.7.15.35.AM.mov

hannahblair · 2025-04-01T15:54:57Z

@abidlabs hmm good catch

JPlin · 2025-04-02T10:12:24Z

Translation: I'm also encountering this issue. How can I apply the patched version of Gradio to start using it right away?

abidlabs · 2025-04-02T16:08:39Z

Not fixed yet @JPlin but if you have a repro we can test with and/or more details about your system and when you experience this issue, that'll be helpful

hannahblair · 2025-04-02T16:56:36Z

@JPlin I have a fix running locally - just doing some testing and will get it out as soon as possible!

- fix cell value saving logic

- add story and tests

hannahblair · 2025-04-04T12:31:39Z

So (apologies), this turned out to be a bit of a refactor, just because I found a few opportunities for cleanup in the process of fixing a couple issues. I have consolidated the three context files into one because in hindsight it just means a bit more cognitive overhead separating them. That is really the bulk of the changes (plus some redundant code removal), nothing major has changed here.

hannahblair · 2025-04-04T12:34:39Z

js/dataframe/shared/EditableCell.svelte

-		value = currentTarget.value;
-		dispatch("blur");
+	function handle_blur(event: FocusEvent): void {
+		dispatch("blur", {


dispatch blur event with coords of the cell to update the value of that cell

…c-issue-df

hannahblair · 2025-04-04T12:38:26Z

js/dataframe/shared/EditableCell.svelte

-			if (edit) {
-				value = _value;
-				dispatch("blur");
-			} else if (!header) {


don't need this logic, blur is handled in handle_keydown

hannahblair · 2025-04-04T12:44:04Z

js/dataframe/shared/context/dataframe_context.ts

@@ -0,0 +1,551 @@
+import { getContext, setContext } from "svelte";


new consolidated dataframe context file, nothing new here

hannahblair · 2025-04-04T12:44:25Z

js/dataframe/shared/selection_utils.ts

@@ -88,28 +88,6 @@ export function handle_delete_key(
 	return new_data;
 }

-export function handle_editing_state(


hannahblair · 2025-04-04T12:45:09Z

js/dataframe/shared/utils/keyboard_utils.ts

@@ -1,40 +1,82 @@
 import { dequal } from "dequal/lite";


all changes here are just using new context file

hannahblair · 2025-04-04T12:45:48Z

js/dataframe/test/sort_utils.test.ts

@@ -1,5 +1,9 @@
 import { describe, test, expect } from "vitest";


moved to a test dir

hannahblair · 2025-04-04T12:46:31Z

js/dataframe/shared/EditableCell.svelte

@@ -21,7 +21,6 @@
 		right: string;


removing clear_on_focus and adding blur event

hannahblair · 2025-04-04T12:49:38Z

js/dataframe/shared/Table.svelte

@@ -454,98 +468,34 @@
 		selected = result.selected;
 	}

-	$: sort_data(data, display_value, styling);


hannahblair · 2025-04-04T12:50:02Z

js/dataframe/shared/Table.svelte

@@ -738,6 +687,23 @@
 	$: handle_mouse_down = drag_handlers?.handle_mouse_down || (() => {});
 	$: handle_mouse_move = drag_handlers?.handle_mouse_move || (() => {});
 	$: handle_mouse_up = drag_handlers?.handle_mouse_up || (() => {});
+
+	function get_cell_display_value(row: number, col: number): string {


fixes display_value issue

hannahblair · 2025-04-04T12:50:29Z

js/dataframe/shared/TableCell.svelte

@@ -60,6 +65,7 @@
 	export let handle_select_column: (col: number) => void;
 	export let handle_select_row: (row: number) => void;
 	export let is_dragging: boolean;
+	export let display_value: string | undefined;


use display_value

abidlabs

Tested and works! Great PR @hannahblair

remove clear on focus

15b215a

add changeset

7a08fd6

hannahblair added 2 commits April 1, 2025 13:14

remove clear_on_focus

f3999dc

Merge branch 'sync-issue-df' of github.com:gradio-app/gradio into syn…

0ab1864

…c-issue-df

abidlabs added the v: patch A change that requires a patch release label Apr 1, 2025

abidlabs requested a review from Copilot April 1, 2025 14:12

Copilot AI reviewed Apr 1, 2025

View reviewed changes

add changeset

3570af2

hannahblair added 5 commits April 4, 2025 00:41

- merge context files

35f325a

- fix cell value saving logic

fix tests

866451c

- fix display value

6682023

- add story and tests

Merge branch 'main' into sync-issue-df

96bdf74

nb

99f2930

Merge branch 'main' into sync-issue-df

2e1ce36

hannahblair commented Apr 4, 2025

View reviewed changes

hannahblair added 2 commits April 4, 2025 13:37

tweak

32f7931

Merge branch 'sync-issue-df' of github.com:gradio-app/gradio into syn…

c2f9b00

…c-issue-df

hannahblair commented Apr 4, 2025

View reviewed changes

hannahblair added 2 commits April 4, 2025 13:41

redundant line

bc713d9

revert

244a1dc

hannahblair commented Apr 4, 2025

View reviewed changes

hannahblair and others added 6 commits April 4, 2025 14:07

revert markup change for testing

16446f9

fix test

4db10bb

add changeset

d635795

fix tests

34a3bed

Merge branch 'main' into sync-issue-df

46d7fcd

format

29573e2

abidlabs approved these changes Apr 4, 2025

View reviewed changes

hannahblair merged commit 36da6d0 into main Apr 5, 2025
23 checks passed

hannahblair deleted the sync-issue-df branch April 5, 2025 13:49

gradio-pr-bot mentioned this pull request Apr 4, 2025

chore: update versions #10931

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix value synchronisation issue in gr.Dataframe #10918

Fix value synchronisation issue in gr.Dataframe #10918

hannahblair commented Apr 1, 2025 •

edited

Loading

gradio-pr-bot commented Apr 1, 2025 •

edited

Loading

gradio-pr-bot commented Apr 1, 2025 •

edited

Loading

Something isn't right?

Copilot AI left a comment

abidlabs commented Apr 1, 2025

hannahblair commented Apr 1, 2025

JPlin commented Apr 2, 2025

abidlabs commented Apr 2, 2025

hannahblair commented Apr 2, 2025

hannahblair commented Apr 4, 2025 •

edited

Loading

hannahblair Apr 4, 2025

hannahblair Apr 4, 2025 •

edited

Loading

hannahblair Apr 4, 2025 •

edited

Loading

hannahblair Apr 4, 2025

hannahblair Apr 4, 2025

hannahblair Apr 4, 2025

hannahblair Apr 4, 2025

hannahblair Apr 4, 2025

hannahblair Apr 4, 2025

hannahblair Apr 4, 2025

abidlabs left a comment

		@@ -0,0 +1,551 @@
		import { getContext, setContext } from "svelte";

		@@ -1,5 +1,9 @@
		import { describe, test, expect } from "vitest";

Fix value synchronisation issue in gr.Dataframe #10918

Fix value synchronisation issue in gr.Dataframe #10918

Conversation

hannahblair commented Apr 1, 2025 • edited Loading

Description

gradio-pr-bot commented Apr 1, 2025 • edited Loading

🪼 branch checks and previews

gradio-pr-bot commented Apr 1, 2025 • edited Loading

🦄 change detected

This Pull Request includes changes to the following packages.

With the following changelog entry.

Something isn't right?

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

abidlabs commented Apr 1, 2025

hannahblair commented Apr 1, 2025

JPlin commented Apr 2, 2025

abidlabs commented Apr 2, 2025

hannahblair commented Apr 2, 2025

hannahblair commented Apr 4, 2025 • edited Loading

Choose a reason for hiding this comment

hannahblair Apr 4, 2025 • edited Loading

Choose a reason for hiding this comment

hannahblair Apr 4, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abidlabs left a comment

Choose a reason for hiding this comment

hannahblair commented Apr 1, 2025 •

edited

Loading

gradio-pr-bot commented Apr 1, 2025 •

edited

Loading

gradio-pr-bot commented Apr 1, 2025 •

edited

Loading

hannahblair commented Apr 4, 2025 •

edited

Loading

hannahblair Apr 4, 2025 •

edited

Loading

hannahblair Apr 4, 2025 •

edited

Loading