Sort row selection keys

Also, don't use df[col][rownum] in examples--that syntax
is still using the pandas index. Instead, an explicit
.iloc[...] is needed.

Author: jcheng5

CHANGELOG.md

@@ -16,7 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Fixed #646: Wrap bare value box value in `<p />` tags. (#668)
 
-Fixed #676: `render.data_frame` was reporting selected rows using 0-based row numbers, but the examples and documentation were unclear about whether these values were row numbers or pandas index values (which default to row numbers, but could easily be something else). Now the examples and documentation are consistent with the behavior. (#677)
+Fixed #676: The `render.data_frame` selection feature was underdocumented and buggy (sometimes returning `None` as a row identifier if the pandas data frame's index had gaps in it). With this release, the selection is consistently a tuple of the 0-based row numbers of the selected rows--or `None` if no rows are selected. (#677)
 
 ### Other changes
 

e2e/bugs/0676-row-selection/app.py

@@ -17,6 +17,7 @@
     ui.p("Select rows in the grid, make sure the selected rows appear below."),
     ui.output_data_frame("grid"),
     ui.output_table("detail"),
+    ui.output_text_verbatim("debug"),
     class_="p-3",
 )
 
@@ -41,5 +42,10 @@ def detail():
             # "split", "records", "index", "columns", "values", "table"
             return df.iloc[list(input.grid_selected_rows())]
 
+    @output
+    @render.text
+    def debug():
+        return input.grid_selected_rows()
+
 
 app = App(app_ui, server, debug=True)

e2e/bugs/0676-row-selection/test_0676_row_selection.py

@@ -10,12 +10,20 @@ def test_row_selection(page: Page, local_app: ShinyAppProc) -> None:
     # The purpose of this test is to make sure that the data grid can work on Pandas
     # data frames that use an index that is not simply 0-based integers.
 
+    row1 = page.locator("#grid tbody tr:nth-child(1)")
     row3 = page.locator("#grid tbody tr:nth-child(3)")
     result_loc = page.locator("#detail tbody tr:nth-child(1) td:nth-child(1)")
+    debug_loc = page.locator("#debug")
 
     expect(row3).to_be_visible()
     expect(row3.locator("td:nth-child(1)")).to_have_text("three")
+    expect(debug_loc).to_have_text("()")
 
     expect(result_loc).not_to_be_attached()
     row3.click()
     expect(result_loc).to_have_text("three")
+    expect(debug_loc).to_have_text("(2,)")
+
+    # Ensure that keys are in sorted order, not the order in which they were selected
+    row1.click()
+    expect(debug_loc).to_have_text("(0, 2)")

js/dataframe/index.tsx

@@ -189,6 +189,7 @@ const ShinyDataGrid: FC<ShinyDataGridProps<unknown>> = (props) => {
             .keys()
             .toList()
             .map((key) => parseInt(key))
+            .sort()
         );
       }
     }

shiny/api-examples/data_frame/app.py

@@ -66,7 +66,7 @@ def filtered_df():
         # input.summary_data_selected_rows() is a tuple, so we must convert it to list,
         # as that's what Pandas requires for indexing.
         selected_idx = list(req(input.summary_data_selected_rows()))
-        countries = summary_df["country"][selected_idx]
+        countries = summary_df.iloc[selected_idx]["country"]
         # Filter data for selected countries
         return df[df["country"].isin(countries)]