.github/workflows/ci.yml

@@ -36,8 +36,8 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3
-      - uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
         with:
           cache: npm
           node-version: lts/*
@@ -66,8 +66,8 @@ jobs:
         run: |
           git config --global core.autocrlf false
           git config --global core.eol lf
-      - uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3
-      - uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
         with:
           cache: npm
           node-version: ${{ matrix.node }}
@@ -81,12 +81,12 @@ jobs:
     if: always() && github.event.inputs.release == 'true' && needs.build.result != 'failure' && needs.test.result != 'failure' && needs.test.result != 'cancelled'
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3
+      - uses: actions/checkout@v4
         with:
           # Need to fetch entire commit history to
           # analyze every commit since last release
           fetch-depth: 0
-      - uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3
+      - uses: actions/setup-node@v3
         with:
           cache: npm
           node-version: lts/*

.github/workflows/prettier.yml

@@ -15,13 +15,13 @@ jobs:
     name: 🤔
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3
-      - uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
         with:
           cache: npm
           node-version: lts/*
       - run: npm ci --ignore-scripts --only-dev
-      - uses: actions/cache@4723a57e26efda3a62cbde1812113b730952852d # v3
+      - uses: actions/cache@v3
         with:
           path: node_modules/.cache/prettier/.prettier-cache
           key: prettier-${{ hashFiles('package-lock.json') }}-${{ hashFiles('.gitignore') }}

CHANGELOG.md

@@ -5,6 +5,54 @@
 All notable changes to this project will be documented in this file. See
 [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.1.1](https://github.com/scroll-into-view/compute-scroll-into-view/compare/v3.1.0...v3.1.1) (2025-01-10)
+
+### Bug Fixes
+
+- in if-needed mode, skip bounds checking for non-scrollable scrollingElement ([#915](https://github.com/scroll-into-view/compute-scroll-into-view/issues/915)) ([77ae1e8](https://github.com/scroll-into-view/compute-scroll-into-view/commit/77ae1e878fc897f26f1cef8171ebc9912ba2b187))
+
+## [3.1.0](https://github.com/scroll-into-view/compute-scroll-into-view/compare/v3.0.3...v3.1.0) (2023-09-30)
+
+### Features
+
+- account for scroll margin ([#906](https://github.com/scroll-into-view/compute-scroll-into-view/issues/906)) ([b932154](https://github.com/scroll-into-view/compute-scroll-into-view/commit/b932154473451e92dc71112d2df3e1d674892283))
+
+### Bug Fixes
+
+- scrolling zero-dimension elements ([#901](https://github.com/scroll-into-view/compute-scroll-into-view/issues/901)) ([ffad204](https://github.com/scroll-into-view/compute-scroll-into-view/commit/ffad2040d7b35484e8cdc0332577977164653b62)), closes [#900](https://github.com/scroll-into-view/compute-scroll-into-view/issues/900)
+
+## [3.0.3](https://github.com/scroll-into-view/compute-scroll-into-view/compare/v3.0.2...v3.0.3) (2023-04-10)
+
+### Bug Fixes
+
+- use const replace let ([#889](https://github.com/scroll-into-view/compute-scroll-into-view/issues/889)) ([d6f778d](https://github.com/scroll-into-view/compute-scroll-into-view/commit/d6f778d5a91720f9cb1980b403612d744cfa24bc))
+
+## [3.0.2](https://github.com/scroll-into-view/compute-scroll-into-view/compare/v3.0.1...v3.0.2) (2023-04-09)
+
+### Bug Fixes
+
+- revert package.json and utils.js [#882](https://github.com/scroll-into-view/compute-scroll-into-view/issues/882) ([#891](https://github.com/scroll-into-view/compute-scroll-into-view/issues/891)) ([1d57298](https://github.com/scroll-into-view/compute-scroll-into-view/commit/1d572980b5451eca90a4510e1864265fad65708f))
+
+## [3.0.1](https://github.com/scroll-into-view/compute-scroll-into-view/compare/v3.0.0...v3.0.1) (2023-04-08)
+
+### Bug Fixes
+
+- support `—moduleResolution node16` ([#882](https://github.com/scroll-into-view/compute-scroll-into-view/issues/882)) ([d4ad5e1](https://github.com/scroll-into-view/compute-scroll-into-view/commit/d4ad5e1b53dcb0b1baa7fd6f696d467759c17cbc))
+
+## [3.0.0](https://github.com/scroll-into-view/compute-scroll-into-view/compare/v2.0.4...v3.0.0) (2023-02-14)
+
+### ⚠ BREAKING CHANGES
+
+- **refactor:** use `import {compute}` instead of `import compute`
+
+### Features
+
+- **refactor:** use named export instead of default ([8509530](https://github.com/scroll-into-view/compute-scroll-into-view/commit/850953006334264cf2ef9040bf8c4d7ae6700604))
+
+### Bug Fixes
+
+- drop `pageXOffset` and `pageYOffset` ([fc7bd97](https://github.com/scroll-into-view/compute-scroll-into-view/commit/fc7bd976d34f497da462d02772858eae718a75b2))
+
 ## [2.0.4](https://github.com/scroll-into-view/compute-scroll-into-view/compare/v2.0.3...v2.0.4) (2023-01-08)
 
 ### Bug Fixes

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Cody Olsen
+Copyright (c) 2025 Cody Olsen
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -31,15 +31,13 @@ npm i compute-scroll-into-view
 You can also use it from a CDN:
 
 ```js
-const { default: compute } = await import(
-  'https://esm.sh/compute-scroll-into-view'
-)
+const { compute } = await import('https://esm.sh/compute-scroll-into-view')
 ```
 
 # Usage
 
 ```js
-import compute from 'compute-scroll-into-view'
+import { compute } from 'compute-scroll-into-view'
 
 const node = document.getElementById('hero')
 

integration/__snapshots__/viewport-100-percent.test.js.snap

@@ -0,0 +1,85 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`scrollMode: if-needed (outside the scrollingElement bounding box) horizontal completely in view 1`] = `[]`;
+
+exports[`scrollMode: if-needed (outside the scrollingElement bounding box) horizontal completely overflowing 1`] = `
+[
+  {
+    "el": "html",
+    "left": 100,
+    "top": 0,
+  },
+]
+`;
+
+exports[`scrollMode: if-needed (outside the scrollingElement bounding box) horizontal fully negative overflowing 1`] = `
+[
+  {
+    "el": "html",
+    "left": 800,
+    "top": 0,
+  },
+]
+`;
+
+exports[`scrollMode: if-needed (outside the scrollingElement bounding box) horizontal partially negative overflowing 1`] = `
+[
+  {
+    "el": "html",
+    "left": 800,
+    "top": 0,
+  },
+]
+`;
+
+exports[`scrollMode: if-needed (outside the scrollingElement bounding box) horizontal partially overflowing 1`] = `
+[
+  {
+    "el": "html",
+    "left": 100,
+    "top": 0,
+  },
+]
+`;
+
+exports[`scrollMode: if-needed (outside the scrollingElement bounding box) vertical completely above the fold 1`] = `
+[
+  {
+    "el": "html",
+    "left": 0,
+    "top": 350,
+  },
+]
+`;
+
+exports[`scrollMode: if-needed (outside the scrollingElement bounding box) vertical completely below the fold 1`] = `
+[
+  {
+    "el": "html",
+    "left": 0,
+    "top": 350,
+  },
+]
+`;
+
+exports[`scrollMode: if-needed (outside the scrollingElement bounding box) vertical completely in view 1`] = `[]`;
+
+exports[`scrollMode: if-needed (outside the scrollingElement bounding box) vertical partially above the fold 1`] = `
+[
+  {
+    "el": "html",
+    "left": 0,
+    "top": 350,
+  },
+]
+`;
+
+exports[`scrollMode: if-needed (outside the scrollingElement bounding box) vertical partially below the fold 1`] = `
+[
+  {
+    "el": "html",
+    "left": 0,
+    "top": 350,
+  },
+]
+`;

integration/utils.js

@@ -1,4 +1,4 @@
-import compute from '../dist/index.js'
+import { compute } from '../dist/index.js'
 window.computeScrollIntoView = compute
 
 window.mapActions = (item) => ({

integration/viewport-100-percent.html

@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<meta charset="utf-8" />
+<meta
+  name="viewport"
+  content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no"
+/>
+<script type="module" src="./utils.js"></script>
+<style>
+  html,
+  body {
+    width: 100%;
+    height: 100%;
+  }
+  body {
+    margin: 0;
+  }
+  .padding {
+    width: 100vw;
+    height: 100vh;
+  }
+  .target {
+    background: crimson;
+    height: 100px;
+    width: 100px;
+  }
+
+  .horizontal-scroll {
+    display: flex;
+    position: absolute;
+    top: 0;
+    height: 100vh;
+  }
+
+  .horizontal-scroll * {
+    flex-shrink: 0;
+  }
+</style>
+<div class="vertical-scroll">
+  <div class="padding"></div>
+  <div class="target"></div>
+  <div class="padding"></div>
+</div>
+<div class="horizontal-scroll">
+  <div class="padding"></div>
+  <div class="target"></div>
+  <div class="padding"></div>
+</div>