feat: allow connectedCallback calls to be filtered in SSR - #3159
Open
zeroedin wants to merge 1 commit into
Open
Conversation
🦋 Changeset detectedLatest commit: 2a34a55 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
✅ Deploy Preview for patternfly-elements ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
adamjohnson
reviewed
Aug 13, 2026
adamjohnson
left a comment
Collaborator
There was a problem hiding this comment.
Would the new calling of ssrCallConnectedCallback() from users dictate this would change to a major release?
| --- | ||
|
|
||
| `ssrCallConnectedCallback`: exported from `ssr-shims.js`, replacing the deprecated `globalThis.litSsrCallConnectedCallback` global. Pass a predicate to limit which elements receive `connectedCallback` during SSR, or omit it to opt in all elements. | ||
|
|
Collaborator
There was a problem hiding this comment.
Suggested change
| **Migration:** importing `@patternfly/pfe-core/ssr-shims.js` no longer opts elements into SSR `connectedCallback` by itself. Call `ssrCallConnectedCallback()` (optionally with a filter) after the import. Consumers that only used the bare side-effect import must add this call or `connectedCallback` will not run during SSR. | |
Contributor
✅ Commitlint tests passed!More Info{
"valid": true,
"errors": [],
"warnings": [],
"input": "feat: allow connectedCallback calls to be filtered in SSR"
} |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What I did
Replaced the deprecated
globalThis.litSsrCallConnectedCallbackflag with theLitElementRenderer.renderOptionsAPI introduced in@lit-labs/ssr@4.1.0.core/pfe-core/ssr-shims.ts: Removed the deprecated global. Exported a newssrCallConnectedCallback(predicate?)function that pushes a filter ontoLitElementRenderer.renderOptions. Without a predicate, all elements opt in (backwards-compatible).tools/pfe-tools/ssr/global.ts:renderGlobalaccepts an optional thirdconnectedCallbackFilterparameter, forwarded tossrCallConnectedCallback. Existing call sites pass no filter and retain the previous behavior.tools/pfe-tools/package.json: Bumped@lit-labs/ssrpeer dep to^4.1.0to require therenderOptionsAPI.https://github.com/lit/lit/blob/main/packages/labs/ssr/README.md#litelementrenderer-configuration
Closes #3158
Testing Instructions
Notes to Reviewers