Skip to main content

AdminNavItem

activebooleanrequired
childrenundefined[]nullable
configSatisfiedbooleanrequired

Whether the RequiresConfig gate is currently truthy

declaredOrderint64required

Sibling index as declared in the module's NavItems()

effectiveOrderint64required

Sibling index after applying persisted overrides

groupstring

Legacy v1 group label

iconstring

Icon identifier

itemKeystringrequired

Stable identifier; persisted overrides reference this

minRolestring

Lowest system role that sees this item

moduleEnabledbooleanrequired

Whether the owning module is enabled right now

moduleNamestringrequired

Owning module

namestringrequired

Display name

overriddenbooleanrequired

True when EffectiveOrder differs from DeclaredOrder

pathstring

Route the item navigates to

realmstring
requiresConfigstring

Module config key that must be truthy for this item to appear

sectionstring
tierstring

internal | external | '' (both)

visibility object

Effective visibility per role, split by tenant kind

property name* NavRoleVisibility
external objectrequired
reasonstring

Why hidden: module_disabled | config_off | tier_mismatch | role_below_min | parent_collapsed

visiblebooleanrequired
internal objectrequired
reasonstring

Why hidden: module_disabled | config_off | tier_mismatch | role_below_min | parent_collapsed

visiblebooleanrequired
AdminNavItem
{
"active": true,
"children": "Unknown Type: array,null",
"configSatisfied": true,
"declaredOrder": 0,
"effectiveOrder": 0,
"group": "string",
"icon": "string",
"itemKey": "string",
"minRole": "string",
"moduleEnabled": true,
"moduleName": "string",
"name": "string",
"overridden": true,
"path": "string",
"realm": "string",
"requiresConfig": "string",
"section": "string",
"tier": "string",
"visibility": {}
}