Extension Targets

Many Dashboard extension APIs target existing UI by ID:

• pageId identifies the page.
• blockId identifies a page block or data table block.
• itemId identifies an action bar item or toolbar item.
• Navigation sections and items have their own id values.

Dev Mode is the source of truth for these IDs. This page lists common built-in targets so that you can find the right extension point faster.

Built-in List Page IDs

Standard data table list pages use blockId: 'list-table' for their main table unless noted otherwise.

Use the main block ID for pageBlocks. Use dataTables only for table-backed blocks such as list-table or product-variants-table.

Common Detail Page IDs

Most generated-style detail pages use blockId: 'main-form' for their main form and blockId: 'custom-fields' for custom fields.

Common Block IDs

For data table extensions, blockId targets the table block. For page block extensions, location.position.blockId targets the block you want to place your block before, after, or in place of.

Common Action Bar Item IDs

Use these IDs in actionBarItems[].position.itemId.

Toolbar Item IDs

Use these IDs in toolbarItems[].position.itemId.

Navigation Section IDs

The Insights entry has the ID insights, but it is a top-level navigation item, not an appendable section. Do not use it as routes[].navMenuItem.sectionId.

Common navigation item IDs include products, product-variants, option-groups, facets, collections, assets, orders, customers, customer-groups, promotions, sellers, channels, stock-locations, administrators, roles, shipping-methods, payment-methods, tax-categories, tax-rates, countries, zones, global-settings, job-queue, scheduled-tasks, settings-store, and api-keys.

Use route navMenuItem.sectionId to add a route to a section. Use function-form navSections to move, remove, or rename existing navigation entries.