stas-prokopiev/ipyvuetify_app

Templates for ipyvuetify web apps.

ipyvuetify_app

Table of Contents

• Short Overview.
  • Examples how your app can look like
  • A few more examples how header navigation works
• Installation via pip:
• How to use it
  • How to write a Router
    • Simple Router example
  • Full VuaApp signature
  • VuaApp object description
    • Useful Attributes:
    • Useful Methods:
• Links
• Project local Links
• Contacts
• License

Short Overview.

ipyvuetify_app is a python package (py>=3.7) with a simple template for writing ipyvuetify application

Examples how your app can look like

Application from the box supports theme switcher and navigation over different content by menus on top

A few more examples how header navigation works

Installation via pip:

pip install ipyvuetify_app

How to use it

To create an application by the given template you need to create a routing class

That will be in charge of what to show in the main application section

For every selected menu item -> subitem

Then you just give the router to ipyvuetify_app.VueApp(...) and it does all the magic for you

from ipyvuetify_app import VueApp
from ipyvuetify_app import VueAppRouter

vue_app_router_example = VueAppRouter()
VueApp(vue_app_router_example)

How to write a Router

Every router should satisfy 2 conditions:

1) It has method get_main_content(self, item, subitem) which should return page's main content

2) It has attribute self.dict_list_subitems_by_item with all subitems for every menu item

Simple Router example

class VueAppRouter():

    def __init__(self):
        self.dict_list_subitems_by_item = {}
        for item in range(5):
            list_subitems = [str(subitem) for subitem in range(item, 5 + item)]
            self.dict_list_subitems_by_item[str(item)] = list_subitems

    def get_main_content(self, item, subitem):
        return f"{item} -> {subitem}"

Full VuaApp signature

VueApp(
    vue_app_router,
    list_vw_fab_app_bar_left=None,
    list_vw_fab_app_bar_right=None,
    list_footer_vw_children=None,
    app_css_style=None,
)

Arguments:

1. list_vw_fab_app_bar_left:

   List with ipyvuetify fab icon buttons to put on the left side of Application Header Bar

2. list_vw_fab_app_bar_right:

   List with ipyvuetify fab icon buttons to put on the right side of Application Header Bar

3. list_footer_vw_children:

   List with ipyvuetify widgets to put in the footer

   If empty then footer is not shown at all

4. app_css_style:

   String with css styles to apply on v.App

VuaApp object description

VuaApp is a child of v.App so it has all the parent methods and attributes

Useful Attributes:

1. self.vw_appbar:

   v.AppBar(app=True, ...) - Application top bar

2. self.vw_navigation_drawer:

   v.NavigationDrawer(app=True, ...) - Navigation Drawer at the left side

3. self.vw_app_main:

   v.Content() - Main section of the application

4. self.vw_footer:

   v.Footer(app=True, ...) - Footer of the application

Useful Methods:

1. self.update_app_routing():

   When router items were updated please call this method to update application menus

Links

• PYPI
• GitHub

Project local Links

• CHANGELOG.
• CONTRIBUTING.

Contacts

• Email: stas.prokopiev@gmail.com
• vk.com
• Facebook

License

This project is licensed under the MIT License.