Merge pull request #6 from flet-dev/inesa/test-folder

Tests folder, updated examples

Author: ndonkoHenri

.gitignore

@@ -10,3 +10,4 @@
 /src/flet_datatable2.egg-info
 .DS_Store
 uv.lock
+__pycache__/

docs/types/datacolumn_size.md

@@ -1 +1,3 @@
-::: flet_datatable2.types.DataColumnSize 
+::: flet_datatable2.types.DataColumnSize
+    options:
+        separate_signature: false

examples/datatable2_example/pyproject.toml

@@ -1,13 +1,13 @@
 [project]
 name = "flet-datatable2-example"
 version = "1.0.0"
-description = ""
+description = "flet-datatable2-example"
 readme = "README.md"
 requires-python = ">=3.10"
 authors = [{ name = "Flet Contributors", email = "hello@flet.dev" }]
 dependencies = [
-  "flet-datatable2",
-  "flet",
+  "flet-datatable2 >=0.2.0.dev0",
+  "flet >=0.70.0.dev0",
 ]
 
 # Docs: https://flet.dev/docs/publish

mkdocs.yml

@@ -126,6 +126,7 @@ plugins:
             show_labels: false
             show_if_no_docstring: true
             docstring_section_style: spacy
+            separate_signature: true
             inherited_members: true
             preload_modules: [ flet ]
             filters:

src/flet_datatable2/datacolumn2.py

@@ -9,15 +9,16 @@
 @ft.control("DataColumn2")
 class DataColumn2(ft.DataColumn):
     """
-    Extends Flet [`DataColumn`](https://flet.dev/docs/controls/datatable/#datacolumn),
+    Extends [`flet.DataColumn`][flet.DataColumn],
     adding the ability to set relative column size and fixed column width.
 
     Meant to be used as an item of [`DataTable2.columns`][(p).].
     """
 
     fixed_width: Optional[ft.Number] = None
     """
-    Defines absolute width of the column in pixels (as opposed to relative [`size`][..] used by default).
+    Defines absolute width of the column in pixels 
+    (as opposed to relative [`size`][..] used by default).
     """
 
     size: Optional[DataColumnSize] = DataColumnSize.S

src/flet_datatable2/datarow2.py

@@ -8,51 +8,77 @@
 @ft.control("DataRow2")
 class DataRow2(ft.DataRow):
     """
-    Extends [`DataRow`](https://flet.dev/docs/controls/datatable#datarow).
+    Extends [`flet.DataRow`][flet.DataRow], adding row-level `tap` events.
 
-    Adds row-level `tap` events. There are also [`on_secondary_tap`][(c).] and [`on_secondary_tap_down`][(c).],
-    which are not available in `DataCell`s and can be useful in desktop settings to handle right-click actions.
+    There are also [`on_secondary_tap`][(c).] and [`on_secondary_tap_down`][(c).],
+    which are not available in [`DataCell`][flet.DataCell]s and can be useful in
+    desktop settings to handle right-click actions.
     """
 
     decoration: Optional[ft.BoxDecoration] = None
     """
-    Decoration to be applied to the row. 
+    Decoration to be applied to this row. 
     
-    Overrides `divider_thickness`.
+    Note:
+        If provided, [`DataTable2.divider_thickness`][(p).] has no effect.
     """
 
     specific_row_height: Optional[ft.Number] = None
     """
     Specific row height. 
     
-    Falls back to `data_row_height` if not set.
+    Falls back to [`DataTable2.data_row_height`][(p).] if not set.
     """
 
-    on_double_tap: ft.OptionalControlEventHandler["DataRow2"] = None
+    on_double_tap: Optional[ft.ControlEventHandler["DataRow2"]] = None
     """
     Fires when the row is double-tapped.
     
-    Ignored if the tapped cell has a `tap` handler.
+    Note:
+        Won't be called if tapped cell has any tap event handlers 
+        ([`on_tap`][flet.DataCell.on_tap], 
+        [`on_double_tap`][flet.DataCell.on_double_tap], 
+        [`on_long_press`][flet.DataCell.on_long_press], 
+        [`on_tap_cancel`][flet.DataCell.on_tap_cancel], 
+        [`on_tap_down`][flet.DataCell.on_tap_down]) set.
     """
 
-    on_secondary_tap: ft.OptionalControlEventHandler["DataRow2"] = None
+    on_secondary_tap: Optional[ft.ControlEventHandler["DataRow2"]] = None
     """
     Fires when the row is right-clicked (secondary tap).
     
-    Ignored if the tapped cell has a `tap` handler.
+    Note:
+        Won't be called if tapped cell has any tap event handlers 
+        ([`on_tap`][flet.DataCell.on_tap], 
+        [`on_double_tap`][flet.DataCell.on_double_tap], 
+        [`on_long_press`][flet.DataCell.on_long_press], 
+        [`on_tap_cancel`][flet.DataCell.on_tap_cancel], 
+        [`on_tap_down`][flet.DataCell.on_tap_down]) set.
     """
 
-    on_secondary_tap_down: ft.OptionalControlEventHandler["DataRow2"] = None
+    on_secondary_tap_down: Optional[ft.ControlEventHandler["DataRow2"]] = None
     """
     Fires when the row is right-clicked (secondary tap down).
     
-    Ignored if the tapped cell has a `tap` handler.
+    Note:
+        Won't be called if tapped cell has any tap event handlers 
+        ([`on_tap`][flet.DataCell.on_tap], 
+        [`on_double_tap`][flet.DataCell.on_double_tap], 
+        [`on_long_press`][flet.DataCell.on_long_press], 
+        [`on_tap_cancel`][flet.DataCell.on_tap_cancel], 
+        [`on_tap_down`][flet.DataCell.on_tap_down]) set.
     """
 
-    on_tap: ft.OptionalEventHandler[ft.TapEvent["DataRow2"]] = None
+    on_tap: Optional[ft.EventHandler[ft.TapEvent["DataRow2"]]] = None
     """
     Fires when the row is tapped.
     
-    Ignored if the tapped cell has a `tap` handler.
+    Note:
+        Won't be called if tapped cell has any tap event handlers 
+        ([`on_tap`][flet.DataCell.on_tap], 
+        [`on_double_tap`][flet.DataCell.on_double_tap], 
+        [`on_long_press`][flet.DataCell.on_long_press], 
+        [`on_tap_cancel`][flet.DataCell.on_tap_cancel], 
+        [`on_tap_down`][flet.DataCell.on_tap_down]) set.
     """
 

src/flet_datatable2/datatable2.py

@@ -12,11 +12,18 @@
 @ft.control("DataTable2")
 class DataTable2(ft.DataTable):
     """
-    Extends [`DataTable`](https://flet.dev/docs/controls/datatable).
+    Extends [`flet.DataTable`][flet.DataTable].
 
     Provides sticky header row, scrollable data rows,
     and additional layout flexibility with [`DataColumn2`][(p).]
     and [`DataRow2`][(p).].
+
+    Note:
+        `DataTable2` doesn't support
+        [`flet.DataTable.data_row_min_height`][flet.DataTable.data_row_min_height]
+        and [`flet.DataTable.data_row_max_height`][flet.DataTable.data_row_max_height]
+        properties present in the parent [`flet.DataTable`][flet.DataTable].
+        Use [`data_row_height`][(c).] instead.
     """
 
     columns: list[Union[DataColumn2, ft.DataColumn]]
@@ -117,7 +124,7 @@ class DataTable2(ft.DataTable):
     """
 
     checkbox_alignment: ft.Alignment = field(
-        default_factory=lambda: ft.Alignment.center()
+        default_factory=lambda: ft.Alignment.CENTER
     )
     """
     Alignment of the checkbox.
@@ -126,13 +133,8 @@ class DataTable2(ft.DataTable):
     data_row_height: Optional[ft.Number] = None
     """
     Height of each data row. 
-    
-    Note:
-        `DataTable2` doesn't support 
-        `DataTable.data_row_min_height` and `DataTable.data_row_max_height`.
     """
 
-    # present in parent but of no use in DataTable2
-    data_row_min_height: None = field(init=False, repr=False, compare=False)
-    data_row_max_height: None = field(init=False, repr=False, compare=False)
-
+    # present in parent (DataTable) but of no use in DataTable2
+    data_row_min_height: None = field(init=False, repr=False, compare=False, metadata={"skip": True})
+    data_row_max_height: None = field(init=False, repr=False, compare=False, metadata={"skip": True})

src/flutter/flet_datatable2/lib/src/datatable2.dart

@@ -87,7 +87,7 @@ class _DataTable2ControlState extends State<DataTable2Control> {
       sortArrowAnimationDuration: widget.control.getDuration(
           "sort_arrow_animation_duration", Duration(microseconds: 150))!,
       checkboxAlignment:
-          widget.control.getAlignment("checkboxAlignment", Alignment.center)!,
+          widget.control.getAlignment("checkbox_alignment", Alignment.center)!,
       headingCheckboxTheme: widget.control
           .getCheckboxTheme("heading_checkbox_theme", Theme.of(context)),
       datarowCheckboxTheme: widget.control

tests/basic_test.py

@@ -0,0 +1,19 @@
+import flet as ft
+
+import flet_datatable2 as fdt
+
+
+def main(page: ft.Page):
+    page.add(
+        fdt.DataTable2(
+            empty=ft.Text("This table is empty."),
+            columns=[
+                fdt.DataColumn2(ft.Text("First name")),
+                fdt.DataColumn2(ft.Text("Last name")),
+                fdt.DataColumn2(ft.Text("Age"), numeric=True),
+            ],
+        ),
+    )
+
+
+ft.run(main)