Admin Widget Injection Zones

This documentation page includes the list of injection zones you can add Admin Widgets to.

Deprecated Suffixes: Before Medusa v2.17.2, injection zone names ended with .before or .after to place the widget at the top or the bottom of the zone. These suffixes are deprecated, and you should use the zone name without the suffix instead.A widget is now added at the end of the zone it's injected into. Admin users can then change its placement, including moving it to the top of the page or in between the page's core components, using Layout Configurations.Widgets that still use the .before or .after suffixes keep rendering, but the suffix no longer changes their placement.

Campaign Pages#

Injection Zone Name

Description

Additional Props

campaign.list

Added at the end of the campaigns list page.

-

campaign.details

Added at the end of a campaign's details page.

Type DetailWidgetProps<AdminCampaign> imported from @medusajs/framework/types

{
  data, // AdminCampaign object
}

campaign.details.side

Added at the end of the second column in the campaign details page.

Type DetailWidgetProps<AdminCampaign> imported from @medusajs/framework/types

{
  data, // AdminCampaign object
}

Customer Pages#

Injection Zone Name

Description

Additional Props

customer.list

Added at the end of the customers list page.

-

customer.details

Added at the end of the customer details page.

Type DetailWidgetProps<AdminCustomer> imported from @medusajs/framework/types

{
  data, // AdminCustomer object
}

Customer Group Pages#

Injection Zone Name

Description

Additional Props

customer_group.list

Added at the end of the customer groups list page.

-

customer_group.details

Added at the end of the customer group details page.

Type DetailWidgetProps<AdminCustomerGroup> imported from @medusajs/framework/types

{
  data, // AdminCustomerGroup object
}

Draft Order Pages#

Note: These widget zones are available starting from Medusa v2.16.0.

Injection Zone Name

Description

Additional Props

draft_order.details

Added at the end of a draft order's details page.

Type DetailWidgetProps<AdminDraftOrder> imported from @medusajs/framework/types

{
  data, // AdminDraftOrder object
}

draft_order.details.side

Added at the end of the side section in a draft order's details page.

Type DetailWidgetProps<AdminDraftOrder> imported from @medusajs/framework/types

{
  data, // AdminDraftOrder object
}

draft_order.list

Added at the end of the draft orders list page.

-


Gift Card Pages#

Note: These widget zones are available starting from Medusa v2.16.0.

Injection Zone Name

Description

Additional Props

gift_card.details

Added at the end of a gift card's details page.

Type DetailWidgetProps<AdminGiftCard> imported from @medusajs/framework/types

{
  data, // AdminGiftCard object
}

gift_card.details.side

Added at the end of the side section in a gift card's details page.

Type DetailWidgetProps<AdminGiftCard> imported from @medusajs/framework/types

{
  data, // AdminGiftCard object
}

gift_card.list

Added at the end of the gift cards list page.

-

gift_card.list.side

Added at the end of the side section in the gift cards list page.

-


Gift Card Product Pages#

Note: These widget zones are available starting from Medusa v2.16.0.

Injection Zone Name

Description

Additional Props

gift_card_product.details

Added at the end of a gift card product's details page.

Type DetailWidgetProps<AdminProduct> imported from @medusajs/framework/types

{
  data, // AdminProduct object
}

gift_card_product.details.side

Added at the end of the side section in a gift card product's details page.

Type DetailWidgetProps<AdminProduct> imported from @medusajs/framework/types

{
  data, // AdminProduct object
}

gift_card_product.list

Added at the end of the gift card products list page.

-


Inventory Pages#

Injection Zone Name

Description

Additional Props

inventory_item.list

Added at the end of the inventory list page.

-

inventory_item.details

Added at the end of the inventory item details page.

Type DetailWidgetProps<AdminInventoryItem> imported from @medusajs/framework/types

{
  data, // AdminInventoryItem object
}

inventory_item.details.side

Added at the end of the second column in the inventory item details page.

Type DetailWidgetProps<AdminInventoryItem> imported from @medusajs/framework/types

{
  data, // AdminInventoryItem object
}

Login Page#

Note: The login page isn't part of the dashboard's layout configurations, so its zones still use the .before and .after suffixes to place the widget relative to the login form.

Injection Zone Name

Description

Additional Props

login.before

Added before the login form.

-

login.after

Added after the login form.

-


Order Pages#

Injection Zone Name

Description

Additional Props

order.list

Added at the end of the order list page.

-

order.details

Added at the end of the order details page.

Type DetailWidgetProps<AdminOrder> imported from @medusajs/framework/types

{
  data, // AdminOrder object
}

order.details.side

Added at the end of the second column in the order details page.

Type DetailWidgetProps<AdminOrder> imported from @medusajs/framework/types

{
  data, // AdminOrder object
}

Price List Pages#

Injection Zone Name

Description

Additional Props

price_list.list

Added at the end of the Pricing list page.

-

price_list.details

Added at the end of a price list's details page.

Type DetailWidgetProps<AdminPriceList> imported from @medusajs/framework/types

{
  data, // AdminPriceList object
}

price_list.details.side

Added at the end of the second column in the price list details page.

Type DetailWidgetProps<AdminPriceList> imported from @medusajs/framework/types

{
  data, // AdminPriceList object
}

Product Pages#

Injection Zone Name

Description

Additional Props

product.list

Added at the end of the products list page.

-

product.details

Added at the end of the product details page

Type DetailWidgetProps<AdminProduct> imported from @medusajs/framework/types

{
  data, // AdminProduct object
}

product.details.side

Added at the end of the second column in the product details page.

Type DetailWidgetProps<AdminProduct> imported from @medusajs/framework/types

{
  data, // AdminProduct object
}

Product Variant Pages#

Note: This injection zone is only available after Medusa v2.0.5.

Injection Zone Name

Description

Additional Props

product_variant.details

Added at the end of the product variant details page

Type DetailWidgetProps<AdminProductVariant> imported from @medusajs/framework/types

{
  data, // AdminProductVariant object
}

product_variant.details.side

Added at the end of the second column in the product variant details page.

Type DetailWidgetProps<AdminProductVariant> imported from @medusajs/framework/types

{
  data, // AdminProductVariant object
}

Product Collection Pages#

Injection Zone Name

Description

Additional Props

product_collection.list

Added at the end of the product collections list page.

-

product_collection.details

Added at the end of the product collection details page.

Type DetailWidgetProps<AdminProductCollection> imported from @medusajs/framework/types

{
  data, // AdminProductCollection object
}

Product Category Pages#

Injection Zone Name

Description

Additional Props

product_category.list

Added at the end of the product categories list page.

-

product_category.details

Added at the end of the product category details page.

Type DetailWidgetProps<AdminProductCategory> imported from @medusajs/framework/types

{
  data, // AdminProductCategory object
}

product_category.details.side

Added at the end of the second column in the product category details page.

Type DetailWidgetProps<AdminProductCategory> imported from @medusajs/framework/types

{
  data, // AdminProductCategory object
}

Promotion Pages#

Injection Zone Name

Description

Additional Props

promotion.list

Added at the end of the promotions list page.

-

promotion.details

Added at the end of a promotion's details page.

Type DetailWidgetProps<AdminPromotion> imported from @medusajs/framework/types

{
  data, // AdminPromotion object
}

promotion.details.side

Added at the end of the second column in the promotion details page.

Type DetailWidgetProps<AdminPromotion> imported from @medusajs/framework/types

{
  data, // AdminPromotion object
}

Store Credit Account Pages#

Note: These widget zones are available starting from Medusa v2.16.0.

Injection Zone Name

Description

Additional Props

store_credit_account.details

Added at the end of a store credit account's details page.

Type DetailWidgetProps<AdminStoreCreditAccount> imported from @medusajs/framework/types

{
  data, // AdminStoreCreditAccount object
}

store_credit_account.details.side

Added at the end of the side section in a store credit account's details page.

Type DetailWidgetProps<AdminStoreCreditAccount> imported from @medusajs/framework/types

{
  data, // AdminStoreCreditAccount object
}

store_credit_account.list

Added at the end of the store credit accounts list page.

-


Setting Pages#

API Key Pages#

Injection Zone Name

Description

Additional Props

api_key.list

Added at the end of the API keys list page.

-

api_key.details

Added at the end of a API key's details page.

Type DetailWidgetProps<AdminApiKey> imported from @medusajs/framework/types

{
  data, // AdminApiKey object
}

Location Pages#

Injection Zone Name

Description

Additional Props

location.list

Added at the end of the locations list page.

-

location.list.side

Added at the end of the second column in the locations list page. This injection zone is available since Medusa v2.7.0.

-

location.details

Added at the end of a location's details page.

Type DetailWidgetProps<AdminStockLocation> imported from @medusajs/framework/types

{
  data, // AdminStockLocation object
}

location.details.side

Added at the end of the second column in the location details page.

Type DetailWidgetProps<AdminStockLocation> imported from @medusajs/framework/types

{
  data, // AdminStockLocation object
}

Profile Pages#

Injection Zone Name

Description

Additional Props

profile.details

Added at the end of a profile's details page.

Type DetailWidgetProps<AdminUser> imported from @medusajs/framework/types

{
  data, // AdminUser object
}

Region Pages#

Injection Zone Name

Description

Additional Props

region.list

Added at the end of the regions list page.

-

region.details

Added at the end of a region's details page.

Type DetailWidgetProps<AdminRegion> imported from @medusajs/framework/types

{
  data, // AdminRegion object
}

Reservation Pages#

Injection Zone Name

Description

Additional Props

reservation.list

Added at the end of the reservations list page.

-

reservation.details

Added at the end of a reservation item's details page.

Type DetailWidgetProps<AdminReservation> imported from @medusajs/framework/types

{
  data, // AdminReservation object
}

reservation.details.side

Added at the end of the second column in the reservation item details page.

Type DetailWidgetProps<AdminReservation> imported from @medusajs/framework/types

{
  data, // AdminReservation object
}

Return Reason Pages#

Injection Zone Name

Description

Additional Props

return_reason.list

Added at the end of the return reasons list page.

-

Sales Channel Pages#

Injection Zone Name

Description

Additional Props

sales_channel.list

Added at the end of the sales channels list page.

-

sales_channel.details

Added at the end of a sales channel's details page.

Type DetailWidgetProps<AdminSalesChannel> imported from @medusajs/framework/types

{
  data, // AdminSalesChannel object
}

Shipping Option Type Pages#

Note: The following injection zones are available from Medusa v2.10.0

Injection Zone Name

Description

Additional Props

shipping_option_type.list

Added at the end of the shipping option types list page.

-

shipping_option_type.details

Added at the end of a shipping option type's details page.

Type DetailWidgetProps<AdminShippingOptionType> imported from @medusajs/framework/types

{
  data, // AdminShippingOptionType object
}

Shipping Profile Pages#

Injection Zone Name

Description

Additional Props

shipping_profile.list

Added at the end of the shipping profiles list page.

-

shipping_profile.details

Added at the end of a shipping profile's details page.

Type DetailWidgetProps<AdminShippingProfile> imported from @medusajs/framework/types

{
  data, // AdminShippingProfile object
}

Store Pages#

Injection Zone Name

Description

Additional Props

store.details

Added at the end of a store's details page.

Type DetailWidgetProps<AdminStore> imported from @medusajs/framework/types

{
  data, // AdminStore object
}

Tax Pages#

Injection Zone Name

Description

Additional Props

tax.list

Added at the end of the tax regions list page.

-

tax.details

Added at the end of a tax region's details page.

Type DetailWidgetProps<AdminTaxRegion> imported from @medusajs/framework/types

{
  data, // AdminTaxRegion object
}

User Pages#

Injection Zone Name

Description

Additional Props

user.list

Added at the end of the users list page.

-

user.details

Added at the end of a user's details page.

Type DetailWidgetProps<AdminUser> imported from @medusajs/framework/types

{
  data, // AdminUser object
}

Property Label Pages#

Note: These widget zones are available starting from Medusa v2.18.0.

Injection Zone Name

Description

Additional Props

property_label.list

Added in the property labels list page.

-

Workflow Pages#

Injection Zone Name

Description

Additional Props

workflow.list

Added at the end of the workflows list page.

-

workflow.details

Added at the end of a workflow execution's details page.

Type DetailWidgetProps<AdminWorkflowExecution> imported from @medusajs/framework/types

{
  data, // AdminWorkflowExecution object
}

Top Bar#

Note: The Top Bar is the navigation bar at the top of the admin dashboard. You can add widgets to it using the topbar injection zone, such as to add a button to the top bar. The following zones are available since Medusa v2.17.2.

Injection Zone Name

Description

Additional Props

topbar

Added to the top bar of the admin dashboard.

-

Was this page helpful?
Ask Bloom
For assistance in your development, use Claude Code Plugins or Medusa MCP server in Cursor, VSCode, etc...FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break