[Feature Request] Expose placement name for Customer Account UI extensions

Extensions
, , ,
1

Hi Shopify team,

I’m working with a Customer Account UI extension and I’ve run into a limitation around understanding where my extension is placed on the page.

Currently, from the extension API, I can access extension.target (for example, customer-account.profile.block.render, customer-account.order-status.announcement.render, etc.). However, I can’t see which placement within that target has been chosen in the editor.

For many use cases, I don’t need detailed layout information or ordering. I primarily need a simple, stable placement name that reflects where the merchant has put the extension within the UI.

Core request:

Add an API that exposes a placement identifier, for example:

extension.placement = {
  name: string; // e.g. PAGE_TITLE, ORDER_STATUS1, ORDER_STATUS2, ORDER_STATUS3, ORDER_SUMMARY1, ORDER_SUMMARY2, ORDER_SUMMARY3 or another stable placement name
};

Even a single string like extension.placementName would be enough for me to:

  • Adjust layout or content density based on where the extension appears
  • Hide or show certain UI elements depending on whether I’m in a primary vs. secondary area
  • Provide better analytics on how the extension is being used across placements

Optional enhancement (nice to have, not required):

In the future, it could be helpful if this placement object also included optional details like order/position within the container, but that’s secondary. The main need is just a reliable placement name.

If there’s already a way to access this information, I’d really appreciate a pointer to the docs. Otherwise, I’d love for this to be considered in a future Customer Account UI Extensions update.

Thanks!

2

Hi @muchisx!

You picked a good time to raise this since we’re currently working on customer account improvements.

Static targets provide a reliable indication of where an extension renders, but it’s much harder to determine where an extension renders with dynamic targets. I’ll share this request with the relevant team for consideration, although I can’t promise whether it will be implemented.

I also noticed that you tagged several other extension types. Would this functionality be useful to you on those surfaces as well, or is your request specific to Customer Account UI extensions?

4

Hi @Paige-Shopify thank you for the response, it’s great to know the customer account improvements is still ongoing!

I tagged the other extensions because in the surface it seems like the share a similar API for communicating with the underlying renderers (the global shopify). So I thought if it came to the Customer Accounts it could very well be available in the other surfaces.

My current priority remains the Customer Accounts though!

5

Good to know, thanks for clarifying. I mainly wanted to cover my bases and confirm whether this was a broader need. I’ll note that Customer Accounts is your priority.

We try to keep the underlying mechanisms across UI extension surfaces as consistent as possible, so if this functionality is introduced there, it would likely inform similar functionality on the other surfaces over time.