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.

Sign up for GitHub

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

fix(Incito): Handle non-body scroll container #236

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

fix(Incito): Handle non-body scroll container #236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions examples/incito-publication.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,13 @@
</style>
</head>
<body>
<div class="sgn__incito">
<div class="sgn-incito__progress"></div>
earlier content
<div style="max-height: 90vh; overflow: auto">
<div class="sgn__incito">
<div class="sgn-incito__progress"></div>
</div>
</div>
later content

<script
src="../dist/shopgun-sdk/sgn-sdk.js"
Expand All @@ -48,6 +52,7 @@
id: SGN.util.getQueryParam('id'),
eventTracker: SGN.config.get('eventTracker')
});
bootstrapper.enableLazyLoading = true;

this.bootstrapper.fetch(function (error, res) {
if (error) return console.error(error);
Expand Down
9 changes: 6 additions & 3 deletions lib/incito-browser/incito.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import fetch from 'cross-fetch';
import MicroEvent from '../../vendor/microevent';
import {getScrollContainer} from '../util';
import './incito.styl';
import {IIncito, TextView} from './types';

Expand Down Expand Up @@ -695,6 +696,7 @@ export default class Incito extends MicroEvent<{
sectionHidden: [{sectionId: string; sectionPosition: number}];
}> {
containerEl: HTMLElement;
scrollContainerEl: HTMLElement;
incito: IIncito;
el: HTMLDivElement;
ids: Record<string, unknown>;
Expand All @@ -712,6 +714,7 @@ export default class Incito extends MicroEvent<{
super();

this.containerEl = containerEl;
this.scrollContainerEl = getScrollContainer(containerEl);
this.incito = incito;
this.el = document.createElement('div');
this.ids = {};
Expand Down Expand Up @@ -932,7 +935,7 @@ export default class Incito extends MicroEvent<{
this.sectionVisibility.set(target, newVisibility);
this.triggerSectionVisibility(target, newVisibility);
}),
{rootMargin: '5px 0px'}
{rootMargin: '5px 0px', root: this.scrollContainerEl}
);
this.lazyObserver = new IntersectionObserver(
(entries) => {
Expand All @@ -943,7 +946,7 @@ export default class Incito extends MicroEvent<{
}
});
},
{rootMargin: '500px 0px'}
{rootMargin: '500px 0px', root: this.scrollContainerEl}
);
this.videoObserver = new IntersectionObserver(
(entries) => {
Expand All @@ -962,7 +965,7 @@ export default class Incito extends MicroEvent<{
}
});
},
{threshold: 0.1}
{threshold: 0.1, root: this.scrollContainerEl}
);
}

Expand Down
23 changes: 19 additions & 4 deletions lib/kits/incito-publication/controls.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,41 @@
import {getScrollContainer} from '../../util';
import Viewer from './viewer';

export default class Controls {
viewer: Viewer;
progressEl: HTMLElement | null;
scrollContainerEl: HTMLElement | null;
constructor(viewer: Viewer) {
this.viewer = viewer;
this.progressEl = this.viewer.el.querySelector('.sgn-incito__progress');

if (this.progressEl) {
this.scrollContainerEl = getScrollContainer(this.viewer.el);

this.scroll();
window.addEventListener('scroll', this.scroll, false);
this.scrollContainerEl?.addEventListener(
'scroll',
this.scroll,
false
);
}
}

destroy = () => {
window.removeEventListener('scroll', this.scroll, false);
this.scrollContainerEl?.removeEventListener(
'scroll',
this.scroll,
false
);
};

scroll = () => {
if (!this.scrollContainerEl) return;

const progress = Math.round(
(window.pageYOffset /
(document.body.scrollHeight - window.innerHeight)) *
(this.scrollContainerEl.scrollTop /
(this.scrollContainerEl.scrollHeight -
this.scrollContainerEl.clientHeight)) *
100
);

Expand Down
15 changes: 15 additions & 0 deletions lib/util.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,3 +115,18 @@ export const off = (
) =>
//@ts-expect-error
Gator(el).off(events, selector, callback);

const overflowRE = /auto|scroll/;
export function getScrollContainer(target: HTMLElement) {
let element: HTMLElement | null = target;
while (element) {
const {overflow, overflowY, overflowX} = getComputedStyle(element);
if (overflowRE.test(overflow + overflowY + overflowX)) {
return element;
}

element = element.parentElement;
}

return document.body;
}
Loading