@gradio/dataframe 0.14.0 → 0.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/CHANGELOG.md +45 -0
  2. package/Dataframe.stories.svelte +283 -7
  3. package/Index.svelte +22 -3
  4. package/dist/Index.svelte +18 -4
  5. package/dist/Index.svelte.d.ts +16 -0
  6. package/dist/shared/EditableCell.svelte +49 -7
  7. package/dist/shared/EditableCell.svelte.d.ts +1 -1
  8. package/dist/shared/Table.svelte +692 -411
  9. package/dist/shared/Table.svelte.d.ts +4 -0
  10. package/dist/shared/Toolbar.svelte +122 -30
  11. package/dist/shared/Toolbar.svelte.d.ts +4 -0
  12. package/dist/shared/VirtualTable.svelte +70 -26
  13. package/dist/shared/VirtualTable.svelte.d.ts +1 -0
  14. package/dist/shared/icons/FilterIcon.svelte +11 -0
  15. package/dist/shared/icons/FilterIcon.svelte.d.ts +16 -0
  16. package/dist/shared/icons/SortIcon.svelte +90 -0
  17. package/dist/shared/icons/SortIcon.svelte.d.ts +20 -0
  18. package/dist/shared/selection_utils.d.ts +30 -0
  19. package/dist/shared/selection_utils.js +139 -0
  20. package/dist/shared/types.d.ts +18 -0
  21. package/dist/shared/types.js +2 -0
  22. package/dist/shared/utils/menu_utils.d.ts +42 -0
  23. package/dist/shared/utils/menu_utils.js +58 -0
  24. package/dist/shared/utils/sort_utils.d.ts +7 -0
  25. package/dist/shared/utils/sort_utils.js +39 -0
  26. package/dist/shared/utils/table_utils.d.ts +12 -0
  27. package/dist/shared/utils/table_utils.js +148 -0
  28. package/package.json +8 -8
  29. package/shared/EditableCell.svelte +55 -7
  30. package/shared/Table.svelte +762 -478
  31. package/shared/Toolbar.svelte +125 -30
  32. package/shared/VirtualTable.svelte +73 -26
  33. package/shared/icons/FilterIcon.svelte +12 -0
  34. package/shared/icons/SortIcon.svelte +95 -0
  35. package/shared/selection_utils.ts +230 -0
  36. package/shared/types.ts +29 -0
  37. package/shared/utils/menu_utils.ts +115 -0
  38. package/shared/utils/sort_utils.test.ts +71 -0
  39. package/shared/utils/sort_utils.ts +55 -0
  40. package/shared/utils/table_utils.test.ts +114 -0
  41. package/shared/utils/table_utils.ts +206 -0
  42. package/dist/shared/table_utils.d.ts +0 -6
  43. package/dist/shared/table_utils.js +0 -27
  44. package/shared/table_utils.ts +0 -38
@@ -0,0 +1,115 @@
1
+ export function toggle_header_menu(
2
+ event: MouseEvent,
3
+ col: number,
4
+ active_header_menu: { col: number; x: number; y: number } | null,
5
+ set_active_header_menu: (
6
+ menu: { col: number; x: number; y: number } | null
7
+ ) => void
8
+ ): void {
9
+ event.stopPropagation();
10
+ if (active_header_menu && active_header_menu.col === col) {
11
+ set_active_header_menu(null);
12
+ } else {
13
+ const header = (event.target as HTMLElement).closest("th");
14
+ if (header) {
15
+ const rect = header.getBoundingClientRect();
16
+ set_active_header_menu({ col, x: rect.right, y: rect.bottom });
17
+ }
18
+ }
19
+ }
20
+
21
+ export function toggle_cell_menu(
22
+ event: MouseEvent,
23
+ row: number,
24
+ col: number,
25
+ active_cell_menu: { row: number; col: number; x: number; y: number } | null,
26
+ set_active_cell_menu: (
27
+ menu: { row: number; col: number; x: number; y: number } | null
28
+ ) => void
29
+ ): void {
30
+ event.stopPropagation();
31
+ if (
32
+ active_cell_menu &&
33
+ active_cell_menu.row === row &&
34
+ active_cell_menu.col === col
35
+ ) {
36
+ set_active_cell_menu(null);
37
+ } else {
38
+ const cell = (event.target as HTMLElement).closest("td");
39
+ if (cell) {
40
+ const rect = cell.getBoundingClientRect();
41
+ set_active_cell_menu({ row, col, x: rect.right, y: rect.bottom });
42
+ }
43
+ }
44
+ }
45
+
46
+ export function add_row_at(
47
+ index: number,
48
+ position: "above" | "below",
49
+ add_row: (index?: number) => void,
50
+ clear_menus: () => void
51
+ ): void {
52
+ const row_index = position === "above" ? index : index + 1;
53
+ add_row(row_index);
54
+ clear_menus();
55
+ }
56
+
57
+ export function add_col_at(
58
+ index: number,
59
+ position: "left" | "right",
60
+ add_col: (index?: number) => void,
61
+ clear_menus: () => void
62
+ ): void {
63
+ const col_index = position === "left" ? index : index + 1;
64
+ add_col(col_index);
65
+ clear_menus();
66
+ }
67
+
68
+ export function delete_row_at(
69
+ index: number,
70
+ delete_row: (index: number) => void,
71
+ clear_menus: () => void
72
+ ): void {
73
+ delete_row(index);
74
+ clear_menus();
75
+ }
76
+
77
+ export function delete_col_at(
78
+ index: number,
79
+ delete_col: (index: number) => void,
80
+ clear_menus: () => void
81
+ ): void {
82
+ delete_col(index);
83
+ clear_menus();
84
+ }
85
+
86
+ export function toggle_header_button(
87
+ col: number,
88
+ active_button: { type: "header" | "cell"; row?: number; col: number } | null,
89
+ set_active_button: (
90
+ button: { type: "header" | "cell"; row?: number; col: number } | null
91
+ ) => void
92
+ ): void {
93
+ set_active_button(
94
+ active_button?.type === "header" && active_button.col === col
95
+ ? null
96
+ : { type: "header", col }
97
+ );
98
+ }
99
+
100
+ export function toggle_cell_button(
101
+ row: number,
102
+ col: number,
103
+ active_button: { type: "header" | "cell"; row?: number; col: number } | null,
104
+ set_active_button: (
105
+ button: { type: "header" | "cell"; row?: number; col: number } | null
106
+ ) => void
107
+ ): void {
108
+ set_active_button(
109
+ active_button?.type === "cell" &&
110
+ active_button.row === row &&
111
+ active_button.col === col
112
+ ? null
113
+ : { type: "cell", row, col }
114
+ );
115
+ }
@@ -0,0 +1,71 @@
1
+ import { describe, test, expect } from "vitest";
2
+ import { get_sort_status, sort_data } from "./sort_utils";
3
+
4
+ describe("sort_utils", () => {
5
+ describe("get_sort_status", () => {
6
+ const headers = ["A", "B", "C"];
7
+
8
+ test("returns none when no sort is active", () => {
9
+ expect(get_sort_status("A", undefined, undefined, headers)).toBe("none");
10
+ });
11
+
12
+ test("returns ascending when column is sorted ascending", () => {
13
+ expect(get_sort_status("A", 0, "asc", headers)).toBe("ascending");
14
+ });
15
+
16
+ test("returns descending when column is sorted descending", () => {
17
+ expect(get_sort_status("B", 1, "des", headers)).toBe("descending");
18
+ });
19
+
20
+ test("returns none for non-matching column", () => {
21
+ expect(get_sort_status("A", 1, "asc", headers)).toBe("none");
22
+ });
23
+ });
24
+
25
+ describe("sort_data", () => {
26
+ const data = [
27
+ [
28
+ { id: "1", value: "B" },
29
+ { id: "2", value: 2 }
30
+ ],
31
+ [
32
+ { id: "3", value: "A" },
33
+ { id: "4", value: 1 }
34
+ ],
35
+ [
36
+ { id: "5", value: "C" },
37
+ { id: "6", value: 3 }
38
+ ]
39
+ ];
40
+
41
+ test("sorts strings ascending", () => {
42
+ const indices = sort_data(data, 0, "asc");
43
+ expect(indices).toEqual([1, 0, 2]); // A, B, C
44
+ });
45
+
46
+ test("sorts numbers ascending", () => {
47
+ const indices = sort_data(data, 1, "asc");
48
+ expect(indices).toEqual([1, 0, 2]); // 1, 2, 3
49
+ });
50
+
51
+ test("sorts strings descending", () => {
52
+ const indices = sort_data(data, 0, "des");
53
+ expect(indices).toEqual([2, 0, 1]); // C, B, A
54
+ });
55
+
56
+ test("returns original order when sort params are invalid", () => {
57
+ const indices = sort_data(data, undefined, undefined);
58
+ expect(indices).toEqual([0, 1, 2]);
59
+ });
60
+
61
+ test("handles empty data", () => {
62
+ const indices = sort_data([], 0, "asc");
63
+ expect(indices).toEqual([]);
64
+ });
65
+
66
+ test("handles invalid column index", () => {
67
+ const indices = sort_data(data, 999, "asc");
68
+ expect(indices).toEqual([0, 1, 2]);
69
+ });
70
+ });
71
+ });
@@ -0,0 +1,55 @@
1
+ import type { Headers } from "../types";
2
+
3
+ export type SortDirection = "asc" | "des";
4
+
5
+ export function get_sort_status(
6
+ name: string,
7
+ sort_by: number | undefined,
8
+ direction: SortDirection | undefined,
9
+ headers: Headers
10
+ ): "none" | "ascending" | "descending" {
11
+ if (typeof sort_by !== "number") return "none";
12
+ if (sort_by < 0 || sort_by >= headers.length) return "none";
13
+ if (headers[sort_by] === name) {
14
+ if (direction === "asc") return "ascending";
15
+ if (direction === "des") return "descending";
16
+ }
17
+ return "none";
18
+ }
19
+
20
+ export function sort_data(
21
+ data: { id: string; value: string | number }[][],
22
+ sort_by: number | undefined,
23
+ sort_direction: SortDirection | undefined
24
+ ): number[] {
25
+ if (!data || !data.length || !data[0]) {
26
+ return [];
27
+ }
28
+
29
+ if (
30
+ typeof sort_by === "number" &&
31
+ sort_direction &&
32
+ sort_by >= 0 &&
33
+ sort_by < data[0].length
34
+ ) {
35
+ const row_indices = [...Array(data.length)].map((_, i) => i);
36
+ row_indices.sort((row_a_idx, row_b_idx) => {
37
+ const row_a = data[row_a_idx];
38
+ const row_b = data[row_b_idx];
39
+ if (
40
+ !row_a ||
41
+ !row_b ||
42
+ sort_by >= row_a.length ||
43
+ sort_by >= row_b.length
44
+ )
45
+ return 0;
46
+
47
+ const val_a = row_a[sort_by].value;
48
+ const val_b = row_b[sort_by].value;
49
+ const comparison = val_a < val_b ? -1 : val_a > val_b ? 1 : 0;
50
+ return sort_direction === "asc" ? comparison : -comparison;
51
+ });
52
+ return row_indices;
53
+ }
54
+ return [...Array(data.length)].map((_, i) => i);
55
+ }
@@ -0,0 +1,114 @@
1
+ import { describe, test, expect } from "vitest";
2
+ import {
3
+ make_cell_id,
4
+ make_header_id,
5
+ process_data,
6
+ make_headers
7
+ } from "./table_utils";
8
+
9
+ describe("table_utils", () => {
10
+ describe("id generation", () => {
11
+ test("generates unique cell ids", () => {
12
+ const id_set = new Set();
13
+ for (let row = 0; row < 10; row++) {
14
+ for (let col = 0; col < 10; col++) {
15
+ id_set.add(make_cell_id(row, col));
16
+ }
17
+ }
18
+ expect(id_set.size).toBe(100);
19
+ });
20
+
21
+ test("generates unique header ids", () => {
22
+ const id_set = new Set();
23
+ for (let col = 0; col < 10; col++) {
24
+ id_set.add(make_header_id(col));
25
+ }
26
+ expect(id_set.size).toBe(10);
27
+ });
28
+ });
29
+
30
+ describe("process_data", () => {
31
+ const element_refs: Record<string, { cell: null; input: null }> = {};
32
+ const data_binding: Record<string, { value: string | number; id: string }> =
33
+ {};
34
+
35
+ test("processes data with row numbers", () => {
36
+ const test_result = process_data(
37
+ [
38
+ ["1", "2"],
39
+ ["3", "4"]
40
+ ],
41
+ [2, "fixed"],
42
+ [2, "fixed"],
43
+ ["A", "B"],
44
+ true,
45
+ element_refs,
46
+ data_binding
47
+ );
48
+
49
+ expect(test_result[0].map((item) => item.value)).toEqual(["1", "2"]);
50
+ expect(test_result).toHaveLength(2);
51
+ });
52
+
53
+ test("processes data without row numbers", () => {
54
+ const test_result = process_data(
55
+ [
56
+ ["1", "2"],
57
+ ["3", "4"]
58
+ ],
59
+ [2, "fixed"],
60
+ [2, "fixed"],
61
+ ["A", "B"],
62
+ false,
63
+ element_refs,
64
+ data_binding
65
+ );
66
+
67
+ expect(test_result.length).toBe(2);
68
+ expect(test_result[0].length).toBe(2);
69
+ expect(test_result[0][0].value).toBe("1");
70
+ expect(test_result[0][1].value).toBe("2");
71
+ });
72
+
73
+ test("handles empty data", () => {
74
+ const test_result = process_data(
75
+ [],
76
+ [0, "dynamic"],
77
+ [0, "dynamic"],
78
+ [],
79
+ false,
80
+ element_refs,
81
+ data_binding
82
+ );
83
+
84
+ expect(test_result.length).toBe(0);
85
+ });
86
+ });
87
+
88
+ describe("make_headers", () => {
89
+ const element_refs: Record<string, { cell: null; input: null }> = {};
90
+
91
+ test("adds empty column for row numbers", () => {
92
+ const test_result = make_headers(
93
+ ["A", "B"],
94
+ true,
95
+ [2, "fixed"],
96
+ element_refs
97
+ );
98
+
99
+ expect(test_result.length).toBe(3);
100
+ expect(test_result[0].value).toBe("");
101
+ expect(test_result[1].value).toBe("A");
102
+ expect(test_result[2].value).toBe("B");
103
+ });
104
+
105
+ test("handles empty headers with fixed columns", () => {
106
+ const test_result = make_headers([], false, [3, "fixed"], element_refs);
107
+
108
+ expect(test_result.length).toBe(3);
109
+ expect(
110
+ test_result.every((header) => typeof header.value === "string")
111
+ ).toBe(true);
112
+ });
113
+ });
114
+ });
@@ -0,0 +1,206 @@
1
+ import type {
2
+ Headers,
3
+ HeadersWithIDs,
4
+ TableCell,
5
+ TableData,
6
+ CountConfig,
7
+ ElementRefs,
8
+ DataBinding
9
+ } from "../types";
10
+ import { sort_data } from "./sort_utils";
11
+ import type { SortDirection } from "./sort_utils";
12
+ import { dsvFormat } from "d3-dsv";
13
+
14
+ export function make_cell_id(row: number, col: number): string {
15
+ return `cell-${row}-${col}`;
16
+ }
17
+
18
+ export function make_header_id(col: number): string {
19
+ return `header-${col}`;
20
+ }
21
+
22
+ export function process_data(
23
+ input_values: (string | number)[][],
24
+ row_count: CountConfig,
25
+ col_count: CountConfig,
26
+ headers: Headers,
27
+ show_row_numbers: boolean,
28
+ element_refs: ElementRefs,
29
+ data_binding: DataBinding
30
+ ): TableData {
31
+ const data_row_length = input_values.length;
32
+ return Array(row_count[1] === "fixed" ? row_count[0] : data_row_length)
33
+ .fill(0)
34
+ .map((_, row) => {
35
+ return Array(
36
+ col_count[1] === "fixed"
37
+ ? col_count[0]
38
+ : data_row_length > 0
39
+ ? input_values[0].length
40
+ : headers.length
41
+ )
42
+ .fill(0)
43
+ .map((_, col) => {
44
+ const cell_id = make_cell_id(row, col);
45
+ element_refs[cell_id] = element_refs[cell_id] || {
46
+ input: null,
47
+ cell: null
48
+ };
49
+ const cell_obj: TableCell = {
50
+ value: input_values?.[row]?.[col] ?? "",
51
+ id: cell_id
52
+ };
53
+ data_binding[cell_id] = cell_obj;
54
+ return cell_obj;
55
+ });
56
+ });
57
+ }
58
+
59
+ export function make_headers(
60
+ input_headers: Headers,
61
+ show_row_numbers: boolean,
62
+ col_count: CountConfig,
63
+ element_refs: ElementRefs
64
+ ): HeadersWithIDs[] {
65
+ let header_list = input_headers || [];
66
+ if (show_row_numbers) {
67
+ header_list = ["", ...header_list];
68
+ }
69
+ if (col_count[1] === "fixed" && header_list.length < col_count[0]) {
70
+ const fill_headers = Array(col_count[0] - header_list.length)
71
+ .fill("")
72
+ .map((_, i) => `${i + header_list.length}`);
73
+ header_list = header_list.concat(fill_headers);
74
+ }
75
+
76
+ if (!header_list || header_list.length === 0) {
77
+ return Array(col_count[0])
78
+ .fill(0)
79
+ .map((_, col) => {
80
+ const header_id = make_header_id(col);
81
+ element_refs[header_id] = { cell: null, input: null };
82
+ return { id: header_id, value: JSON.stringify(col + 1) };
83
+ });
84
+ }
85
+
86
+ return header_list.map((header: string | null, col: number) => {
87
+ const header_id = make_header_id(col);
88
+ element_refs[header_id] = { cell: null, input: null };
89
+ return { id: header_id, value: header ?? "" };
90
+ });
91
+ }
92
+
93
+ export function get_max(data: TableData): TableCell[] {
94
+ if (!data || !data.length) return [];
95
+ let max = data[0].slice();
96
+ for (let i = 0; i < data.length; i++) {
97
+ for (let j = 0; j < data[i].length; j++) {
98
+ if (`${max[j].value}`.length < `${data[i][j].value}`.length) {
99
+ max[j] = data[i][j];
100
+ }
101
+ }
102
+ }
103
+ return max;
104
+ }
105
+
106
+ export function sort_table_data(
107
+ data: TableData,
108
+ display_value: string[][] | null,
109
+ styling: string[][] | null,
110
+ col: number,
111
+ dir: SortDirection
112
+ ): void {
113
+ const indices = sort_data(data, col, dir);
114
+
115
+ const new_data = indices.map((i: number) => data[i]);
116
+ data.splice(0, data.length, ...new_data);
117
+
118
+ if (display_value) {
119
+ const new_display = indices.map((i: number) => display_value[i]);
120
+ display_value.splice(0, display_value.length, ...new_display);
121
+ }
122
+
123
+ if (styling) {
124
+ const new_styling = indices.map((i: number) => styling[i]);
125
+ styling.splice(0, styling.length, ...new_styling);
126
+ }
127
+ }
128
+
129
+ export async function copy_table_data(
130
+ data: TableData,
131
+ selected_cells: [number, number][]
132
+ ): Promise<void> {
133
+ const csv = selected_cells.reduce(
134
+ (acc: { [key: string]: { [key: string]: string } }, [row, col]) => {
135
+ acc[row] = acc[row] || {};
136
+ const value = String(data[row][col].value);
137
+ acc[row][col] =
138
+ value.includes(",") || value.includes('"') || value.includes("\n")
139
+ ? `"${value.replace(/"/g, '""')}"`
140
+ : value;
141
+ return acc;
142
+ },
143
+ {}
144
+ );
145
+
146
+ const rows = Object.keys(csv).sort((a, b) => +a - +b);
147
+ const cols = Object.keys(csv[rows[0]]).sort((a, b) => +a - +b);
148
+ const text = rows
149
+ .map((r) => cols.map((c) => csv[r][c] || "").join(","))
150
+ .join("\n");
151
+
152
+ try {
153
+ await navigator.clipboard.writeText(text);
154
+ } catch (err) {
155
+ console.error("Copy failed:", err);
156
+ throw new Error("Failed to copy to clipboard: " + (err as Error).message);
157
+ }
158
+ }
159
+
160
+ // File Import/Export
161
+ export function guess_delimiter(
162
+ text: string,
163
+ possibleDelimiters: string[]
164
+ ): string[] {
165
+ return possibleDelimiters.filter(weedOut);
166
+
167
+ function weedOut(delimiter: string): boolean {
168
+ var cache = -1;
169
+ return text.split("\n").every(checkLength);
170
+
171
+ function checkLength(line: string): boolean {
172
+ if (!line) return true;
173
+ var length = line.split(delimiter).length;
174
+ if (cache < 0) cache = length;
175
+ return cache === length && length > 1;
176
+ }
177
+ }
178
+ }
179
+
180
+ export function data_uri_to_blob(data_uri: string): Blob {
181
+ const byte_str = atob(data_uri.split(",")[1]);
182
+ const mime_str = data_uri.split(",")[0].split(":")[1].split(";")[0];
183
+ const ab = new ArrayBuffer(byte_str.length);
184
+ const ia = new Uint8Array(ab);
185
+ for (let i = 0; i < byte_str.length; i++) {
186
+ ia[i] = byte_str.charCodeAt(i);
187
+ }
188
+ return new Blob([ab], { type: mime_str });
189
+ }
190
+
191
+ export function handle_file_upload(
192
+ data_uri: string,
193
+ update_headers: (headers: Headers) => HeadersWithIDs[],
194
+ update_values: (values: (string | number)[][]) => void
195
+ ): void {
196
+ const blob = data_uri_to_blob(data_uri);
197
+ const reader = new FileReader();
198
+ reader.addEventListener("loadend", (e) => {
199
+ if (!e?.target?.result || typeof e.target.result !== "string") return;
200
+ const [delimiter] = guess_delimiter(e.target.result, [",", "\t"]);
201
+ const [head, ...rest] = dsvFormat(delimiter).parseRows(e.target.result);
202
+ update_headers(head);
203
+ update_values(rest);
204
+ });
205
+ reader.readAsText(blob);
206
+ }
@@ -1,6 +0,0 @@
1
- import type { HeadersWithIDs } from "./utils";
2
- export type TableData = {
3
- value: string | number;
4
- id: string;
5
- }[][];
6
- export declare function copy_table_data(data: TableData, headers?: HeadersWithIDs): Promise<void>;
@@ -1,27 +0,0 @@
1
- export async function copy_table_data(data, headers) {
2
- const header_row = headers
3
- ? headers.map((h) => String(h.value)).join(",")
4
- : "";
5
- const table_data = data
6
- .map((row) => row.map((cell) => String(cell.value)).join(","))
7
- .join("\n");
8
- const all_data = header_row ? `${header_row}\n${table_data}` : table_data;
9
- try {
10
- if ("clipboard" in navigator) {
11
- await navigator.clipboard.writeText(all_data);
12
- }
13
- else {
14
- const textArea = document.createElement("textarea");
15
- textArea.value = all_data;
16
- textArea.style.position = "absolute";
17
- textArea.style.left = "-999999px";
18
- document.body.prepend(textArea);
19
- textArea.select();
20
- document.execCommand("copy");
21
- textArea.remove();
22
- }
23
- }
24
- catch (error) {
25
- console.error("Failed to copy table data:", error);
26
- }
27
- }
@@ -1,38 +0,0 @@
1
- import type { HeadersWithIDs } from "./utils";
2
-
3
- export type TableData = {
4
- value: string | number;
5
- id: string;
6
- }[][];
7
-
8
- export async function copy_table_data(
9
- data: TableData,
10
- headers?: HeadersWithIDs
11
- ): Promise<void> {
12
- const header_row = headers
13
- ? headers.map((h) => String(h.value)).join(",")
14
- : "";
15
- const table_data = data
16
- .map((row) => row.map((cell) => String(cell.value)).join(","))
17
- .join("\n");
18
-
19
- const all_data = header_row ? `${header_row}\n${table_data}` : table_data;
20
-
21
- try {
22
- if ("clipboard" in navigator) {
23
- await navigator.clipboard.writeText(all_data);
24
- } else {
25
- const textArea = document.createElement("textarea");
26
- textArea.value = all_data;
27
- textArea.style.position = "absolute";
28
- textArea.style.left = "-999999px";
29
- document.body.prepend(textArea);
30
- textArea.select();
31
-
32
- document.execCommand("copy");
33
- textArea.remove();
34
- }
35
- } catch (error) {
36
- console.error("Failed to copy table data:", error);
37
- }
38
- }