Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions admin-ui-sdk/v2/menu/custom-menu/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# package directories
node_modules

# build
build
dist
.manifest-dist.yml

# Config
config.json
.env*
!.env.dist
.aio

# Adobe I/O console config
console.json

.idea
.aws.tmp.creds.json
.parcel-cache
.DS_Store
.vscode
56 changes: 56 additions & 0 deletions admin-ui-sdk/v2/menu/custom-menu/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Custom Menu — Admin UI SDK V2

Adds a custom menu item to the Adobe Commerce Admin panel that opens a page inside your App Builder application.

## What you get

A menu entry, **First App on App Builder**, that opens a custom page in the Commerce Admin. The page displays a welcome message along with the Adobe IMS Org ID of the signed-in admin user, demonstrating how IMS context is made available to your app.

The menu definition lives in `app.commerce.config.ts`. The page component lives in `src/commerce-backend-ui-2/web-src/src/pages/main-page.tsx`.

## How it works

1. Merchant opens the Commerce Admin and selects **First App on App Builder** from the menu
2. Commerce Admin loads your App Builder web app inside an iframe
3. The app resolves the IMS context via the Admin UI SDK and renders the welcome page with the signed-in admin's IMS Org ID

## Prerequisites

- [Node.js](https://nodejs.org/) >= 24
- [Adobe I/O CLI](https://developer.adobe.com/runtime/docs/guides/tools/cli_install/) (`npm install -g @adobe/aio-cli`)
- An App Builder project on [Adobe Developer Console](https://developer.adobe.com/console/) with a workspace configured for your Commerce instance
- Adobe Commerce >= 2.4.7 with the [Admin UI SDK module](https://developer.adobe.com/commerce/extensibility/admin-ui-sdk/) installed and enabled
Comment thread
obarcelonap marked this conversation as resolved.

## Setup

**1. Install dependencies**

```bash
npm install
```

**2. Connect to your App Builder workspace**

```bash
aio console org select
aio console project select
aio console workspace select
aio app use -g --no-input --overwrite
```

**3. Deploy**

```bash
aio app deploy
```

**4. Associate and install on Commerce**

Associate and install the app with your Commerce instance through the App Management UI in the Commerce Admin. See [App Management](https://developer.adobe.com/commerce/extensibility/app-management/) for the full walkthrough.

To verify the installation, navigate to **Stores → Configuration → Adobe Services → Admin UI SDK → Configure Extensions** and check the **Installed Extensions** tab — the app should appear there once successfully installed.

## More information

- [Admin UI SDK — Custom Menu](https://developer.adobe.com/commerce/extensibility/admin-ui-sdk/extension-points/menu/)
- [App Management](https://developer.adobe.com/commerce/extensibility/app-management/)
30 changes: 30 additions & 0 deletions admin-ui-sdk/v2/menu/custom-menu/app.commerce.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/*
* Copyright 2026 Adobe. All rights reserved.
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. You may obtain a copy
* of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
* OF ANY KIND, either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/

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

export default defineConfig({
metadata: {
id: "custommenu",
displayName: "Adobe Commerce custom menu",
version: "1.0.0",
description: "Adobe Commerce custom menu example in admin panel",
},
adminUi: {
menu: {
id: "CustomMenu::first",
label: "First App on App Builder",
pageTitle: "Adobe Commerce First App on App Builder",
description: "First App on App Builder",
},
},
})
8 changes: 8 additions & 0 deletions admin-ui-sdk/v2/menu/custom-menu/app.config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
extensions:
# This extension is required for Admin UI. Do not remove.
commerce/backend-ui/2:
$include: src/commerce-backend-ui-2/ext.config.yaml

# This extension is required for app management. Do not remove.
commerce/extensibility/1:
$include: src/commerce-extensibility-1/ext.config.yaml
13 changes: 13 additions & 0 deletions admin-ui-sdk/v2/menu/custom-menu/install.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
$schema: http://json-schema.org/draft-07/schema
$id: https://adobe.io/schemas/app-builder-templates/1
Comment thread
obarcelonap marked this conversation as resolved.

categories:
- action
- ui

extensions:
# This extension is required for Admin UI. Do not remove.
- extensionPointId: commerce/backend-ui/2

# This extension is required for app management. Do not remove.
- extensionPointId: commerce/extensibility/1
Loading