Skip to content

feat(JumpLinks): Animate scroll position based on selection #11800

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

Closed
rebeccaalpert wants to merge 1 commit into from
Closed

feat(JumpLinks): Animate scroll position based on selection #11800

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
89 changes: 49 additions & 40 deletions packages/react-core/src/components/JumpLinks/JumpLinks.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,7 @@ export const JumpLinks: React.FunctionComponent<JumpLinksProps> = ({
const [scrollItems, setScrollItems] = useState(hasScrollSpy ? getScrollItems(children, []) : []);
const [activeIndex, setActiveIndex] = useState(activeIndexProp);
const [isExpanded, setIsExpanded] = useState(isExpandedProp);
// Boolean to disable scroll listener from overriding active state of clicked jumplink
const isLinkClicked = useRef(false);
const ignoreScrollSpyUntil = useRef<number | null>(null);
const navRef = useRef<HTMLElement>(undefined);

let scrollableElement: HTMLElement;
Expand All @@ -123,11 +122,13 @@ export const JumpLinks: React.FunctionComponent<JumpLinksProps> = ({
if (!canUseDOM || !hasScrollSpy || !(scrollableElement instanceof HTMLElement)) {
return;
}
if (isLinkClicked.current) {
isLinkClicked.current = false;

const now = performance.now();
// Ignore scrolls while smooth scrolling is in progress
if (ignoreScrollSpyUntil.current && now < ignoreScrollSpyUntil.current) {
return;
}
const scrollPosition = Math.ceil(scrollableElement.scrollTop + offset);

window.requestAnimationFrame(() => {
let newScrollItems = scrollItems;
// Items might have rendered after this component or offsetTop values may need
Expand All @@ -138,21 +139,8 @@ export const JumpLinks: React.FunctionComponent<JumpLinksProps> = ({
newScrollItems = getScrollItems(children, []);
setScrollItems(newScrollItems);
}

const scrollElements = newScrollItems
.map((e, index) => ({
y: e ? e.offsetTop : null,
index
}))
.filter(({ y }) => y !== null)
.sort((e1, e2) => e2.y - e1.y);
for (const { y, index } of scrollElements) {
if (scrollPosition >= y) {
return setActiveIndex(index);
}
}
});
}, [scrollItems, hasScrollSpy, scrollableElement, offset]);
}, [scrollItems, hasScrollSpy, scrollableElement, children]);

useEffect(() => {
scrollableElement = getScrollableElement();
Expand All @@ -179,7 +167,7 @@ export const JumpLinks: React.FunctionComponent<JumpLinksProps> = ({
const scrollItem = scrollItems[itemIndex];
return cloneElement(child as React.ReactElement<JumpLinksItemProps>, {
onClick(ev: React.MouseEvent) {
isLinkClicked.current = true;
ignoreScrollSpyUntil.current = performance.now() + 1000;
// Items might have rendered after this component. Do a quick refresh.
let newScrollItems;
if (!scrollItem) {
Expand All @@ -191,31 +179,52 @@ export const JumpLinks: React.FunctionComponent<JumpLinksProps> = ({
if (newScrollItem) {
// we have to support scrolling to an offset due to sticky sidebar
const scrollableElement = getScrollableElement() as HTMLElement;
if (scrollableElement instanceof HTMLElement) {
if (isResponsive(navRef.current)) {
// Remove class immediately so we can get collapsed height
if (navRef.current) {
navRef.current.classList.remove(styles.modifiers.expanded);
}
let stickyParent = navRef.current && navRef.current.parentElement;
while (stickyParent && !stickyParent.classList.contains(sidebarStyles.modifiers.sticky)) {
stickyParent = stickyParent.parentElement;
}
setIsExpanded(false);
if (stickyParent) {
offset += stickyParent.scrollHeight;
}
if (!(scrollableElement instanceof HTMLElement)) {
return;
}

let effectiveOffset = offset;

// Remove class immediately so we can get collapsed height
if (isResponsive(navRef.current)) {
navRef.current?.classList.remove(styles.modifiers.expanded);

let stickyParent = navRef.current?.parentElement;
while (stickyParent && !stickyParent.classList.contains(sidebarStyles.modifiers.sticky)) {
stickyParent = stickyParent.parentElement;
}
setIsExpanded(false);
if (stickyParent) {
effectiveOffset += stickyParent.scrollHeight;
}
scrollableElement.scrollTo(0, newScrollItem.offsetTop - offset);
}
newScrollItem.focus();
if (shouldReplaceNavHistory) {
window.history.replaceState('', '', (ev.currentTarget as HTMLAnchorElement).href);
} else {
window.history.pushState('', '', (ev.currentTarget as HTMLAnchorElement).href);

const href = (ev.currentTarget as HTMLAnchorElement)?.href;
if (href) {
if (shouldReplaceNavHistory) {
window.history.replaceState('', '', href);
} else {
window.history.pushState('', '', href);
}
}

ev.preventDefault();
setActiveIndex(itemIndex);
newScrollItem.focus();

const targetTop = Math.min(
newScrollItem.offsetTop - effectiveOffset,
scrollableElement.scrollHeight - scrollableElement.clientHeight
);

// delays smooth scroll so it actually happens
requestAnimationFrame(() => {
scrollableElement.scrollTo({
top: targetTop,
left: 0,
behavior: 'smooth'
});
});
}
if (onClickProp) {
onClickProp(ev);
Expand Down
9 changes: 4 additions & 5 deletions packages/react-core/src/demos/JumpLinks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,6 @@ ScrollspyH2 = () => {
const jumpLinksHeaderHeight = document.getElementsByClassName('pf-m-sticky')[0].offsetHeight;
jumpLinksHeaderHeight && setOffsetHeight(masthead.offsetHeight + jumpLinksHeaderHeight + offsetForPadding);
}


}, [isVertical]);

getResizeObserver(
Expand Down Expand Up @@ -98,12 +96,12 @@ ScrollspyH2 = () => {
isVertical={isVertical}
isCentered={!isVertical}
label="Jump to section"
scrollableSelector=".pf-v6-c-page__main-container"
scrollableSelector="#scrollable-element"
offset={offsetHeight}
expandable={{ default: isVertical ? 'expandable' : 'nonExpandable', md: 'nonExpandable' }}
isExpanded
>
{headings.map(i => (
{headings.map((i) => (
<JumpLinksItem key={i} href={`#heading-${i}`}>
{`Heading ${i}`}
<JumpLinksList></JumpLinksList>
Expand All @@ -115,7 +113,7 @@ ScrollspyH2 = () => {
<SidebarContent hasNoBackground>
<PageSection>
<Content>
{headings.map(i => (
{headings.map((i) => (
<div key={i} style={{ maxWidth: '800px', marginBottom: '32px' }}>
<h2 id={`heading-${i}`} tabIndex={-1}>
{`Heading ${i}`}
Expand Down Expand Up @@ -158,4 +156,5 @@ This demo shows how jump links can be used in combination with a drawer.
This demo uses a `scrollableRef` prop on the JumpLinks component, which is a React ref to the `DrawerContent` component.

```js isFullscreen file="./examples/JumpLinks/JumpLinksWithDrawer.js"

```
Loading