├── .gitignore ├── LICENSE ├── README.md ├── State.py ├── assets └── banner.png ├── main.py ├── requirements.txt ├── user_controls └── app_bar.py └── views ├── Router.py ├── data_view.py ├── index_view.py ├── profile_view.py ├── routes.py └── settings_view.py /.gitignore: -------------------------------------------------------------------------------- 1 | venv 2 | __pycache__ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Flet Routing Tutorial 2 | 3 | A video on how I use Flet's routing system 4 | 5 | ## Main Branch 6 | 7 | This shows the current example which is up to date with the tutorial explaining how to persist data accross views [Persisting Data Tutorial](https://youtu.be/7AuRgCSOAZM) 8 | 9 | ## Video1 Branch 10 | 11 | This branch shows the code after the first video [Routing in Flet with Python in 3 Min](https://www.youtube.com/watch?v=tvysK9zWbIM) 12 | -------------------------------------------------------------------------------- /State.py: -------------------------------------------------------------------------------- 1 | class GlobalState: 2 | def __init__(self): 3 | self._state = dict() 4 | 5 | def register_state(self, state): 6 | self._state[state.get_key()] = state 7 | 8 | def get_state_by_key(self, key: str): 9 | return self._state.get(key) 10 | 11 | global_state = GlobalState() 12 | 13 | class State: 14 | def __init__(self, key: str, value=None): 15 | self._global_state = global_state 16 | self._key = key 17 | self._value = value 18 | self.register_with_global() 19 | 20 | def register_with_global(self): 21 | self._global_state.register_state(self) 22 | 23 | def get_key(self): 24 | return self._key 25 | 26 | def get_state(self): 27 | return self._value 28 | -------------------------------------------------------------------------------- /assets/banner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codingjq/flet-routing-tutorial/f0dceebfd16aa6f9e8f127bffa0896070d0873bc/assets/banner.png -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | import flet as ft 2 | from views.routes import router 3 | from user_controls.app_bar import NavBar 4 | 5 | def main(page: ft.Page): 6 | 7 | page.theme_mode = "dark" 8 | page.appbar = NavBar(page) 9 | page.on_route_change = router.route_change 10 | router.page = page 11 | page.add( 12 | router.body 13 | ) 14 | page.go('/') 15 | 16 | ft.app(target=main, assets_dir="assets") -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/codingjq/flet-routing-tutorial/f0dceebfd16aa6f9e8f127bffa0896070d0873bc/requirements.txt -------------------------------------------------------------------------------- /user_controls/app_bar.py: -------------------------------------------------------------------------------- 1 | import flet as ft 2 | 3 | 4 | def NavBar(page): 5 | 6 | 7 | 8 | NavBar = ft.AppBar( 9 | leading=ft.Icon(ft.icons.TAG_FACES_ROUNDED), 10 | leading_width=40, 11 | title=ft.Text("Flet Router"), 12 | center_title=False, 13 | bgcolor=ft.colors.SURFACE_VARIANT, 14 | actions=[ 15 | ft.IconButton(ft.icons.HOME, on_click=lambda _: page.go('/')), 16 | ft.IconButton(ft.icons.PERSON_ROUNDED, on_click=lambda _: page.go('/profile')), 17 | ft.IconButton(ft.icons.SETTINGS_ROUNDED, on_click=lambda _: page.go('/settings')) 18 | ] 19 | ) 20 | 21 | return NavBar 22 | -------------------------------------------------------------------------------- /views/Router.py: -------------------------------------------------------------------------------- 1 | from typing import Callable, Any 2 | import flet as ft 3 | from enum import Enum 4 | 5 | class DataStrategyEnum(Enum): 6 | QUERY = 0 7 | ROUTER_DATA = 1 8 | CLIENT_STORAGE = 2 9 | STATE = 3 10 | 11 | class Router: 12 | def __init__(self, data_strategy=DataStrategyEnum.QUERY): 13 | self.data_strategy = data_strategy 14 | self.data = dict() 15 | self.routes = {} 16 | self.body = ft.Container() 17 | 18 | def set_route(self, stub: str, view: Callable): 19 | self.routes[stub] = view 20 | 21 | def set_routes(self, route_dictionary: dict): 22 | """Sets multiple routes at once. Ex: {"/": IndexView }""" 23 | self.routes.update(route_dictionary) 24 | 25 | def route_change(self, route): 26 | _page = route.route.split("?")[0] 27 | queries = route.route.split("?")[1:] 28 | 29 | for item in queries: 30 | key = item.split("=")[0] 31 | value = item.split("=")[1] 32 | self.data[key] = value.replace('+', ' ') 33 | 34 | self.body.content = self.routes[_page](self) 35 | self.body.update() 36 | 37 | def set_data(self, key, value): 38 | self.data[key] = value 39 | 40 | def get_data(self, key): 41 | return self.data.get(key) 42 | 43 | def get_query(self, key): 44 | return self.data.get(key) 45 | 46 | -------------------------------------------------------------------------------- /views/data_view.py: -------------------------------------------------------------------------------- 1 | from typing import Union 2 | import flet as ft 3 | from views.Router import Router, DataStrategyEnum 4 | from State import global_state 5 | 6 | def DataView(router: Union[Router, str, None] = None): 7 | text = ft.Text("") 8 | 9 | if router and router.data_strategy == DataStrategyEnum.QUERY: 10 | text = ft.Text("Query Data: " + router.get_query("data")) 11 | elif router and router.data_strategy == DataStrategyEnum.ROUTER_DATA: 12 | text = ft.Text("Router Data: " + router.get_data("data")) 13 | elif router and router.data_strategy == DataStrategyEnum.CLIENT_STORAGE: 14 | text = ft.Text("Client Storage: " + router.page.client_storage.get("data")) 15 | elif router and router.data_strategy == DataStrategyEnum.STATE: 16 | text = ft.Text("State: " + global_state.get_state_by_key("data").get_state()) 17 | content = ft.Column( 18 | [ 19 | ft.Row( 20 | [ 21 | ft.Text( 22 | "Data View", 23 | size=50), 24 | ], 25 | alignment=ft.MainAxisAlignment.CENTER 26 | ), 27 | ft.Row( 28 | [ 29 | text, 30 | ], 31 | alignment=ft.MainAxisAlignment.CENTER 32 | ) 33 | ] 34 | ) 35 | return content 36 | 37 | -------------------------------------------------------------------------------- /views/index_view.py: -------------------------------------------------------------------------------- 1 | from typing import Union 2 | import flet as ft 3 | from views.Router import Router, DataStrategyEnum 4 | from State import global_state, State 5 | 6 | def IndexView(router_data: Union[Router, str, None] = None): 7 | 8 | def send_data(e: ft.ControlEvent): 9 | if text_field.value == "": 10 | return 11 | if router_data and router_data.data_strategy == DataStrategyEnum.QUERY: 12 | e.page.go("/data", data=text_field.value) 13 | elif router_data and router_data.data_strategy == DataStrategyEnum.ROUTER_DATA: 14 | router_data.set_data("data", text_field.value) 15 | e.page.go("/data", data=text_field.value) 16 | elif router_data and router_data.data_strategy == DataStrategyEnum.CLIENT_STORAGE: 17 | e.page.client_storage.set("data", text_field.value) 18 | e.page.go("/data") 19 | elif router_data and router_data.data_strategy == DataStrategyEnum.STATE: 20 | state = State("data", text_field.value) 21 | e.page.go("/data") 22 | else: 23 | e.page.go("/data") 24 | 25 | text_field = ft.TextField() 26 | send_button = ft.ElevatedButton("Send") 27 | send_button.on_click = send_data 28 | content = ft.Column( 29 | [ 30 | ft.Row( 31 | [ 32 | ft.Text( 33 | "Welcome to my Flet Router Tutorial", 34 | size=50), 35 | ], 36 | alignment=ft.MainAxisAlignment.CENTER 37 | ), 38 | ft.Row( 39 | [ 40 | text_field, 41 | send_button 42 | ], 43 | alignment=ft.MainAxisAlignment.CENTER 44 | ) 45 | ] 46 | ) 47 | 48 | return content 49 | 50 | 51 | -------------------------------------------------------------------------------- /views/profile_view.py: -------------------------------------------------------------------------------- 1 | 2 | import flet as ft 3 | 4 | def ProfileView(router): 5 | 6 | content = ft.Column( 7 | 8 | [ 9 | ft.Row( 10 | [ 11 | ft.Text("My Profile", size=30), 12 | ft.IconButton(icon=ft.icons.PERSON_ROUNDED, icon_size=30), 13 | ], 14 | alignment=ft.MainAxisAlignment.CENTER 15 | ), 16 | ft.Row( 17 | [ 18 | ft.Image(src=f"/banner.png", width=200, border_radius=100) 19 | ], 20 | alignment=ft.MainAxisAlignment.CENTER 21 | ), 22 | ft.Row( 23 | [ 24 | ft.Text("Name: CodingJQ") 25 | ], 26 | ), 27 | ft.Row( 28 | [ 29 | ft.Text("Member Since: 2023") 30 | ] 31 | ), 32 | ft.Row( 33 | [ 34 | ft.Text("Github: https://github.com/CodingJQ") 35 | ] 36 | ) 37 | 38 | ] 39 | ) 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | return content -------------------------------------------------------------------------------- /views/routes.py: -------------------------------------------------------------------------------- 1 | from views.Router import Router, DataStrategyEnum 2 | from views.index_view import IndexView 3 | from views.profile_view import ProfileView 4 | from views.settings_view import SettingsView 5 | from views.data_view import DataView 6 | 7 | router = Router(DataStrategyEnum.QUERY) 8 | 9 | router.routes = { 10 | "/": IndexView, 11 | "/profile": ProfileView, 12 | "/settings": SettingsView, 13 | "/data": DataView 14 | } -------------------------------------------------------------------------------- /views/settings_view.py: -------------------------------------------------------------------------------- 1 | 2 | import flet as ft 3 | 4 | def SettingsView(router): 5 | 6 | def toggle_dark_mode(e): 7 | page = e.page 8 | if page.theme_mode == "dark": 9 | page.theme_mode = "light" 10 | page.update() 11 | else: 12 | page.theme_mode = "dark" 13 | page.update() 14 | 15 | def exit_app(e): 16 | page = e.page 17 | page.window_destroy() 18 | 19 | content = ft.Column( 20 | 21 | [ 22 | ft.Row( 23 | [ 24 | ft.Text("My Settings", size=30), 25 | ft.IconButton(icon=ft.icons.SETTINGS_ROUNDED, icon_size=30), 26 | 27 | ], 28 | alignment=ft.MainAxisAlignment.CENTER 29 | ), 30 | ft.Row( 31 | [ 32 | ft.TextButton("Light/Dark Mode", icon=ft.icons.WB_SUNNY_OUTLINED, on_click=toggle_dark_mode) 33 | ], 34 | ), 35 | ft.Row( 36 | [ 37 | ft.TextButton("Exit Application", icon=ft.icons.CLOSE, on_click=exit_app, icon_color="red") 38 | ] 39 | ), 40 | ] 41 | ) 42 | 43 | 44 | return content 45 | --------------------------------------------------------------------------------