Add type hints for pageLength

Author: mwouts

docs/changelog.md

@@ -9,6 +9,7 @@ ITables ChangeLog
 
 **Fixed**
 - We have added a `Typing :: Typed` classifier to the package as ITables now comes with type annotations ([#411](https://github.com/mwouts/itables/issues/411))
+- Added type hints and an example for `pageLength` ([#410](https://github.com/mwouts/itables/issues/410))
 
 
 2.4.1 (2025-06-10)

docs/options/length_menu.md

@@ -14,7 +14,7 @@ kernelspec:
 
 # LengthMenu
 
-Select [how many entries](https://datatables.net/examples/advanced_init/length_menu.html) should appear at once in the table with either the `lengthMenu` argument of the `show` function, or with the global option `itables.options.lengthMenu`:
+Select [how many entries](https://datatables.net/examples/advanced_init/length_menu.html) should appear at once in the table with either the `lengthMenu` argument of the `show` function, or with the global option `itables.options.lengthMenu`. Use `pageLength` to set the default page length:
 
 ```{code-cell} ipython3
 import itables
@@ -26,5 +26,5 @@ df = itables.sample_dfs.get_countries(html=False)
 ```{code-cell} ipython3
 :tags: [full-width]
 
-itables.show(df, lengthMenu=[2, 5, 10, 20, 50])
+itables.show(df, lengthMenu=[2, 5, 10, 20, 50], pageLength=5)
 ```

docs/py/options/length_menu.py

@@ -17,7 +17,7 @@
 # %% [markdown]
 # # LengthMenu
 #
-# Select [how many entries](https://datatables.net/examples/advanced_init/length_menu.html) should appear at once in the table with either the `lengthMenu` argument of the `show` function, or with the global option `itables.options.lengthMenu`:
+# Select [how many entries](https://datatables.net/examples/advanced_init/length_menu.html) should appear at once in the table with either the `lengthMenu` argument of the `show` function, or with the global option `itables.options.lengthMenu`. Use `pageLength` to set the default page length:
 
 # %%
 import itables
@@ -26,4 +26,4 @@
 df = itables.sample_dfs.get_countries(html=False)
 
 # %% tags=["full-width"]
-itables.show(df, lengthMenu=[2, 5, 10, 20, 50])
+itables.show(df, lengthMenu=[2, 5, 10, 20, 50], pageLength=5)

src/itables/options.py

@@ -107,6 +107,7 @@
         Sequence[Sequence[Union[int, str]]],
     ]
 ]
+pageLength: Optional[int]
 columnDefs: Optional[Sequence[Mapping[str, Any]]]
 paging: Optional[bool]
 autoWidth: Optional[bool]

src/itables/typing.py

@@ -54,6 +54,7 @@ class DataTableOptions(TypedDict):
             Sequence[Sequence[Union[int, str]]],
         ]
     ]
+    pageLength: NotRequired[int]
     order: NotRequired[
         Union[Sequence[Sequence[Union[int, str]]], Mapping[str, Union[int, str]]]
     ]