-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
41 changed files
with
1,263 additions
and
366 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
190 changes: 190 additions & 0 deletions
190
spotlight-client/src/NarrativeLayout/NarrativeLayout.tsx
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,190 @@ | ||
| // Recidiviz - a data platform for criminal justice reform | ||
| // Copyright (C) 2021 Recidiviz, Inc. | ||
| // | ||
| // This program is free software: you can redistribute it and/or modify | ||
| // it under the terms of the GNU General Public License as published by | ||
| // the Free Software Foundation, either version 3 of the License, or | ||
| // (at your option) any later version. | ||
| // | ||
| // This program is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| // GNU General Public License for more details. | ||
| // | ||
| // You should have received a copy of the GNU General Public License | ||
| // along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
| // ============================================================================= | ||
|
|
||
| import { navigate, useParams } from "@reach/router"; | ||
| import useBreakpoint from "@w11r/use-breakpoint"; | ||
| import { rem } from "polished"; | ||
| import React, { useCallback, useEffect, useRef, useState } from "react"; | ||
| import { InView } from "react-intersection-observer"; | ||
| import { useSpring } from "react-spring/web.cjs"; | ||
| import Sticker from "react-stickyfill"; | ||
| import styled from "styled-components/macro"; | ||
| import { NAV_BAR_HEIGHT } from "../constants"; | ||
| import getUrlForResource from "../routerUtils/getUrlForResource"; | ||
| import normalizeRouteParams from "../routerUtils/normalizeRouteParams"; | ||
| import { X_PADDING } from "../SystemNarrativePage/constants"; | ||
| import NarrativeNavigation from "./NarrativeNavigation"; | ||
| import { LayoutSection } from "./types"; | ||
|
|
||
| const Wrapper = styled.article` | ||
| display: flex; | ||
| `; | ||
|
|
||
| const NavContainer = styled.div` | ||
| flex: 0 0 auto; | ||
| width: ${rem(X_PADDING)}; | ||
| `; | ||
|
|
||
| const NavStickyContainer = styled.div` | ||
| display: flex; | ||
| height: calc(100vh - ${rem(NAV_BAR_HEIGHT)}); | ||
| position: sticky; | ||
| top: ${rem(NAV_BAR_HEIGHT)}; | ||
| `; | ||
|
|
||
| export const SectionsContainer = styled.div` | ||
| flex: 1 1 auto; | ||
| /* min-width cannot be auto or children will not shrink when viewport does */ | ||
| min-width: 0; | ||
| `; | ||
|
|
||
| type NarrativeLayoutProps = { | ||
| sections: LayoutSection[]; | ||
| }; | ||
|
|
||
| const NarrativeLayout: React.FC<NarrativeLayoutProps> = ({ sections }) => { | ||
| const routeParams = useParams(); | ||
| const sectionsContainerRef = useRef() as React.MutableRefObject< | ||
| HTMLDivElement | ||
| >; | ||
| const showSectionNavigation = useBreakpoint(true, ["mobile-", false]); | ||
|
|
||
| // automated scrolling is a special case of section visibility; | ||
| // this flag lets us suspend in-page navigation actions while it is in progress | ||
| // (it is a local variable rather than a piece of React state because | ||
| // the animation functions are outside the render loop and won't receive state updates) | ||
| let isScrolling = false; | ||
| const cancelAutoScroll = () => { | ||
| isScrolling = false; | ||
| }; | ||
|
|
||
| const [activeSection, directlySetActiveSection] = useState( | ||
| // make sure we consume the section number in the URL, if any, on first mount | ||
| Number(routeParams.sectionNumber) || 1 | ||
| ); | ||
| // wrap the section state setter in a function that respects the flag | ||
| const setActiveSection = useCallback( | ||
| (sectionNumber: number) => { | ||
| if (!isScrolling) { | ||
| directlySetActiveSection(sectionNumber); | ||
| } | ||
| }, | ||
| [isScrolling] | ||
| ); | ||
| // keep section state in sync with URL if it changes externally (e.g. via nav link) | ||
| useEffect(() => { | ||
| directlySetActiveSection(Number(routeParams.sectionNumber) || 1); | ||
| }, [routeParams.sectionNumber]); | ||
|
|
||
| const [, setScrollSpring] = useSpring(() => ({ | ||
| onFrame: (props: { top: number }) => { | ||
| if (isScrolling) window.scrollTo(0, props.top); | ||
| }, | ||
| // set the flag while animation is in progress, | ||
| // and listen for user-initiated scrolling (which takes priority) | ||
| onRest: () => { | ||
| isScrolling = false; | ||
| window.removeEventListener("wheel", cancelAutoScroll); | ||
| window.removeEventListener("touchmove", cancelAutoScroll); | ||
| }, | ||
| onStart: () => { | ||
| isScrolling = true; | ||
| window.addEventListener("wheel", cancelAutoScroll, { once: true }); | ||
| window.addEventListener("touchmove", cancelAutoScroll, { once: true }); | ||
| }, | ||
| to: { top: window.pageYOffset }, | ||
| })); | ||
|
|
||
| const { tenantId, narrativeTypeId } = normalizeRouteParams(routeParams); | ||
| // updating the active section has two key side effects: | ||
| // 1. smoothly scrolling to the active section | ||
| // 2. updating the page URL so the section can be linked to directly | ||
| useEffect(() => { | ||
| let scrollDestination; | ||
| // scroll to the corresponding section by calculating its offset | ||
| const desiredSection = sectionsContainerRef.current.querySelector( | ||
| `#section${activeSection}` | ||
| ); | ||
| if (desiredSection) { | ||
| scrollDestination = | ||
| window.pageYOffset + desiredSection.getBoundingClientRect().top; | ||
| } | ||
|
|
||
| // in practice this should always be defined, this is just type safety | ||
| if (scrollDestination !== undefined) { | ||
| setScrollSpring({ | ||
| to: { top: scrollDestination - NAV_BAR_HEIGHT }, | ||
| from: { top: window.pageYOffset }, | ||
| reset: true, | ||
| }); | ||
|
|
||
| // these should always be defined on this page; more type safety | ||
| if (tenantId && narrativeTypeId) { | ||
| navigate( | ||
| `${getUrlForResource({ | ||
| page: "narrative", | ||
| params: { tenantId, narrativeTypeId }, | ||
| })}/${activeSection}` | ||
| ); | ||
| } | ||
| } | ||
| }, [ | ||
| activeSection, | ||
| narrativeTypeId, | ||
| sectionsContainerRef, | ||
| setScrollSpring, | ||
| tenantId, | ||
| ]); | ||
|
|
||
| return ( | ||
| <Wrapper> | ||
| {showSectionNavigation && ( | ||
| <NavContainer> | ||
| <Sticker> | ||
| <NavStickyContainer> | ||
| <NarrativeNavigation | ||
| activeSection={activeSection} | ||
| sections={sections} | ||
| /> | ||
| </NavStickyContainer> | ||
| </Sticker> | ||
| </NavContainer> | ||
| )} | ||
| <SectionsContainer ref={sectionsContainerRef}> | ||
| {sections.map((section, index) => { | ||
| // 1-indexed for human readability | ||
| const pageId = index + 1; | ||
| return ( | ||
| <InView | ||
| as="div" | ||
| id={`section${pageId}`} | ||
| key={section.title} | ||
| threshold={0.3} | ||
| onChange={(inView) => { | ||
| if (inView) setActiveSection(pageId); | ||
| }} | ||
| > | ||
| {section.contents} | ||
| </InView> | ||
| ); | ||
| })} | ||
| </SectionsContainer> | ||
| </Wrapper> | ||
| ); | ||
| }; | ||
|
|
||
| export default NarrativeLayout; |
This file contains 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
This file contains 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
Oops, something went wrong.