Skip to content

docs: document vue.customElements config option - #437

Merged
cossssmin merged 1 commit into
mainfrom
docs/vue-custom-elements
Aug 3, 2026
Merged

docs: document vue.customElements config option#437
cossssmin merged 1 commit into
mainfrom
docs/vue-custom-elements

Conversation

@cossssmin

@cossssmin cossssmin commented Aug 3, 2026

Copy link
Copy Markdown
Member

Documents the vue.customElements option added in maizzle/framework#1823.

Changes

  • configuration.md — new ### customElements subsection under ## vue: type signature, the [/^v:/, /^o:/] VML/Office use case, string / RegExp / predicate forms, and the note that amp-* is always native.
  • templates.md — callout after the AMP4Email section pointing hand-written VML (v:*) / Office (o:*) tags at the new option to silence the Failed to resolve component warning.

Depends on maizzle/framework#1823 (ships the option).

Summary by CodeRabbit

  • Documentation
    • Added guidance for configuring Vue to recognize custom elements, including VML, Office namespace tags, and amp-* elements.
    • Documented how to register non-HTML markup to prevent component-resolution warnings while preserving Tailwind class scanning.

Add a customElements subsection under `## vue` in the configuration
reference, and a callout in the templates guide pointing hand-written
VML (`v:*`) / Office (`o:*`) tags at the new option.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Aug 3, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 33ab8d6f-9640-4264-b465-debc1adf4897

📥 Commits

Reviewing files that changed from the base of the PR and between a8399c9 and 327fa83.

📒 Files selected for processing (2)
  • content/docs/development/configuration.md
  • content/docs/development/templates.md

📝 Walkthrough

Walkthrough

The documentation adds vue.customElements configuration details and explains how to register VML and Office tags to suppress Vue component-resolution warnings.

Changes

Custom Elements Documentation

Layer / File(s) Summary
Document custom-element configuration and usage
content/docs/development/configuration.md, content/docs/development/templates.md
Documents supported vue.customElements matching forms, amp-* handling, and registration guidance for VML and Office tags.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely identifies the main change: documenting the vue.customElements configuration option.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/vue-custom-elements

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying maizzle-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 327fa83
Status: ✅  Deploy successful!
Preview URL: https://9db2ee27.maizzle-docs.pages.dev
Branch Preview URL: https://docs-vue-custom-elements.maizzle-docs.pages.dev

View logs

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying maizzle5 with  Cloudflare Pages  Cloudflare Pages

Latest commit: 327fa83
Status: ✅  Deploy successful!
Preview URL: https://af463e78.maizzle5.pages.dev
Branch Preview URL: https://docs-vue-custom-elements.maizzle5.pages.dev

View logs

@cossssmin
cossssmin merged commit 83fc80a into main Aug 3, 2026
5 checks passed
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.

1 participant