Improve text_in_header_can_be_selected, add documentation (#382)

* Improve text_in_header_can_be_selected, add documentation

This fixes an interaction with column_filters="headers"

Author: mwouts

docs/_toc.yml

@@ -37,6 +37,7 @@ parts:
       - file: options/keys
       - file: options/allow_html
       - file: options/show_index
+      - file: options/text_in_header_can_be_selected
   - caption: More about ITables
     chapters:
     - file: downsampling

docs/changelog.md

@@ -1,7 +1,7 @@
 ITables ChangeLog
 =================
 
-2.4.0rc1 (2025-05-11)
+2.4.0-dev
 ---------------------
 
 **Added**
@@ -15,6 +15,9 @@ ITables ChangeLog
 - ITable now requires Python 3.9, due to the addition of type hints
 - The `dom` argument (deprecated in v2.0) has been removed.
 
+**Fixed**
+- We have added a new option `text_in_header_can_be_selected` (defaults to `True`). With that option the text in headers can be selected, giving you the option to select and copy the column names back to your Python code.
+
 
 2.3.0 (2025-04-05)
 ------------------

docs/options/text_in_header_can_be_selected.md

@@ -0,0 +1,39 @@
+---
+jupytext:
+  formats: md:myst
+  notebook_metadata_filter: -jupytext.text_representation.jupytext_version
+  text_representation:
+    extension: .md
+    format_name: myst
+    format_version: 0.13
+kernelspec:
+  display_name: itables
+  language: python
+  name: itables
+---
+
+# Select Text in Header
+
+The `text_in_header_can_be_selected` option, which defaults to `True`, is provided by ITables since v2.4.0.
+
+With that option set (the default), you can select the text in the table headers. This is useful in the context of data exploration where
+you need to copy back the column name to your code.
+
+```{code-cell} ipython3
+import itables
+
+itables.init_notebook_mode()
+df = itables.sample_dfs.get_countries(html=False)
+
+itables.show(df, "A table in which column headers can be selected")
+```
+
+When `text_in_header_can_be_selected=False`, the column title cannot be selected as clicking on the title sorts the table.
+
+```{code-cell} ipython3
+itables.show(
+    df,
+    "A table in which column headers cannot be selected",
+    text_in_header_can_be_selected=False,
+)
+```

packages/dt_for_itables/CHANGELOG.md

@@ -1,7 +1,13 @@
+# 2.3.1 (2025-05-17)
+
+- We have improved the implementation of `text_in_header_can_be_selected`.
+- The indirect evaluation of `JavascriptCode` and `JavascriptFunction` will not proceed when prototype pollution attempts are detected.
+
 # 2.3.0 (2025-05-11)
 
 - This version uses `datatables.net-dt=2.3.0`. The extensions have been updated, too.
 - We have added a new class `ITable` that processes some of the arguments on the Javascript side.
+- We use an indirect eval to parse the `JavascriptCode` and `JavascriptFunction` passed from Python.
 - The table data is now passed as JSON through `data_json`, with support for BigInts and non finite float values.
 
 # 2.2.0 (2025-03-15)

packages/dt_for_itables/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "dt_for_itables",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "description": "DataTables bundle for itables",
   "main": "src/index.js",
   "typings": "src/index.d.js",

packages/dt_for_itables/package.json

@@ -123,18 +123,19 @@ class ITable {
                             // (but keep the icon for alignment)
                             jQuery(this).attr('data-dt-order', 'disable');
                         }
-                        else if (jQuery(this).text().trim() === '') {
-                            // Remove the sorting icon on empty cells
-                            jQuery(this).empty();
+                        else if (jQuery(this).find('span.dt-column-title').text() === '' && jQuery(this).find('span.dt-column-title').children().length === 0) {
+                            // Remove the sorting icon on empty headers
                             jQuery(this).attr('data-dt-order', 'disable');
+                            // Remove any children with the 'dt-column-order' class
+                            jQuery(this).children('.dt-column-order').remove();
+                            // Remove the dt-orderable-asc and dt-orderable-desc classes
+                            jQuery(this).removeClass('dt-orderable-asc dt-orderable-desc');
                         }
                         else {
                             // Apply the icon-only data-dt-order attribute
                             jQuery(this).attr('data-dt-order', 'icon-only');
-
                             // get the current column index
                             let colIndex = api.column(this).index('visible');
-
                             // Apply the order listener to the order icon
                             api.order.listener(jQuery('span.dt-column-order', this), colIndex);
                         }
@@ -157,16 +158,16 @@ class ITable {
         }
         if (classes) {
             classes.forEach(element => {
-                    this.table.addClass(element);
-                });
+                this.table.addClass(element);
+            });
         }
         if (style) {
             this.table.css(style);
         }
         if (table_style) {
             $('<style id="' + this.table.attr('id') + '-style">')
-  .text(table_style)
-  .appendTo(this.table);
+                .text(table_style)
+                .appendTo(this.table);
         }
         if (column_filters === "header" || column_filters === "footer") {
             let thead_or_tfoot = (column_filters === "header") ? "thead" : "tfoot";