-
Notifications
You must be signed in to change notification settings - Fork 27.2k
feat(core): support bootstrapping Angular components underneath shadow roots #66782
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
dgp1130
wants to merge
11
commits into
angular:main
Choose a base branch
from
dgp1130:bootstrap-shadow-minimal
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
8258e33
refactor(core): move `SharedStylesHost` interface into `@angular/core…
dgp1130 37574fd
refactor(core): add `getRootNode` to `RNode` interface
dgp1130 38602a9
refactor(core): track multiple usages of a single host in `SharedStyl…
dgp1130 294d578
refactor(core): add `MockSharedStylesHost`
dgp1130 a1ba01e
fix(core): ensure `ViewRef.prototype.destroy` is idempotent
dgp1130 cf94a8e
feat(core): support bootstrapping Angular components underneath shado…
dgp1130 1ccb813
refactor(platform-browser): avoid `SharedStylesHost` modifications af…
dgp1130 16c49c9
refactor(core): preserve `document` context via `fallbackDocument` in…
dgp1130 a89baf0
refactor(platform-browser): avoid duplicate styles when re-adding a h…
dgp1130 5b5a4f0
test: verify that Angular supports bootstrapping under shadow roots
dgp1130 17f2628
test(core): add test validating that component destroy does not depen…
dgp1130 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
refactor(core): track multiple usages of a single host in `SharedStyl…
…esHost` When rendering components underneath shadow roots, it is possible to render multiple times, meaning `SharedStylesHost.prototype.addHost` will potentially be called multiple times on the same shadow root. This is reasonable, and we need to make sure that as long as any one component is still using a given shadow root as its host, we should continue applying styles there. Only when all usages of the host are removed do we stop adding styles to it.
- Loading branch information
commit 38602a98218e9944fa5dbcfd8ae4de1bd891aee6
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -117,9 +117,9 @@ export class SharedStylesHost implements ɵSharedStylesHost, OnDestroy { | |
| private readonly external = new Map<string /** URL */, UsageRecord<HTMLLinkElement>>(); | ||
|
|
||
| /** | ||
| * Set of host DOM nodes that will have styles attached. | ||
| * The set of DOM nodes with styles attached, tracked by usage count. | ||
| */ | ||
| private readonly hosts = new Set<Node>(); | ||
| private readonly hosts = new Map<Node, number>(); | ||
|
|
||
| constructor( | ||
| @Inject(DOCUMENT) private readonly doc: Document, | ||
|
|
@@ -130,7 +130,7 @@ export class SharedStylesHost implements ɵSharedStylesHost, OnDestroy { | |
| @Inject(PLATFORM_ID) platformId: object = {}, | ||
| ) { | ||
| addServerStyles(doc, appId, this.inline, this.external); | ||
| this.hosts.add(doc.head); | ||
| this.hosts.set(doc.head, 1); | ||
| } | ||
|
|
||
| addStyles(styles: string[], urls?: string[]): void { | ||
|
|
@@ -173,7 +173,9 @@ export class SharedStylesHost implements ɵSharedStylesHost, OnDestroy { | |
| // Otherwise, create an entry to track the elements and add element for each host | ||
| usages.set(value, { | ||
| usage: 1, | ||
| elements: [...this.hosts].map((host) => this.addElement(host, creator(value, this.doc))), | ||
| elements: [...this.hosts.keys()].map((host) => | ||
| this.addElement(host, creator(value, this.doc)), | ||
| ), | ||
| }); | ||
| } | ||
| } | ||
|
|
@@ -204,19 +206,31 @@ export class SharedStylesHost implements ɵSharedStylesHost, OnDestroy { | |
| } | ||
|
|
||
| addHost(hostNode: Node): void { | ||
| this.hosts.add(hostNode); | ||
|
|
||
| // Add existing styles to new host | ||
| for (const [style, {elements}] of this.inline) { | ||
| elements.push(this.addElement(hostNode, createStyleElement(style, this.doc))); | ||
| } | ||
| for (const [url, {elements}] of this.external) { | ||
| elements.push(this.addElement(hostNode, createLinkElement(url, this.doc))); | ||
| const existingUsage = this.hosts.get(hostNode) ?? 0; | ||
| if (existingUsage === 0) { | ||
| // Add existing styles to new host | ||
| for (const [style, {elements}] of this.inline) { | ||
| elements.push(this.addElement(hostNode, createStyleElement(style, this.doc))); | ||
| } | ||
| for (const [url, {elements}] of this.external) { | ||
| elements.push(this.addElement(hostNode, createLinkElement(url, this.doc))); | ||
| } | ||
| } | ||
|
|
||
| this.hosts.set(hostNode, existingUsage + 1); | ||
| } | ||
|
|
||
| removeHost(hostNode: Node): void { | ||
| this.hosts.delete(hostNode); | ||
| const usage = this.hosts.get(hostNode); | ||
| if (typeof ngDevMode !== 'undefined' && ngDevMode && usage === undefined) { | ||
|
dgp1130 marked this conversation as resolved.
|
||
| throw new Error('Attempted to remove a host which was not added.'); | ||
| } | ||
|
|
||
| if (usage! === 1) { | ||
| this.hosts.delete(hostNode); | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we also be removing the inline and external styles when the last host is removed? |
||
| } else { | ||
| this.hosts.set(hostNode, usage! - 1); | ||
| } | ||
| } | ||
|
|
||
| private addElement<T extends HTMLElement>(host: Node, element: T): T { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nitpicking: Can we move the
this.hosts.set(hostNode, existingUsage + 1);up and invert this guard to reduce nesting?