Admin UI SDK configuration

data-variant=info

data-slots=text
This feature is in Beta and is subject to change.

The adminUiSdk field in your app.commerce.config file allows you to configure the menu items managed by the Adobe Commerce Admin UI SDK.

The registration field allows you to declare menu items that will be registered in the Adobe Commerce Admin UI when your application is installed. Menu items can be top-level or nested under a parent menu item.

Example

The following example shows how to register two menu items, "Apps" and "First App on App Builder", where "First App on App Builder" is nested under "Apps":

import { defineConfig } from "@adobe/aio-commerce-lib-app/config"

export default defineConfig({
  metadata: {
    // ...
  },
  adminUiSdk: {
    registration: {
        menuItems: [
        {
          id: `purchase-approval::first`,
          title: 'First App on App Builder',
          parent: `purchase-approval::apps`,
          sortOrder: 1
        },
        {
          id: `purchase-approval::apps`,
          title: 'Apps',
          isSection: true,
          sortOrder: 100
        }
      ],
    },
  },
});
Property
Type
Required
Description
id
string
Yes
Unique identifier for the menu item.
isSection
boolean
No
When true, the menu item acts as a section header rather than a navigable link.
parent
string
No
The parent menu item identifier, used to nest this item under an existing menu.
sandbox
string
No
The sandbox URL to load when the menu item is clicked.
sortOrder
number
No
Numeric value that determines the position of the menu item relative to its siblings.
title
string
No
Display title for the menu item.