mkdocs

Author: ndonkoHenri

examples/datatable2_example/src/main.py

@@ -3,7 +3,7 @@
 import flet as ft
 from data import desserts
 
-from flet_datatable2 import DataColumn2, DataRow2, DataTable2, Size
+from flet_datatable2 import DataColumn2, DataRow2, DataTable2, DataColumnSize
 
 logging.basicConfig(level=logging.DEBUG)
 
@@ -31,7 +31,7 @@ def get_data_columns():
         data_columns = [
             DataColumn2(
                 ft.Text("Name"),
-                size=Size.L,
+                size=DataColumnSize.L,
                 on_sort=sort_column,
                 heading_row_alignment=ft.MainAxisAlignment.START,
             ),
@@ -80,7 +80,7 @@ def get_data_rows(desserts):
             data_rows.append(
                 DataRow2(
                     specific_row_height=50,
-                    on_select_changed=select_row,
+                    on_select_change=select_row,
                     cells=[
                         ft.DataCell(content=ft.Text(dessert.name)),
                         ft.DataCell(content=ft.Text(dessert.calories)),

src/flet_datatable2/__init__.py

@@ -1,5 +1,4 @@
-"""DataTable2 control"""
-
-from flet_datatable2.datacolumn2 import DataColumn2, Size
-from flet_datatable2.datarow2 import DataRow2
-from flet_datatable2.datatable2 import DataTable2
+from .datacolumn2 import DataColumn2
+from .datarow2 import DataRow2
+from .datatable2 import DataTable2
+from .types import DataColumnSize, DataColumnSortEvent

src/flet_datatable2/datacolumn2.py

@@ -1,20 +1,20 @@
-from dataclasses import dataclass
-from enum import Enum
 from typing import Optional
 
 import flet as ft
+from .types import DataColumnSize
 
 __all__ = ["DataColumn2"]
 
 
 @ft.control("DataColumn2")
 class DataColumn2(ft.Control):
     """
-    Column configuration for a [DataTable2](datatable2.md).
+    Column configuration for a [`DataTable2`](datatable2.md).
 
     One column configuration must be provided for each column to display in the table.
 
-    Additional to Flet [DataColumn](https://flet.dev/docs/controls/datatable/#datacolumn), adds the capability to set relative column size via size property.
+    Extends Flet [`DataColumn`](https://flet.dev/docs/controls/datatable/#datacolumn),
+    adds the capability to set relative column size via size property.
     """
 
     label: ft.Control
@@ -27,7 +27,7 @@ class DataColumn2(ft.Control):
 
     fixed_width: ft.OptionalNumber = 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).
     """
 
     heading_row_alignment: Optional[ft.MainAxisAlignment] = None
@@ -42,9 +42,10 @@ class DataColumn2(ft.Control):
     The contents of cells of columns containing numeric data are right-aligned.
     """
 
-    size: Optional[Size] = None
+    size: Optional[DataColumnSize] = DataColumnSize.S
     """
-    Column sizes are determined based on available width by distributing it to individual columns accounting for their relative sizes. Value is of type `Size` and defaults to `Size.S`.
+    Column sizes are determined based on available width by distributing 
+    it to individual columns accounting for their relative sizes. 
     """
 
     on_sort: ft.OptionalEventCallable[ft.DataColumnSortEvent] = None

src/flet_datatable2/datatable2.py

@@ -75,7 +75,8 @@ class DataTable2(ft.ConstrainedControl):
 
     sort_ascending: bool = False
     """
-    Whether the column mentioned in `sort_column_index`, if any, is sorted in ascending order.
+    Whether the column mentioned in [`sort_column_index`][..], 
+    if any, is sorted in ascending order.
 
     If `True`, the order is ascending (meaning the rows with the smallest 
     values for the current sort column are first in the table).
@@ -88,11 +89,12 @@ class DataTable2(ft.ConstrainedControl):
     """
     Whether the control should display checkboxes for selectable rows.
     
-    If `True`, a `Checkbox` will be placed at the beginning of each row that is selectable. 
+    If `True`, a [`Checkbox`](https://flet.dev/docs/controls/checkbox) 
+    will be placed at the beginning of each row that is selectable. 
     However, if `DataRow.on_select_changed` is not set for any row, checkboxes will not 
     be placed, even if this value is `True`.
     
-    If `False`, all rows will not display a [`Checkbox`](https://flet.dev/docs/controls/checkbox).
+    If `False`, all rows will not display a `Checkbox`.
     """
 
     show_heading_checkbox: bool = True
@@ -191,10 +193,10 @@ class DataTable2(ft.ConstrainedControl):
 
     data_row_color: ft.ControlStateValue[ft.ColorValue] = None
     """
-    The background [color](/docs/reference/colors) for the data rows.
+    The background [color](https://flet.dev/docs/reference/colors) for the data rows.
 
     The effective background color can be made to depend on the 
-    [`ControlState`](/docs/reference/types/controlstate) state,
+    [`ControlState`](https://flet.dev/docs/reference/types/controlstate) state,
     i.e. if the row is selected, pressed, hovered, focused, disabled or enabled. 
     The color is painted as an overlay to the row. 
     
@@ -250,7 +252,7 @@ class DataTable2(ft.ConstrainedControl):
 
     heading_text_style: Optional[ft.TextStyle] = None
     """
-    See DataTable [heading_text_style](https://flet.dev/docs/controls/datatable#heading_text_style).
+    The text style for the heading row.
     """
 
     heading_row_decoration: Optional[ft.BoxDecoration] = None
@@ -260,7 +262,11 @@ class DataTable2(ft.ConstrainedControl):
 
     horizontal_margin: ft.OptionalNumber = None
     """
-    See DataTable [horizontal_margin](https://flet.dev/docs/controls/datatable#horizontal_margin).
+    The horizontal margin between the edges of the table and the content 
+    in the first and last cells of each row.
+
+    When a checkbox is displayed, it is also the margin between the 
+    checkbox the content in the first data column.
     """
 
     clip_behavior: ft.ClipBehavior = ft.ClipBehavior.NONE
@@ -273,11 +279,11 @@ class DataTable2(ft.ConstrainedControl):
     Invoked when the user selects or unselects every row, 
     using the checkbox in the heading row.
 
-    If this is `None`, then the `DataRow.on_select_change` 
+    If this is `None`, then the [`DataRow.on_select_change`]() 
     callback of every row in the table is invoked appropriately instead.
     
     To control whether a particular row is selectable or not, 
-    see [`DataRow.on_select_change`][(p).datarow2.]. 
+    see [`DataRow2.on_select_change`][datarow2.md]. 
     This callback is only relevant if any row is selectable.
     """