Skip to content

docs: module federation webcomponents#53

Closed
priyankaSandeepRade wants to merge 3 commits intoonecx:mainfrom
priyankaSandeepRade:docs/module-federation-webcomponents
Closed

docs: module federation webcomponents#53
priyankaSandeepRade wants to merge 3 commits intoonecx:mainfrom
priyankaSandeepRade:docs/module-federation-webcomponents

Conversation

@priyankaSandeepRade
Copy link
Copy Markdown
Contributor

No description provided.

@priyankaSandeepRade priyankaSandeepRade changed the title Docs/module federation webcomponents docs: module federation webcomponents Apr 8, 2026
Copy link
Copy Markdown

@rogocoffee rogocoffee left a comment

Choose a reason for hiding this comment

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

Please address the open issues.
Also please align the headings. Sometimes we use =, == or even === for similar level headlines. Please align it with the rest of the docs

Also please add a description to the PR.


As stated in xref:./microfrontend-content-loading.adoc[Microfrontend content loading documentation], every method of Microfrontend's content exposal has an impact on the OneCX platform behavior for both module and Remote Component loading. The adaptations made by OneCX to work with Web Components were briefly mentioned in the Web Components preview, however depending on the content type, the behavior varies.

// TODO: Link to guide of Webcomponent expose method
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Why TODO comment?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

from legacy docs. addressed in this PR - #55


This section explains how the Shell UI loads and renders Microfrontend modules using the Webcomponent expose method. It describes how routing, module federation, and Web Components work together, where the Shell loads the module and Web Components handle rendering through custom elements.

// TODO: Link to guide of Webcomponent expose method
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Why TODO comment?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

from legacy docs. addressed in this PR - #55


* *Web Components Binding* - Then Web Components using Custom Elements technology bounds the Microfrontend's module to the created element.

// Add new guide from oneCx section here
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

What is the purpose of this comment?

Copy link
Copy Markdown
Contributor Author

@priyankaSandeepRade priyankaSandeepRade Apr 15, 2026

Choose a reason for hiding this comment

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

As document was divided new link has to be added in this doc. Linking is done


* *Webcomponent Method Difference* - The difference with the Webcomponent method is that, from the OneCX platform's perspective, no component needs to be created. Instead, a "host" element must be created to allow Web Components' Custom Elements to display desired content.

// Add new guide from oneCx section here
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

What is the purpose of this comment?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

As document was divided new link has to be added in this doc. Linking is done

[#onecx-adaptation-to-webcomponent-method]
= OneCX Adaptation to Webcomponent Method

As stated in xref:./microfrontend-content-loading.adoc[Microfrontend content loading documentation], every method of Microfrontend's content exposal has an impact on the OneCX platform behavior for both module and Remote Component loading. The adaptations made by OneCX to work with Web Components were briefly mentioned in the Web Components preview, however depending on the content type, the behavior varies.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

is this xref working? (cannot see the adoc in this folder)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

no. addressed in main PR #55

== Expose Microfrontend's Content as Web Components
OneCX platform offers different ways of xref:../../../architecture/mfe.adoc[exposing Microfrontend's content]. One of them is **Webcomponent method**.

When exposing content with Webcomponent method, it is required to ensure the correct setup. For exposing Angular content, there are functionalities provided via the <<onecx/angular-webcomponents, @onecx/angular-webcomponents>> library. For a detailed guide on how to expose Microfrontend's content via Webcomponent method, please refer here.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Is the last sentence intended? If yes can we make the reference clearer?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yes linked relevant document

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Headings looking odd/inconsistent

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