An open source design system that's fully customizable and agent ready
TypeScript
// Copyright (c) Meta Platforms, Inc. and affiliates.
/**
* @file rootScrollStyles.test.ts
* @input Uses vitest and the rootScrollStyles module
* @output Unit tests for the root scroll-style claims (stacking, out-of-order
* release, the page's own value, per-property independence) and for the
* scroll-lock signal
* @position Testing; validates rootScrollStyles.ts implementation
*
* SYNC: When rootScrollStyles.ts changes, update tests to match new behavior
*/
import {afterEach, describe, expect, it} from 'vitest';
import {
claimRootScrollStyle,
isScrollLockActive,
reportScrollLock,
subscribeScrollLock,
} from './rootScrollStyles';
const root = () => document.documentElement.style;
describe('claimRootScrollStyle', () => {
afterEach(() => {
document.documentElement.style.cssText = '';
document.body.style.cssText = '';
});
it('leaves a value that an outside writer set while the claim held', () => {
// A drawer that writes the root directly opens first...
root().overflow = 'clip';
const release = claimRootScrollStyle({overflow: 'hidden'});
// ...and clears it as it closes, before this claim is released.
root().overflow = '';
release();
expect(root().overflow).toBe('');
});
it("claims overflow on the body when the body's own overflow is the one the viewport uses", () => {
// A common reset: `body { overflow-x: hidden }` propagates to the viewport
// while the root's overflow is visible.
document.body.style.overflowX = 'hidden';
const release = claimRootScrollStyle({overflow: 'hidden'});
let bodyWhileHeld: string;
let rootWhileHeld: string;
try {
bodyWhileHeld = document.body.style.overflow;
rootWhileHeld = root().overflow;
} finally {
release();
}
expect(bodyWhileHeld).toBe('hidden');
expect(rootWhileHeld).toBe('');
expect(document.body.style.overflow).toBe('');
expect(document.body.style.overflowX).toBe('hidden');
});
it('sets the claimed styles and gives the page its own values back', () => {
root().overflow = 'auto';
const release = claimRootScrollStyle({
overflow: 'hidden',
overscrollBehaviorY: 'none',
});
expect(root().overflow).toBe('hidden');
expect(root().overscrollBehaviorY).toBe('none');
release();
expect(root().overflow).toBe('auto');
expect(root().overscrollBehaviorY).toBe('');
});
it('mirrors overscroll-behavior-y onto the body, which Chrome on Android reads for its pull-to-refresh, and gives the body its own value back', () => {
document.body.style.overscrollBehaviorY = 'contain';
const release = claimRootScrollStyle({overscrollBehaviorY: 'none'});
expect(root().overscrollBehaviorY).toBe('none');
expect(document.body.style.overscrollBehaviorY).toBe('none');
release();
expect(root().overscrollBehaviorY).toBe('');
expect(document.body.style.overscrollBehaviorY).toBe('contain');
});
it('leaves a body overscroll value that an outside writer set while the claim held', () => {
const release = claimRootScrollStyle({overscrollBehaviorY: 'none'});
document.body.style.overscrollBehaviorY = 'auto';
release();
expect(document.body.style.overscrollBehaviorY).toBe('auto');
expect(root().overscrollBehaviorY).toBe('');
});
it('lets the latest claim win and restores the one beneath it', () => {
const lock = claimRootScrollStyle({overflow: 'hidden'});
const drawer = claimRootScrollStyle({overflow: 'clip'});
expect(root().overflow).toBe('clip');
drawer();
expect(root().overflow).toBe('hidden');
lock();
expect(root().overflow).toBe('');
});
it('keeps the latest claim when an earlier one is released first', () => {
root().overflow = 'auto';
const lock = claimRootScrollStyle({overflow: 'hidden'});
const drawer = claimRootScrollStyle({overflow: 'clip'});
lock();
expect(root().overflow).toBe('clip');
drawer();
expect(root().overflow).toBe('auto');
});
it('keeps each property to the claims that name it', () => {
const lock = claimRootScrollStyle({overflow: 'hidden'});
const refresh = claimRootScrollStyle({overscrollBehaviorY: 'none'});
lock();
expect(root().overflow).toBe('');
expect(root().overscrollBehaviorY).toBe('none');
refresh();
expect(root().overscrollBehaviorY).toBe('');
});
it('stacks scrollbar-gutter claims on the root and gives the root its own value back', () => {
document.documentElement.style.scrollbarGutter = 'auto';
const first = claimRootScrollStyle({scrollbarGutter: 'stable'});
const second = claimRootScrollStyle({scrollbarGutter: 'stable'});
expect(document.documentElement.style.scrollbarGutter).toBe('stable');
expect(document.body.style.scrollbarGutter).toBe('');
first();
expect(document.documentElement.style.scrollbarGutter).toBe('stable');
second();
expect(document.documentElement.style.scrollbarGutter).toBe('auto');
});
it('does nothing on a second release', () => {
const lock = claimRootScrollStyle({overflow: 'hidden'});
const drawer = claimRootScrollStyle({overflow: 'clip'});
lock();
lock();
expect(root().overflow).toBe('clip');
drawer();
expect(root().overflow).toBe('');
});
it('reads the page value when the first claim lands, not when the module loads', () => {
root().overflow = 'scroll';
const release = claimRootScrollStyle({overflow: 'clip'});
expect(root().overflow).toBe('clip');
release();
expect(root().overflow).toBe('scroll');
});
});
describe('scroll-lock signal', () => {
it('reports only the changes between free and locked', () => {
const states: boolean[] = [];
const unsubscribe = subscribeScrollLock(isActive => states.push(isActive));
reportScrollLock(1);
reportScrollLock(1);
expect(isScrollLockActive()).toBe(true);
reportScrollLock(-1);
expect(isScrollLockActive()).toBe(true);
reportScrollLock(-1);
expect(isScrollLockActive()).toBe(false);
expect(states).toEqual([true, false]);
unsubscribe();
});
it('stops calling a listener once it unsubscribes', () => {
const states: boolean[] = [];
const unsubscribe = subscribeScrollLock(isActive => states.push(isActive));
unsubscribe();
reportScrollLock(1);
reportScrollLock(-1);
expect(states).toEqual([]);
});
});