Merge pull request #172 from anvilistas/fix/selectableRows

Author: s-cork

.pre-commit-config.yaml

@@ -4,7 +4,9 @@ repos:
     hooks:
     -   id: check-yaml
     -   id: end-of-file-fixer
+        exclude: ".*/assets/tabulator-tables/.*"
     -   id: trailing-whitespace
+        exclude: ".*/assets/tabulator-tables/.*"
   - repo: https://github.com/psf/black
     rev: 24.8.0 # Replace by any tag/version: https://github.com/psf/black/tags
     hooks:

CHANGELOG.md

@@ -394,7 +394,7 @@ This is most useful if you have multiple Tabulator components and don't want to
 The default `default_options` are:
 
 ```python
-Tabulator.default_options = {"layout": "fitColumns", "selectable": False}
+Tabulator.default_options = {"layout": "fitColumns"}
 ```
 *(as well as all the JS Tabulator default options)*
 

client_code/Tabulator/__init__.py

@@ -22,6 +22,7 @@
     _ignore_resize_observer_error,
     _inject_theme,
     _merge,
+    _normalizeOptions,
     _options_property,
     _spacing_property,
     _to_module,
@@ -133,6 +134,7 @@ def _initialize(self):
         logger.debug(f"Options: {self.options}")
 
         options = _camelKeys(self._options) | _camelKeys(self.options)
+        options = _normalizeOptions(options)
         options["columns"] = [_camelKeys(defn) for defn in options["columns"]]
         options["columnDefaults"] = _camelKeys(options["columnDefaults"])
         if in_designer and type(self) is Tabulator:
@@ -154,10 +156,9 @@ def _initialize(self):
         # if we're using the rowSelection make sure things are selectable
         if (
             any(col.get("formatter") == "rowSelection" for col in options["columns"])
-            and options.get("selectable") is None
-            and Tabulator.default_options.get("selectable") is False
+            and options.get("selectableRows") is None
         ):
-            options["selectable"] = "highlight"
+            options["selectableRows"] = "highlight"
 
         t = _Tabulator(self._dom_node, options)
         t.anvil_form = self

client_code/Tabulator/_defaults.py

@@ -49,7 +49,7 @@
     "Sort",
 }
 
-_default_table_options = {"layout": "fitColumns", "selectable": False}
+_default_table_options = {"layout": "fitColumns"}
 
 
 _default_theme = "bootstrap3"

client_code/Tabulator/_helpers.py

@@ -25,6 +25,15 @@ def _camelKeys(d):
     return {_toCamel(key): val for key, val in d.items()}
 
 
+def _normalizeOptions(options):
+    # selectable was removed in tabulator 6 in favour of selectableRows
+    # but we still support it for backwards compatibility
+    if "selectable" in options:
+        options["selectableRows"] = options["selectable"]
+        del options["selectable"]
+    return options
+
+
 def _merge(default, properties, **overrides):
     merged = overrides
     for key, val in default.items():