├── .github └── FUNDING.yml ├── .gitignore ├── .prettierrc ├── .travis.yml ├── README.md ├── package-lock.json ├── package.json ├── public ├── favicon.ico ├── index.html └── manifest.json └── src ├── App.js ├── App.test.js ├── index.css ├── index.js └── registerServiceWorker.js /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: rwieruch 4 | patreon: # rwieruch 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | custom: # Replace with a single custom sponsorship URL 13 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # See https://help.github.com/ignore-files/ for more about ignoring files. 2 | 3 | # dependencies 4 | /node_modules 5 | 6 | # testing 7 | /coverage 8 | 9 | # production 10 | /build 11 | 12 | # misc 13 | .DS_Store 14 | .env.local 15 | .env.development.local 16 | .env.test.local 17 | .env.production.local 18 | 19 | npm-debug.log* 20 | yarn-debug.log* 21 | yarn-error.log* 22 | -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "semi": true, 3 | "trailingComma": "all", 4 | "singleQuote": true, 5 | "printWidth": 70, 6 | } 7 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | 3 | node_js: 4 | - stable 5 | 6 | install: 7 | - npm install 8 | 9 | script: 10 | - npm test -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # react-intersection-observer-api-example 2 | 3 | [![Build Status](https://travis-ci.org/the-road-to-learn-react/react-intersection-observer-api-example.svg?branch=master)](https://travis-ci.org/the-road-to-learn-react/react-intersection-observer-api-example) [![Slack](https://slack-the-road-to-learn-react.wieruch.com/badge.svg)](https://slack-the-road-to-learn-react.wieruch.com/) [![Greenkeeper badge](https://badges.greenkeeper.io/the-road-to-learn-react/react-intersection-observer-api-example.svg)](https://greenkeeper.io/) 4 | 5 | A simple application that showcases how [Intersection Observer API](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API) can be used in React with [createRef()](https://reactjs.org/docs/refs-and-the-dom.html). Use case: observe sections in an article and track the current viewed section in a navigation. [Read more about it](https://www.robinwieruch.de/react-intersection-observer-api). 6 | 7 | ![sep-06-2018 11-34-11](https://user-images.githubusercontent.com/2479967/45150340-eac42280-b1cb-11e8-9432-5d0324dad237.gif) 8 | 9 | ## Features 10 | 11 | * intersection observer API 12 | * React's ref API with createRef() to reference DOM nodes 13 | * intersection observer API polyfill for browsers/testing 14 | 15 | ## Installation 16 | 17 | * `git clone git@github.com:the-road-to-learn-react/react-intersection-observer-api-example.git` 18 | * cd react-intersection-observer-api-example 19 | * npm install 20 | * npm start 21 | * visit `http://localhost:3000` 22 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "react-intersection-observer-api-example", 3 | "version": "0.1.0", 4 | "private": true, 5 | "dependencies": { 6 | "intersection-observer": "^0.5.0", 7 | "lorem-ipsum": "^1.0.6", 8 | "react": "^16.4.2", 9 | "react-dom": "^16.4.2", 10 | "react-scripts": "3.1.0", 11 | "styled-components": "^4.0.2" 12 | }, 13 | "scripts": { 14 | "start": "react-scripts start", 15 | "build": "react-scripts build", 16 | "test": "react-scripts test --env=jsdom", 17 | "eject": "react-scripts eject" 18 | }, 19 | "devDependencies": {} 20 | } 21 | -------------------------------------------------------------------------------- /public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/the-road-to-learn-react/react-intersection-observer-api-example/af4b79c10b3bc713b3a6519535862e2fa6f07d92/public/favicon.ico -------------------------------------------------------------------------------- /public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 11 | 12 | 13 | 22 | React App 23 | 24 | 25 | 28 |
29 | 39 | 40 | 41 | -------------------------------------------------------------------------------- /public/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "short_name": "React App", 3 | "name": "Create React App Sample", 4 | "icons": [ 5 | { 6 | "src": "favicon.ico", 7 | "sizes": "64x64 32x32 24x24 16x16", 8 | "type": "image/x-icon" 9 | } 10 | ], 11 | "start_url": "./index.html", 12 | "display": "standalone", 13 | "theme_color": "#000000", 14 | "background_color": "#ffffff" 15 | } 16 | -------------------------------------------------------------------------------- /src/App.js: -------------------------------------------------------------------------------- 1 | import React, { Component } from 'react'; 2 | import styled, { css } from 'styled-components'; 3 | import li from 'lorem-ipsum'; 4 | import 'intersection-observer'; 5 | 6 | const Horizontal = styled.div` 7 | display: flex; 8 | `; 9 | 10 | const Navigation = styled.nav` 11 | margin: 30px; 12 | `; 13 | 14 | const Article = styled.div` 15 | overflow-y: scroll; 16 | height: 100vh; 17 | `; 18 | 19 | const Anchor = styled.a` 20 | display: block; 21 | margin-bottom: 10px; 22 | text-decoration: none; 23 | 24 | ${props => 25 | props.selected 26 | ? css` 27 | border-bottom: 1px solid #000; 28 | font-weight: bold; 29 | ` 30 | : null}; 31 | `; 32 | 33 | class App extends Component { 34 | constructor(props) { 35 | super(props); 36 | 37 | this.state = { 38 | things: [ 39 | { 40 | id: 'a', 41 | headline: 'React', 42 | text: li({ count: 50, units: 'sentences' }), 43 | }, 44 | { 45 | id: 'b', 46 | headline: 'Redux', 47 | text: li({ count: 50, units: 'sentences' }), 48 | }, 49 | { 50 | id: 'c', 51 | headline: 'GraphQL', 52 | text: li({ count: 50, units: 'sentences' }), 53 | }, 54 | ], 55 | activeThing: { id: null, ratio: 0 }, 56 | }; 57 | 58 | this.rootRef = React.createRef(); 59 | 60 | this.singleRefs = this.state.things.reduce((acc, value) => { 61 | acc[value.id] = { 62 | ref: React.createRef(), 63 | id: value.id, 64 | ratio: 0, 65 | }; 66 | 67 | return acc; 68 | }, {}); 69 | 70 | const callback = entries => { 71 | entries.forEach( 72 | entry => 73 | (this.singleRefs[entry.target.id].ratio = 74 | entry.intersectionRatio), 75 | ); 76 | 77 | const activeThing = Object.values(this.singleRefs).reduce( 78 | (acc, value) => (value.ratio > acc.ratio ? value : acc), 79 | this.state.activeThing, 80 | ); 81 | 82 | if (activeThing.ratio > this.state.activeThing.ratio) { 83 | this.setState({ activeThing }); 84 | } 85 | }; 86 | 87 | this.observer = new IntersectionObserver(callback, { 88 | root: this.rootRef.current, 89 | threshold: new Array(101).fill(0).map((v, i) => i * 0.01), 90 | }); 91 | } 92 | 93 | componentDidMount() { 94 | Object.values(this.singleRefs).forEach(value => 95 | this.observer.observe(value.ref.current), 96 | ); 97 | } 98 | 99 | render() { 100 | return ( 101 | 102 | 103 | {this.state.things.map(thing => ( 104 |
105 | 109 | {thing.headline} 110 | 111 |
112 | ))} 113 |
114 | 115 |
116 | {this.state.things.map(thing => ( 117 |
122 |

{thing.headline}

123 |

{thing.text}

124 |
125 | ))} 126 |
127 |
128 | ); 129 | } 130 | } 131 | 132 | export default App; 133 | -------------------------------------------------------------------------------- /src/App.test.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import ReactDOM from 'react-dom'; 3 | import App from './App'; 4 | 5 | it('renders without crashing', () => { 6 | const div = document.createElement('div'); 7 | ReactDOM.render(, div); 8 | ReactDOM.unmountComponentAtNode(div); 9 | }); 10 | -------------------------------------------------------------------------------- /src/index.css: -------------------------------------------------------------------------------- 1 | body { 2 | margin: 0; 3 | padding: 0; 4 | font-family: sans-serif; 5 | } 6 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import ReactDOM from 'react-dom'; 3 | import './index.css'; 4 | import App from './App'; 5 | import registerServiceWorker from './registerServiceWorker'; 6 | 7 | ReactDOM.render(, document.getElementById('root')); 8 | registerServiceWorker(); 9 | -------------------------------------------------------------------------------- /src/registerServiceWorker.js: -------------------------------------------------------------------------------- 1 | // In production, we register a service worker to serve assets from local cache. 2 | 3 | // This lets the app load faster on subsequent visits in production, and gives 4 | // it offline capabilities. However, it also means that developers (and users) 5 | // will only see deployed updates on the "N+1" visit to a page, since previously 6 | // cached resources are updated in the background. 7 | 8 | // To learn more about the benefits of this model, read https://goo.gl/KwvDNy. 9 | // This link also includes instructions on opting out of this behavior. 10 | 11 | const isLocalhost = Boolean( 12 | window.location.hostname === 'localhost' || 13 | // [::1] is the IPv6 localhost address. 14 | window.location.hostname === '[::1]' || 15 | // 127.0.0.1/8 is considered localhost for IPv4. 16 | window.location.hostname.match( 17 | /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/ 18 | ) 19 | ); 20 | 21 | export default function register() { 22 | if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) { 23 | // The URL constructor is available in all browsers that support SW. 24 | const publicUrl = new URL(process.env.PUBLIC_URL, window.location); 25 | if (publicUrl.origin !== window.location.origin) { 26 | // Our service worker won't work if PUBLIC_URL is on a different origin 27 | // from what our page is served on. This might happen if a CDN is used to 28 | // serve assets; see https://github.com/facebookincubator/create-react-app/issues/2374 29 | return; 30 | } 31 | 32 | window.addEventListener('load', () => { 33 | const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`; 34 | 35 | if (isLocalhost) { 36 | // This is running on localhost. Lets check if a service worker still exists or not. 37 | checkValidServiceWorker(swUrl); 38 | 39 | // Add some additional logging to localhost, pointing developers to the 40 | // service worker/PWA documentation. 41 | navigator.serviceWorker.ready.then(() => { 42 | console.log( 43 | 'This web app is being served cache-first by a service ' + 44 | 'worker. To learn more, visit https://goo.gl/SC7cgQ' 45 | ); 46 | }); 47 | } else { 48 | // Is not local host. Just register service worker 49 | registerValidSW(swUrl); 50 | } 51 | }); 52 | } 53 | } 54 | 55 | function registerValidSW(swUrl) { 56 | navigator.serviceWorker 57 | .register(swUrl) 58 | .then(registration => { 59 | registration.onupdatefound = () => { 60 | const installingWorker = registration.installing; 61 | installingWorker.onstatechange = () => { 62 | if (installingWorker.state === 'installed') { 63 | if (navigator.serviceWorker.controller) { 64 | // At this point, the old content will have been purged and 65 | // the fresh content will have been added to the cache. 66 | // It's the perfect time to display a "New content is 67 | // available; please refresh." message in your web app. 68 | console.log('New content is available; please refresh.'); 69 | } else { 70 | // At this point, everything has been precached. 71 | // It's the perfect time to display a 72 | // "Content is cached for offline use." message. 73 | console.log('Content is cached for offline use.'); 74 | } 75 | } 76 | }; 77 | }; 78 | }) 79 | .catch(error => { 80 | console.error('Error during service worker registration:', error); 81 | }); 82 | } 83 | 84 | function checkValidServiceWorker(swUrl) { 85 | // Check if the service worker can be found. If it can't reload the page. 86 | fetch(swUrl) 87 | .then(response => { 88 | // Ensure service worker exists, and that we really are getting a JS file. 89 | if ( 90 | response.status === 404 || 91 | response.headers.get('content-type').indexOf('javascript') === -1 92 | ) { 93 | // No service worker found. Probably a different app. Reload the page. 94 | navigator.serviceWorker.ready.then(registration => { 95 | registration.unregister().then(() => { 96 | window.location.reload(); 97 | }); 98 | }); 99 | } else { 100 | // Service worker found. Proceed as normal. 101 | registerValidSW(swUrl); 102 | } 103 | }) 104 | .catch(() => { 105 | console.log( 106 | 'No internet connection found. App is running in offline mode.' 107 | ); 108 | }); 109 | } 110 | 111 | export function unregister() { 112 | if ('serviceWorker' in navigator) { 113 | navigator.serviceWorker.ready.then(registration => { 114 | registration.unregister(); 115 | }); 116 | } 117 | } 118 | --------------------------------------------------------------------------------