Skip to main content

Lightweight navigation wrapper for Tkinter

Project description


Lightweight navigation wrapper for Tkinter.


pip install tkinter-nav


Create Some Pages

import tkinter as tk
import tkinter_nav as tknav

class PageOne(tknav.Page):

    def __init__(self, parent):
        tknav.Page.__init__(self, parent, 'name_of_page')

        # Use as any Frame
        # Page extends tk.Frame
        tk.Button(self, ...).pack()

    def page_did_mount(self):

    def page_did_unmount(self):

class PageTwo(tknav.Page):

class PageThree(tknav.Page):

Create your App


class App(tknav.Wrapper):

  def __init__(self):
    pages = [PageOne, PageTwo]

        # Your pages
        # Set inital state, not required
        start_state={'foo': 'bar'}

    # Use as any Tk instance
    # tknav.Wrapper extends tk.Tk
    self.title('My Nav App')

    # Show page

# Run
if __main__ == '__main__':


Navigate Between Pages

  • From the constructor
class PageOne(tknav.Page):

    def __init__(self, parent):

          command=lambda: self.navigate('page_two')
  • From a handler function
class PageOne(tknav.Page):

    def handleClick(self):

Mount and Unmount

  • page_did_mount: When the page is shown
  • page_did_unmount: When the page is hidden

Note: You do not have to use them. They will be defined with a <u>pass</u> statement.

class SomePage(tknav.Page):

    def page_did_mount(self):
      print('Page did mount')

    def page_did_unmount(self):
      print('Page did unmount')

Note: If you are familiar with React, they share the same role as ComponentDidMount and ComponentDidUnmount.


You can set a global state for your app which will enable you to share data between pages.

class App(tknav.Nav):

  def __init__(self):

    self.app_state = {'foo': 'bar'}

class PageOne(tknav.Page):

    def function(self):
      # get a value
      print(self.app_state['foo']) #bar

      # set a new value
      self.app_state['bar'] = 'foo'

When navigate() is called, the local state is merged with the global state.

class PageTwo(tknav.Page):

    def function(self):
      print(self.app_state['bar']) #foo

Note: If you are familiar with React, same principle.


Is this example, we navigated from page_one to page_two to page_one again. The state is printed in page_did_mount() and changed in page_did_unmount().

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tkinter-nav-0.0.5.tar.gz (3.7 kB view hashes)

Uploaded source

Built Distribution

tkinter_nav-0.0.5-py3-none-any.whl (8.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page