├── .babelrc ├── .eslintignore ├── .eslintrc.json ├── .github └── workflows │ ├── bump-version.yml │ ├── github-pages.yml │ └── npm-publish.yml ├── .gitignore ├── .npmignore ├── .nvmrc ├── LICENSE ├── README.md ├── demos ├── html │ └── index.html ├── react-vite │ ├── .gitignore │ ├── index.html │ ├── package-lock.json │ ├── package.json │ ├── src │ │ ├── App.jsx │ │ └── main.jsx │ └── vite.config.js ├── react │ ├── .gitignore │ ├── package-lock.json │ ├── package.json │ ├── public │ │ └── index.html │ └── src │ │ ├── App.js │ │ └── index.js ├── svelte │ ├── .gitignore │ ├── .npmrc │ ├── package-lock.json │ ├── package.json │ ├── src │ │ ├── app.html │ │ └── routes │ │ │ └── +page.svelte │ ├── svelte.config.js │ └── vite.config.js └── vue │ ├── .gitignore │ ├── index.html │ ├── package-lock.json │ ├── package.json │ ├── src │ ├── App.vue │ └── main.js │ └── vite.config.js ├── package-lock.json ├── package.json ├── public ├── App.svelte ├── Docs.svelte ├── Landing.svelte ├── ScrollyVideoDemo.svelte ├── main.js └── markdown-renderers │ └── Link.svelte ├── rollup.config.mjs ├── src ├── ScrollyVideo.astro ├── ScrollyVideo.js ├── ScrollyVideo.jsx ├── ScrollyVideo.svelte ├── ScrollyVideo.vue ├── utils.js └── videoDecoder.js ├── static ├── .nojekyll ├── favicon.ico ├── favicon.png ├── goldengate.mp4 ├── goldengate_mobile.mp4 ├── index.html ├── markdown.css ├── meta-image.jpg └── reset.css └── tsconfig.json /.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "presets": ["@babel/preset-env", "@babel/preset-react"] 3 | } -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | dist 3 | demos 4 | -------------------------------------------------------------------------------- /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "parserOptions": { 3 | "ecmaVersion": 2019, 4 | "sourceType": "module" 5 | }, 6 | "env": { 7 | "es6": true 8 | }, 9 | "extends": ["airbnb-base", "plugin:prettier/recommended"], 10 | "plugins": ["svelte", "prettier"], 11 | "overrides": [ 12 | { 13 | "files": ["**/*.svelte"], 14 | "parser": "svelte-eslint-parser" 15 | } 16 | ], 17 | "rules": { 18 | "missing-custom-element-compile-options": 0, 19 | "import/no-extraneous-dependencies": 0, 20 | "import/no-mutable-exports": 0, 21 | "import/prefer-default-export": 0, 22 | "import/no-unresolved": 0, 23 | "import/extensions": 0, 24 | "import/first": 0, 25 | "camelcase": 0, 26 | "no-console": 0, 27 | "prettier/prettier": 1 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /.github/workflows/bump-version.yml: -------------------------------------------------------------------------------- 1 | name: Bump Package Version 2 | 3 | on: 4 | push: 5 | tags: 6 | - '*' 7 | 8 | jobs: 9 | update: 10 | name: Bump Package version 11 | runs-on: ubuntu-latest 12 | 13 | steps: 14 | - name: Checkout source code 15 | uses: actions/checkout@v2 16 | with: 17 | ref: main 18 | - uses: phips28/gh-action-bump-version@master 19 | env: 20 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 21 | with: 22 | skip-tag: true 23 | target-branch: main 24 | -------------------------------------------------------------------------------- /.github/workflows/github-pages.yml: -------------------------------------------------------------------------------- 1 | name: Build and Deploy 2 | on: 3 | workflow_dispatch: 4 | push: 5 | branches: 6 | - main 7 | 8 | jobs: 9 | build-and-deploy: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - name: Checkout 🛎️ 13 | # If you're using actions/checkout@v2 you must set persist-credentials to false 14 | # in most cases for the deployment to work correctly. 15 | uses: actions/checkout@v2.3.1 16 | with: 17 | persist-credentials: false 18 | 19 | - name: Set up Node.js 🔧 20 | uses: actions/setup-node@v1 21 | with: 22 | node-version: 18 23 | 24 | # This example project is built using npm and outputs the result to the 'build' 25 | # folder. Replace with the commands required to build your project, or remove 26 | # this step entirely if your site is pre-built. 27 | - name: Install and Build 🔧 28 | run: | 29 | npm install 30 | npm run build-docs 31 | - name: Deploy 🚀 32 | uses: JamesIves/github-pages-deploy-action@3.7.1 33 | with: 34 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 35 | # The branch the action should deploy to. 36 | BRANCH: gh-pages 37 | # The folder the action should deploy. 38 | FOLDER: build 39 | # Automatically remove deleted files from the deploy branch 40 | CLEAN: true 41 | -------------------------------------------------------------------------------- /.github/workflows/npm-publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish to NPM 2 | 3 | on: 4 | push: 5 | tags: 6 | - '*' 7 | 8 | jobs: 9 | publish: 10 | name: Publish to NPM 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@v1 14 | - uses: actions/setup-node@v1 15 | with: 16 | node-version: 18 17 | - run: npm install 18 | - uses: JS-DevTools/npm-publish@v1 19 | with: 20 | token: ${{ secrets.NPM_TOKEN }} 21 | - uses: softprops/action-gh-release@v1 22 | with: 23 | files: ./dist/scrolly-video.zip 24 | env: 25 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 26 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | 9 | # Diagnostic reports (https://nodejs.org/api/report.html) 10 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 11 | 12 | # Runtime data 13 | pids 14 | *.pid 15 | *.seed 16 | *.pid.lock 17 | 18 | # Directory for instrumented libs generated by jscoverage/JSCover 19 | lib-cov 20 | 21 | # Coverage directory used by tools like istanbul 22 | coverage 23 | *.lcov 24 | 25 | # nyc test coverage 26 | .nyc_output 27 | 28 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 29 | .grunt 30 | 31 | # Bower dependency directory (https://bower.io/) 32 | bower_components 33 | 34 | # node-waf configuration 35 | .lock-wscript 36 | 37 | # Compiled binary addons (https://nodejs.org/api/addons.html) 38 | build/Release 39 | 40 | # Dependency directories 41 | node_modules/ 42 | jspm_packages/ 43 | 44 | # TypeScript v1 declaration files 45 | typings/ 46 | 47 | # TypeScript cache 48 | *.tsbuildinfo 49 | 50 | # Optional npm cache directory 51 | .npm 52 | 53 | # Optional eslint cache 54 | .eslintcache 55 | 56 | # Microbundle cache 57 | .rpt2_cache/ 58 | .rts2_cache_cjs/ 59 | .rts2_cache_es/ 60 | .rts2_cache_umd/ 61 | 62 | # Optional REPL history 63 | .node_repl_history 64 | 65 | # Output of 'npm pack' 66 | *.tgz 67 | 68 | # Yarn Integrity file 69 | .yarn-integrity 70 | 71 | # dotenv environment variables file 72 | .env 73 | .env.test 74 | 75 | # parcel-bundler cache (https://parceljs.org/) 76 | .cache 77 | 78 | # Next.js build output 79 | .next 80 | 81 | # Nuxt.js build / generate output 82 | .nuxt 83 | dist 84 | 85 | # Gatsby files 86 | .cache/ 87 | # Comment in the public line in if your project uses Gatsby and *not* Next.js 88 | # https://nextjs.org/blog/next-9-1#public-directory-support 89 | # public 90 | 91 | # vuepress build output 92 | .vuepress/dist 93 | 94 | # Serverless directories 95 | .serverless/ 96 | 97 | # FuseBox cache 98 | .fusebox/ 99 | 100 | # DynamoDB Local files 101 | .dynamodb/ 102 | 103 | # TernJS port file 104 | .tern-port 105 | 106 | build -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | .idea 2 | .github 3 | 4 | src 5 | public 6 | demos 7 | 8 | rollup.config.js 9 | -------------------------------------------------------------------------------- /.nvmrc: -------------------------------------------------------------------------------- 1 | v18 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2022 Daniel Kao 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ScrollyVideo.js 2 | 3 | A component for scroll-based (or other externally controlled) playback. See [`/demos`](https://github.com/dkaoster/scrolly-video/tree/main/demos) for full example usages. 4 | 5 | ## 🚀 Web 6 | 7 | Add html container to your page: 8 | 9 | ```html 10 |
11 | ``` 12 | 13 | Require javascript in your page and create the object (before ``): 14 | 15 | ```html 16 | 17 | 23 | ``` 24 | 25 | You can replace `@latest` with specific version, example `@0.0.2`. 26 | 27 | ## 🔵 React 28 | 29 | Install npm module with `npm install scrolly-video --save`: 30 | Import component in your application: 31 | 32 | ```javascript 33 | import ScrollyVideo from 'scrolly-video/dist/ScrollyVideo.cjs.jsx'; 34 | or 35 | import ScrollyVideo from 'scrolly-video/dist/ScrollyVideo.esm.jsx'; 36 | ``` 37 | 38 | Add the component where you need it: 39 | 40 | ```html 41 | 42 | ``` 43 | 44 | ## 🟠 Svelte 45 | 46 | Install npm module with `npm install scrolly-video --save`: 47 | Import component in your application: 48 | 49 | ```javascript 50 | import ScrollyVideo from 'scrolly-video/dist/ScrollyVideo.svelte'; 51 | ``` 52 | 53 | Add the ScrollyVideo component to your application: 54 | 55 | ```html 56 | 57 | ``` 58 | 59 | ## 🟢 Vue 60 | 61 | Install npm module with `npm install scrolly-video --save`: 62 | Import module in your `src/App.vue` and config: 63 | 64 | ```javascript 65 | import ScrollyVideo from 'scrolly-video/dist/ScrollyVideo.vue'; 66 | ``` 67 | 68 | Add html code to your html component: 69 | 70 | ```html 71 | 72 | ``` 73 | 74 | ## 🔵 Astro 75 | 76 | Install npm module with `npm install scrolly-video --save`: 77 | Import component in your frontmatter: 78 | 79 | ```javascript 80 | import ScrollyVideo from 'scrolly-video/dist/ScrollyVideo.astro'; 81 | ``` 82 | 83 | ```html 84 | 85 | ``` 86 | 87 | ## 🧰 Options / Attributes 88 | 89 | | Parameter | Description | Values | Default | 90 | |:----------------------|:---------------------------------------------------------------------------------------------------------|:-----------------|:--------| 91 | | src | The URL of the video (required) | URL | | 92 | | scrollyVideoContainer | The DOM element of the container, only used for plain js | String / Element | | 93 | | transitionSpeed | Sets the maximum playbackRate for this video | Number | 8 | 94 | | frameThreshold | When to stop the video animation, in seconds | Number | 0.1 | 95 | | cover | Forces the video to cover in it's container | Boolean | true | 96 | | sticky | Whether the video should have `position: sticky` | Boolean | true | 97 | | full | Whether the video should take up the entire viewport | Boolean | true | 98 | | trackScroll | Whether this object should automatically respond to scroll | Boolean | true | 99 | | lockScroll | Whether it ignores human scroll while it runs `setVideoPercentage` with enabled `trackScroll` | Boolean | true | 100 | | useWebCodecs | Whether the library should use the webcodecs method, see below | Boolean | true | 101 | | videoPercentage | Manually specify the position of the video between 0..1, only used for react, vue, and svelte components | Number | | 102 | | onReady | The callback when it's ready to scroll | VoidFunction | | 103 | | onChange | The callback for video percentage change | VoidFunction | | 104 | | debug | Whether to log debug information | Boolean | false | 105 | 106 | 107 | ## Additional callbacks 108 | 109 | ***setVideoPercentage*** 110 | 111 | Description: A way to set currentTime manually. Pass a progress in between of 0 and 1 that specifies the percentage position of the video. If `trackScroll` enabled - it performs scroll automatically. 112 | 113 | Signature: `(percentage: number, options: { transitionSpeed: number, (progress: number) => number }) => void` 114 | 115 | Example: `scrollyVideo.setVideoPercentage(0.5, { transitionSpeed: 12, easing: d3.easeLinear })` 116 | 117 | 118 | ## Technical Details and Cross Browser Differences 119 | To make this library perform optimally in all browsers, three different approaches are taken to animating the video. 120 | 121 | ### Method 1: WebCodecs and Canvas 122 | 123 | Using the new WebCodecs API we are able to get all frames in the video and have them ready to draw to a canvas. This method is the most performant, but has two drawbacks: first, depending on the device and the size of the video, using the WebCodecs API will take some time to process all the frames, so the animation will not be available immediately upon page load. Secondly, the WebCoedecs API is currently only available on Chrome, and the WebCodecs polyfill does not work for this application. 124 | 125 | If WebCodecs is not supported by the browser or has not finished processing all frames, it falls back to method 2: 126 | 127 | ### Method 2: HTML5 Video and playbackRate 128 | 129 | This method simply embeds the video with an HTML `