Download

Menu Schema

Menu Schema defines the navigation structure of the administrative panel. It allows you to configure top and side menu items, nested items, icons, and access restrictions.

The menu is automatically filtered based on the permissions available to the user.

Property Type Description
top array Top menu items
side array Side menu items

Each menu item is an object with the following structure:

Property Type Description
title * string Menu item title
href string Page address opened when the item is clicked
required_permissions array Permission articles required to display the item. If empty, no permission restriction is applied
children array Nested menu items
icon string Icon article

For example:


{
    "title": "Employees",
    "href": "users",
    "required_permissions": ["menu_users"],
    "required_modules": [],
    "children": [],
    "icon": "user"
}

In this case, the Employees menu item is displayed only to users who have the menu_users permission.

children

Contains nested menu items. This allows you to create multi-level navigation.

For example:


{
    "title": "Settings",
    "href": "settings",
    "children": [
        {
            "title": "Roles",
            "href": "roles",
            "required_permissions": []
        },
        {
            "title": "Lead Tags",
            "href": "leadTags",
            "required_permissions": []
        }
    ],
    "icon": "gear"
}

As a result, the Settings item contains two nested items:


Settings
├── Roles
└── Lead Tags

icon

Contains the icon article displayed next to the menu item.

List of available icons:

account-1
account-2
account
add-to-cart
address
arrow
arrow_2
basket
bird-house
bullet-list
caldron
calendar
chat
close
conversation
customers
cutlery
dashboard
delivery-service
delivery
desktop
details
dollar
door
dots-vertical
dove
download
e-commerce
edit
fast-delivery
files
first-aid-kit
flock
garage
gear
gift
glasses
handshake
health
hot-food
id-card
image-1
image
info
justify-left
lab
list
location-1
location-2
location
malware
measurement
megaphone
more
nest
next
night
notification
nut
pause
performance
phone
phone_call
play-button
play
plus
pointer
previous
print
profile
publication
purchase
question
questions
ranking
reading
repeat
rgb
schedule
shipping-van
shopping-basket
shopping-cart
sort
stethoscope
sun
surgical-instrument
t-shirt
tag-2
tag
time
trash-2
trash
upload
user
volume_off
volume_on
woodpecker