Skip to content

Commit b1ccfc3

Browse files
authored
Documentation.
1 parent d67c69d commit b1ccfc3

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

flet-navigator-docs.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h1 align="center">FletNavigator V3.9.7 Documentation</h1>
1+
<h1 align="center">FletNavigator V3.9.8 Documentation</h1>
22
Minimalistic FletNavigator documentation. Yeah, just like the module itself.<br><br>
33

44
<a href="#ultimate-showcase">Ultimate showcase.</a>
@@ -9,9 +9,9 @@ Minimalistic FletNavigator documentation. Yeah, just like the module itself.<br>
99

1010
<h2>Public Generic Globals</h2>
1111

12-
- `FLET_NAVIGATOR_VERSION` (`str`, `'3.9.7'`) - FN Version.
12+
- `FLET_NAVIGATOR_VERSION` (`str`, `'3.9.8'`) - FN Version.
1313
- `_DEFAULT_PAGE_404` (`PageDefinition`) - A page definition of 404 route. It's public but I don't really think you'll need this.
14-
- `ROUTE_404` (`str`, `ROUTE-404`) - A constant string representing the 404 route type. It's akin to a form of identification.
14+
- `ROUTE_404` (`str`, `'ROUTE-404'`) - A constant string representing the 404 route type. It's akin to a form of identification.
1515

1616
<h2>Public Typehints/Aliases</h2>
1717

@@ -37,6 +37,7 @@ Minimalistic FletNavigator documentation. Yeah, just like the module itself.<br>
3737
- `navigate(route: str, args: Arguments=(), parameters: RouteParameters={}) -> None` - Navigate to a specific route. If the navigator is virtual, parameters are not used.
3838
- `navigate_homepage(args: Arguments=(), parameters: RouteParameters={}) -> None` - Navigate to the homepage. If the navigator is virtual, parameters are not used.
3939
- `navigate_back(args: Arguments=(), parameters: RouteParameters={}) -> None` - Navigate back to the previous route. If the navigator is virtual, parameters are not used.
40+
- `set_homepage(homepage: str) -> None` - Update navigator's homepage address.
4041
- `set_navbar(navbar: Union[ConstrainedControl, AdaptiveControl]) -> None` - Set the navigation bar for the current page.
4142
- `delete_navbar() -> None` - Remove the navigation bar for the current page.
4243

@@ -52,7 +53,7 @@ Minimalistic FletNavigator documentation. Yeah, just like the module itself.<br>
5253
- `navigate(route: str, page: Page, args: Arguments = ()) -> None` - Navigate to a specific route.
5354
- `navigate_homepage(page: Page, args: Arguments = ()) -> None` - Navigate to the homepage.
5455
- `set_homepage(homepage: str) -> None` - Set the homepage route.
55-
- `navigate_back(page: Page, args: Arguments = (), parameters: RouteParameters = {}) -> None` - Navigate to the previous route.
56+
- `navigate_back(page: Page, args: Arguments = ()) -> None` - Navigate to the previous route.
5657
- `render(page: Page, args: Arguments = ()) -> None` - Render the current route on the provided page. Must be called only once in the main function.
5758
- `is_virtual() -> bool` - Check if the navigator is virtual.
5859

@@ -149,7 +150,7 @@ def homepage_setter(pg: PageData, args: Arguments) -> None:
149150

150151
pg.add(FilledButton(
151152
'Submit new homepage',
152-
on_click=lambda _: pg.navigator.set_homepage(hp.value)
153+
on_click=lambda _: pg.set_homepage(hp.value)
153154
))
154155

155156
# --- Local Template Definition ---

0 commit comments

Comments
 (0)