Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Sticky] Fix Sticky to update items when props change #11947

Merged
merged 1 commit into from Apr 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/thin-paws-wait.md
@@ -0,0 +1,5 @@
---
'@shopify/polaris': patch
---

Fixed `Sticky` to update sticky items when props change
30 changes: 30 additions & 0 deletions polaris-react/src/components/Sticky/Sticky.tsx
Expand Up @@ -55,6 +55,36 @@ class StickyInner extends Component<CombinedProps, State> {
});
}

componentDidUpdate() {
const {
boundingElement,
offset = false,
disableWhenStacked = false,
stickyManager,
} = this.props;

if (!this.stickyNode || !this.placeHolderNode) return;

const stickyManagerItem = stickyManager.getStickyItem(this.stickyNode);
const didPropsChange =
!stickyManagerItem ||
boundingElement !== stickyManagerItem.boundingElement ||
offset !== stickyManagerItem.offset ||
disableWhenStacked !== stickyManagerItem.disableWhenStacked;

if (!didPropsChange) return;

stickyManager.unregisterStickyItem(this.stickyNode);
stickyManager.registerStickyItem({
stickyNode: this.stickyNode,
placeHolderNode: this.placeHolderNode,
handlePositioning: this.handlePositioning,
offset,
boundingElement,
disableWhenStacked,
});
}

componentWillUnmount() {
const {stickyManager} = this.props;
if (!this.stickyNode) return;
Expand Down
4 changes: 4 additions & 0 deletions polaris-react/src/utilities/sticky-manager/sticky-manager.ts
Expand Up @@ -67,6 +67,10 @@ export class StickyManager {
this.stickyItems.splice(nodeIndex, 1);
}

getStickyItem(node: HTMLElement) {
return this.stickyItems.find(({stickyNode}) => node === stickyNode);
}

setContainer(el: Document | HTMLElement) {
this.container = el;
if (isDocument(el)) {
Expand Down