Skip to content

feat: update Meteor Admin SDK CMS element to Vue.js 3#2296

Open
Dominik Grothaus (dgrothaus-sw) wants to merge 2 commits into
mainfrom
update-app-cms-elements
Open

feat: update Meteor Admin SDK CMS element to Vue.js 3#2296
Dominik Grothaus (dgrothaus-sw) wants to merge 2 commits into
mainfrom
update-app-cms-elements

Conversation

@dgrothaus-sw
Copy link
Copy Markdown
Contributor

Summary

Updates the examples and code used in the documentation to match Vue.js 3 used in Meteor for Shopware 6.7.
Added examples of how to not only add the element to the replace modal but to the block picker, too.

Changed to tone to match other documentation.

Removed the code for Shopware < 6.7 as the docs for Shopware < 6.7 are separate.

Updated the screenshots to mirror the current visuals of the administration.

Related links

Closes #1914

Checklist

  • I reviewed affected links, code samples, and cross-references, including PageRef references where relevant.
  • I added or updated redirects in .gitbook.yaml if pages were moved, renamed, or deleted.
  • I updated .wordlist.txt (and sorted it) if spellcheck flags new legitimate terms.
  • Any required dependent changes in downstream modules have already been merged and published.
  • This pull request is ready for review.

Notes

Updates the examples and code used in the documentation to match Vue.js
3 used in Meteor for Shopware 6.7.
Added examples of how to not only add the element to the replace modal
but to the block picker, too.

Changed to tone to match other documentation.

Removed the code for Shopware < 6.7 as the docs for Shopware < 6.7 are
separate.

Updated the screenshots to mirror the current visuals of the
administration.
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the documentation for adding CMS elements via the Meteor Admin SDK to match the Vue 3 (SFC) approach used with Meteor for Shopware 6.7, and improves discoverability by documenting how to register both a CMS block (block picker) and a CMS element (replacement modal).

Changes:

  • Update the “Add CMS Element” Admin SDK guide to Vue 3 SFC-based examples and add registerCmsBlock usage alongside registerCmsElement.
  • Clarify the relationship between declarative cms.xml blocks vs fully custom Admin SDK elements, including cross-linking between the guides.
  • Extend the spellcheck wordlist with “discoverable”.

Reviewed changes

Copilot reviewed 3 out of 6 changed files in this pull request and generated 3 comments.

File Description
guides/plugins/apps/content/cms/add-custom-cms-blocks.md Clarifies cms.xml block limitations and links to the Admin SDK element approach.
guides/plugins/apps/administration/add-cms-element-via-admin-sdk.md Reworks the guide to Vue 3 SFC examples, adds block+element registration guidance, and updates sample snippets.
.wordlist.txt Adds “discoverable” to the wordlist.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread guides/plugins/apps/administration/add-cms-element-via-admin-sdk.md Outdated
Comment thread guides/plugins/apps/administration/add-cms-element-via-admin-sdk.md
Comment thread guides/plugins/apps/administration/add-cms-element-via-admin-sdk.md Outdated
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 6 changed files in this pull request and generated 7 comments.

Comment thread guides/plugins/apps/administration/add-cms-element-via-admin-sdk.md
Comment thread guides/plugins/apps/administration/add-cms-element-via-admin-sdk.md
Comment thread guides/plugins/apps/administration/add-cms-element-via-admin-sdk.md
Comment thread guides/plugins/apps/administration/add-cms-element-via-admin-sdk.md
Comment thread guides/plugins/apps/administration/add-cms-element-via-admin-sdk.md
Comment thread guides/plugins/apps/administration/add-cms-element-via-admin-sdk.md
Comment thread guides/plugins/apps/administration/add-cms-element-via-admin-sdk.md
@Isengo1989
Copy link
Copy Markdown
Contributor

Micha Hobert (Isengo1989) commented May 22, 2026

Dominik Grothaus (@dgrothaus-sw) did you see the comments by Copilot? Can you please check and solve those? I can not validate those from a dev POV.

Also, a PR snuck in yesterday that would need some attention (I think mostly structural). I can take over this, if you are busy.

@dgrothaus-sw
Copy link
Copy Markdown
Contributor Author

Dominik Grothaus (dgrothaus-sw) commented May 22, 2026

Micha Hobert (@Isengo1989) I've gone through the comments and they don't really provide value. In the first iteration, Copilot did not mention any of these issues. While writing the docs, I followed the documentation to create a new app to see if the instructions work and it works fine.

The example is working fine without the changes Copilot suggested.

Regarding the changes from the PR: I'll resolve the conflicts.

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.

[Docs]: Evaluate and Update "Add CMS Element" article App CMS element example doesn't match example in shopware/meteor

4 participants