Skip to content

Commit

Permalink
refactor!(deps): remove smooth scroll polyfill. Determined that brows…
Browse files Browse the repository at this point in the history
…er support is sufficient that polyfilling is no longer needed.

Any users needing the polyfill should include the polyfill itself.
  • Loading branch information
Sub-Xaero committed Mar 9, 2023
1 parent 033a28b commit a51742d
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 102 deletions.
26 changes: 1 addition & 25 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 1 addition & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,9 @@
"@babel/runtime": "^7.20.13",
"@hotwired/stimulus": "^3.2.1",
"date-fns": "^2.29.3",
"mitt": "^3.0.0",
"smoothscroll-polyfill": "^0.4.4"
"mitt": "^3.0.0"
},
"devDependencies": {
"@types/smoothscroll-polyfill": "^0.3.1",
"agadoo": "^3.0.0",
"cypress": "^12.5.1",
"fast-glob": "^3.2.12",
Expand Down
136 changes: 62 additions & 74 deletions src/utilities/scroll.ts
Original file line number Diff line number Diff line change
@@ -1,74 +1,62 @@
import smoothScroll from 'smoothscroll-polyfill';

export async function scrollToElement(element: Element, {behavior = "smooth", block = "start", inline = "nearest"}: ScrollIntoViewOptions = {}) {
smoothScroll.polyfill();
element.scrollIntoView({behavior, block, inline});
}

export async function scrollAbsoluteTop(element: Window | Element, {behavior = "smooth"}: ScrollOptions = {}) {
smoothScroll.polyfill();
element.scrollTo({top: 0, left: 0, behavior});
}

export async function scrollAbsoluteBottom(element: Window | Element, {behavior = "smooth"}: ScrollOptions = {}) {
smoothScroll.polyfill();
if (element == window) {
element.scrollTo({top: document.body.scrollHeight, left: 0, behavior});
} else {
element.scrollTo({top: (element as Element).scrollHeight, left: 0, behavior});
}
}

export async function scrollAbsoluteLeft(element: Window | Element, {behavior = "smooth"}: ScrollOptions = {}) {
smoothScroll.polyfill();
element.scrollTo({left: 0, behavior});
}

export async function scrollAbsoluteRight(element: Window | Element, {behavior = "smooth"}: ScrollOptions = {}) {
smoothScroll.polyfill();
if (element == window) {
element.scrollTo({left: document.body.scrollWidth, behavior});
} else {
element.scrollTo({left: (element as Element).scrollWidth, behavior});
}
}

export async function scrollUp(element: Window | Element, amount: number, {behavior = "smooth"}: ScrollOptions = {}) {
smoothScroll.polyfill();
element.scrollBy({top: -amount, left: 0, behavior});
}

export async function scrollDown(element: Window | Element, amount: number, {behavior = "smooth"}: ScrollOptions = {}) {
smoothScroll.polyfill();
element.scrollBy({top: amount, left: 0, behavior});
}

export async function scrollLeft(element: Window | Element, amount: number, {behavior = "smooth"}: ScrollOptions = {}) {
smoothScroll.polyfill();
element.scrollBy({top: 0, left: -amount, behavior});
}

export async function scrollRight(element: Window | Element, amount: number, {behavior = "smooth"}: ScrollOptions = {}) {
smoothScroll.polyfill();
element.scrollBy({top: 0, left: amount, behavior});
}

export function getScrollParent(node: HTMLElement | null): Window | HTMLElement | null {
smoothScroll.polyfill();
if (!node) {
return null;
}

if (node == document.body) {
return window;
}

const overflowY = getComputedStyle(node).overflowY;
const isScrollable = overflowY !== "visible" && overflowY !== "hidden";

if (isScrollable && node.scrollHeight >= node.clientHeight) {
return node;
}

return getScrollParent(node.parentElement) || document.body;
}
export async function scrollToElement(element: Element, {behavior = "smooth", block = "start", inline = "nearest"}: ScrollIntoViewOptions = {}) {
element.scrollIntoView({behavior, block, inline});
}

export async function scrollAbsoluteTop(element: Window | Element, {behavior = "smooth"}: ScrollOptions = {}) {
element.scrollTo({top: 0, left: 0, behavior});
}

export async function scrollAbsoluteBottom(element: Window | Element, {behavior = "smooth"}: ScrollOptions = {}) {
if (element == window) {
element.scrollTo({top: document.body.scrollHeight, left: 0, behavior});
} else {
element.scrollTo({top: (element as Element).scrollHeight, left: 0, behavior});
}
}

export async function scrollAbsoluteLeft(element: Window | Element, {behavior = "smooth"}: ScrollOptions = {}) {
element.scrollTo({left: 0, behavior});
}

export async function scrollAbsoluteRight(element: Window | Element, {behavior = "smooth"}: ScrollOptions = {}) {
if (element == window) {
element.scrollTo({left: document.body.scrollWidth, behavior});
} else {
element.scrollTo({left: (element as Element).scrollWidth, behavior});
}
}

export async function scrollUp(element: Window | Element, amount: number, {behavior = "smooth"}: ScrollOptions = {}) {
element.scrollBy({top: -amount, left: 0, behavior});
}

export async function scrollDown(element: Window | Element, amount: number, {behavior = "smooth"}: ScrollOptions = {}) {
element.scrollBy({top: amount, left: 0, behavior});
}

export async function scrollLeft(element: Window | Element, amount: number, {behavior = "smooth"}: ScrollOptions = {}) {
element.scrollBy({top: 0, left: -amount, behavior});
}

export async function scrollRight(element: Window | Element, amount: number, {behavior = "smooth"}: ScrollOptions = {}) {
element.scrollBy({top: 0, left: amount, behavior});
}

export function getScrollParent(node: HTMLElement | null): Window | HTMLElement | null {
if (!node) {
return null;
}

if (node == document.body) {
return window;
}

const overflowY = getComputedStyle(node).overflowY;
const isScrollable = overflowY !== "visible" && overflowY !== "hidden";

if (isScrollable && node.scrollHeight >= node.clientHeight) {
return node;
}

return getScrollParent(node.parentElement) || document.body;
}

0 comments on commit a51742d

Please sign in to comment.