Skip to content

docs(advanced-extensions): document PIM context postMessage for custom components#1231

Open
gwendalaubert wants to merge 1 commit into
masterfrom
DXIM-694
Open

docs(advanced-extensions): document PIM context postMessage for custom components#1231
gwendalaubert wants to merge 1 commit into
masterfrom
DXIM-694

Conversation

@gwendalaubert

@gwendalaubert gwendalaubert commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add a "PIM context changes" section to advanced-extensions/sdk-in-depth.md documenting the postMessage mechanism custom components can use to track the currently selected locale/channel (load, on-change, and on-demand via request_context), mirroring the existing iframe docs.
  • Note in extensions/iframe.md that the context message is also sent once when the iframe first loads.

Documents DXIM-694 / SDS-56211, implemented in pim-enterprise-dev#39480.

Test plan

  • Build the docs site (make serve) and check /advanced-extensions/sdk-in-depth.html and /extensions/iframe.html render correctly with the new section in the left TOC

…m components

Custom Components had no documented way to track the locale/channel
currently selected on the product edit form, unlike iframe extensions
where this was already covered. DXIM-694 aligned the postMessage
mechanism between iframe and Custom Component extensions so both now
receive a context message on load and on locale/channel change, and
both support requesting it on demand via 'request_context'.

Add a 'PIM context changes' section to sdk-in-depth.md mirroring the
existing iframe.md documentation, and note in iframe.md that the
context message is also sent once on initial iframe load.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants