Welcome to Tekio Menu Package! #

Welcome to Tekio Menu.

This package allows you to build a complex menus with just a json.

How to use #

TekioBaseMenuBuilder(
    baseMenuData: BaseMenuModel.fromJson(YOUR JSON CONFIG),
    navigateTo: (path) => USE YOUR NAVIGATION PACKAGE,
),

Example #

This is a json example:

{
   "menuKey":"menuKeyExample",
   "menuListButtons":[
      {
         "order":0,
         "menuButtonKey":"menuButtonKeyExample1",
         "buttonType":"iconCarousel",
         "menuButtonHeight":100.0,
         "buttonItems":[
            {
               "order":0,
               "buttonKey":"buttonKeyExample1",
               "iconCode":"0xe6a1",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":1,
               "buttonKey":"buttonKeyExample2",
               "iconCode":"0xe37b",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":2,
               "buttonKey":"buttonKeyExample3",
               "iconCode":"0xe656",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":3,
               "buttonKey":"buttonKeyExample4",
               "iconCode":"0xe6e7",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":4,
               "buttonKey":"buttonKeyExample5",
               "iconCode":"0xe378",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":5,
               "buttonKey":"buttonKeyExample6",
               "iconCode":"0xf0794",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":6,
               "buttonKey":"buttonKeyExample7",
               "iconCode":"0xe3d8",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":7,
               "buttonKey":"buttonKeyExample8",
               "iconCode":"0xe047",
               "label":"label_example",
               "navPath":"/pathToScreen"
            }
         ]
      },
      {
         "order":1,
         "menuButtonKey":"menuButtonKeyExample2",
         "buttonType":"textCarousel",
         "menuButtonHeight":60.0,
         "buttonItems":[
            {
               "order":0,
               "buttonKey":"buttonKeyExample9",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":1,
               "buttonKey":"buttonKeyExample10",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":2,
               "buttonKey":"buttonKeyExample11",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":3,
               "buttonKey":"buttonKeyExample12",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":4,
               "buttonKey":"buttonKeyExample13",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":5,
               "buttonKey":"buttonKeyExample14",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":6,
               "buttonKey":"buttonKeyExample15",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":7,
               "buttonKey":"buttonKeyExample16",
               "label":"label_example",
               "navPath":"/pathToScreen"
            }
         ]
      },
      {
         "order":2,
         "menuButtonKey":"menuButtonKeyExample3",
         "buttonType":"imageCarousel",
         "menuButtonHeight":200.0,
         "menuButtonWidth":330.0,
         "buttonItems":[
            {
               "order":0,
               "buttonKey":"buttonKeyExample17",
               "imageUrl":"https://flutter.github.io/assets-for-api-docs/assets/material/content_based_color_scheme_1.png",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":1,
               "buttonKey":"buttonKeyExample18",
               "imageUrl":"https://flutter.github.io/assets-for-api-docs/assets/material/content_based_color_scheme_2.png",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":2,
               "buttonKey":"buttonKeyExample19",
               "imageUrl":"https://flutter.github.io/assets-for-api-docs/assets/material/content_based_color_scheme_3.png",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":3,
               "buttonKey":"buttonKeyExample20",
               "imageUrl":"https://flutter.github.io/assets-for-api-docs/assets/material/content_based_color_scheme_4.png",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":4,
               "buttonKey":"buttonKeyExample21",
               "imageUrl":"https://flutter.github.io/assets-for-api-docs/assets/material/content_based_color_scheme_5.png",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":5,
               "buttonKey":"buttonKeyExample22",
               "imageUrl":"https://flutter.github.io/assets-for-api-docs/assets/material/content_based_color_scheme_6.png",
               "label":"label_example",
               "navPath":"/pathToScreen"
            }
         ]
      },
      {
         "order":3,
         "menuButtonKey":"menuButtonKeyExample4",
         "buttonType":"imageButton",
         "menuButtonHeight":200.0,
         "buttonItems":[
            {
               "order":0,
               "buttonKey":"buttonKeyExample23",
               "imageUrl":"https://flutter.github.io/assets-for-api-docs/assets/material/content_based_color_scheme_1.png",
               "label":"label_example",
               "navPath":"/pathToScreen"
            }
         ]
      },
      {
         "order":4,
         "menuButtonKey":"menuButtonKeyExample5",
         "buttonType":"imageButton",
         "menuButtonHeight":200.0,
         "buttonItems":[
            {
               "order":0,
               "buttonKey":"buttonKeyExample24",
               "imageUrl":"https://flutter.github.io/assets-for-api-docs/assets/material/content_based_color_scheme_1.png",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":1,
               "buttonKey":"buttonKeyExample25",
               "imageUrl":"https://flutter.github.io/assets-for-api-docs/assets/material/content_based_color_scheme_2.png",
               "label":"label_example",
               "navPath":"/pathToScreen"
            }
         ]
      },
      {
         "order":5,
         "menuButtonKey":"menuButtonKeyExample6",
         "buttonType":"imageButton",
         "menuButtonHeight":150.0,
         "buttonItems":[
            {
               "order":0,
               "buttonKey":"buttonKeyExample26",
               "imageUrl":"https://flutter.github.io/assets-for-api-docs/assets/material/content_based_color_scheme_1.png",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":1,
               "buttonKey":"buttonKeyExample27",
               "imageUrl":"https://flutter.github.io/assets-for-api-docs/assets/material/content_based_color_scheme_2.png",
               "label":"label_example",
               "navPath":"/pathToScreen"
            },
            {
               "order":2,
               "buttonKey":"buttonKeyExample28",
               "imageUrl":"https://flutter.github.io/assets-for-api-docs/assets/material/content_based_color_scheme_3.png",
               "label":"label_example",
               "navPath":"/pathToScreen"
            }
         ]
      }
   ]
}

Documentations #

You can find the package documentation here: documentation