mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-07-10 03:14:58 -04:00
Add tests for most scenarios
This commit is contained in:
Tom Byers
433
tests/javascripts/stick-to-window-when-scrolling.test.js
Normal file
433
tests/javascripts/stick-to-window-when-scrolling.test.js
Normal file
@@ -0,0 +1,433 @@
|
||||
const helpers = require('./support/helpers');
|
||||
const STOP_PADDING = 10;
|
||||
function getScreenItemBottomPosition (screenItem) {
|
||||
return screenItem.offsetTop + screenItem.offsetHeight;
|
||||
};
|
||||
|
||||
beforeAll(() => {
|
||||
require('../../app/assets/javascripts/stick-to-window-when-scrolling.js');
|
||||
});
|
||||
|
||||
afterAll(() => {
|
||||
require('./support/teardown.js');
|
||||
});
|
||||
|
||||
describe("Stick to top/bottom of window when scrolling", () => {
|
||||
|
||||
let screenMock;
|
||||
|
||||
describe("If intending to stick to the top", () => {
|
||||
|
||||
let inputForm;
|
||||
let formFooter;
|
||||
let footer;
|
||||
let windowHeight;
|
||||
|
||||
beforeEach(() => {
|
||||
|
||||
document.body.innerHTML = `
|
||||
<div class="grid-row">
|
||||
<main class="column-three-quarters column-main">
|
||||
<form method="post" autocomplete="off">
|
||||
<div class="grid-row js-stick-at-top-when-scrolling">
|
||||
<div class="column-two-thirds ">
|
||||
<div class="form-group" data-module="">
|
||||
<label class="form-label" for="placeholder_value">
|
||||
name
|
||||
</label>
|
||||
<input class="form-control form-control-1-1 " data-module="" id="placeholder_value" name="placeholder_value" required="" rows="8" type="text" value="">
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="page-footer">
|
||||
<button type="submit" class="button">Continue</button>
|
||||
</div>
|
||||
</form>
|
||||
</main>
|
||||
</div>
|
||||
<footer class="js-footer"></footer>`;
|
||||
|
||||
inputForm = document.querySelector('form > .grid-row');
|
||||
formFooter = document.querySelector('.page-footer');
|
||||
footer = document.querySelector('.js-footer');
|
||||
|
||||
windowHeight = 940;
|
||||
|
||||
// mock the rendering of all components
|
||||
screenMock = new helpers.ScreenMock(jest);
|
||||
screenMock.setWindow({
|
||||
width: 1990,
|
||||
height: windowHeight,
|
||||
scrollTop: 0
|
||||
});
|
||||
screenMock.mockPositionAndDimension('inputForm', inputForm, {
|
||||
offsetHeight: 168,
|
||||
offsetWidth: 727,
|
||||
offsetTop: 238
|
||||
});
|
||||
screenMock.mockPositionAndDimension('formFooter', formFooter, {
|
||||
offsetHeight: 200,
|
||||
offsetWidth: 727,
|
||||
offsetTop: inputForm.offsetTop + 200
|
||||
});
|
||||
screenMock.mockPositionAndDimension('footer', footer, {
|
||||
offsetHeight: 535,
|
||||
offsetWidth: 1990,
|
||||
offsetTop: formFooter.offsetTop + formFooter.offsetHeight
|
||||
});
|
||||
|
||||
getFurthestTopPoint = (stickysHeight) => {
|
||||
return footer.offsetTop - PADDING_BEFORE_STOPPING_POINT - stickysHeight;
|
||||
};
|
||||
|
||||
// the sticky JS polls for changes to position/dimension so we need to fake setTimeout and setInterval
|
||||
jest.useFakeTimers();
|
||||
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
|
||||
document.body.innerHTML = '';
|
||||
|
||||
window.GOVUK.stickAtTopWhenScrolling.clearEvents();
|
||||
|
||||
screenMock.reset();
|
||||
|
||||
});
|
||||
|
||||
test("if top of viewport is above top of element on load, the element should not be marked as sticky", () => {
|
||||
|
||||
// scroll position defaults to 0, element top defaults to 138px
|
||||
|
||||
window.GOVUK.stickAtTopWhenScrolling.init();
|
||||
|
||||
expect(inputForm.classList.contains('content-fixed-onload')).toBe(false);
|
||||
expect(inputForm.classList.contains('content-fixed')).toBe(false);
|
||||
|
||||
});
|
||||
|
||||
test("if top of viewport is below top of element but still in the scroll area on load, the element should be marked as already sticky", () => {
|
||||
|
||||
// scroll past the top of the form
|
||||
screenMock.scrollTo(inputForm.offsetTop + 10);
|
||||
|
||||
window.GOVUK.stickAtTopWhenScrolling.init();
|
||||
|
||||
// `.content-fixed-onload` adds the drop-shadow without fading in to show it did not become sticky from user interaction
|
||||
expect(inputForm.classList.contains('content-fixed-onload')).toBe(true);
|
||||
expect(inputForm.classList.contains('content-fixed')).toBe(false);
|
||||
|
||||
});
|
||||
|
||||
test("if top of viewport is below the furthest point the top of the element can go in the scroll area on load, the element should be marked as stopped", () => {
|
||||
|
||||
// the element should stop a set distance from the stopping point
|
||||
const furthestPoint = (footer.offsetTop - inputForm.offsetHeight) - STOP_PADDING;
|
||||
|
||||
// scroll past the furthest point
|
||||
screenMock.scrollTo(furthestPoint + 10);
|
||||
|
||||
window.GOVUK.stickAtTopWhenScrolling.init();
|
||||
|
||||
// `.content-fixed-onload` adds the drop-shadow without fading in to show it did not become sticky from user interaction
|
||||
expect(inputForm.classList.contains('content-fixed-onload')).toBe(true);
|
||||
expect(inputForm.classList.contains('content-fixed')).toBe(false);
|
||||
|
||||
// elements are stopped by adding inline styles
|
||||
expect(inputForm.style.position).toEqual('absolute');
|
||||
expect(inputForm.style.top).toEqual(`${furthestPoint}px`);
|
||||
|
||||
});
|
||||
|
||||
describe("if viewport top starts above element top", () => {
|
||||
|
||||
beforeEach(() => {
|
||||
|
||||
// default scroll position is above top of form
|
||||
window.GOVUK.stickAtTopWhenScrolling.init();
|
||||
|
||||
});
|
||||
|
||||
test("if window is scrolled so top of it is below the top of the element, the element should be marked so it becomes sticky to the user", () => {
|
||||
|
||||
// scroll past top of form
|
||||
screenMock.scrollTo(inputForm.offsetTop + 10);
|
||||
jest.advanceTimersByTime(60); // fake advance of time to something similar to that for a scroll
|
||||
|
||||
// `content-fixed` fades the drop-shadow in to show it became sticky from user interaction
|
||||
expect(inputForm.classList.contains('content-fixed')).toBe(true);
|
||||
expect(inputForm.classList.contains('content-fixed-onload')).toBe(false); // check the class for onload isn't applied
|
||||
|
||||
});
|
||||
|
||||
test("if window is scrolled so top of it is below the furthest point the top of the element can go in the scroll area, the element should be stopped", () => {
|
||||
|
||||
const furthestPoint = (footer.offsetTop - inputForm.offsetHeight) - STOP_PADDING;
|
||||
|
||||
// scroll past top of form
|
||||
screenMock.scrollTo(furthestPoint + 10);
|
||||
jest.advanceTimersByTime(60); // fake advance of time to something similar to that for a scroll
|
||||
|
||||
// `content-fixed` fades the drop-shadow in to show it became sticky from user interaction
|
||||
expect(inputForm.classList.contains('content-fixed')).toBe(true);
|
||||
expect(inputForm.classList.contains('content-fixed-onload')).toBe(false); // check the class for onload isn't applied
|
||||
|
||||
// elements are stopped by adding inline styles
|
||||
expect(inputForm.style.position).toEqual('absolute');
|
||||
expect(inputForm.style.top).toEqual(`${furthestPoint}px`);
|
||||
|
||||
});
|
||||
|
||||
});
|
||||
|
||||
describe("if viewport top starts below element top", () => {
|
||||
|
||||
beforeEach(() => {
|
||||
|
||||
// scroll past top of form
|
||||
screenMock.scrollTo(inputForm.offsetTop + 10);
|
||||
|
||||
window.GOVUK.stickAtTopWhenScrolling.init();
|
||||
|
||||
});
|
||||
|
||||
test("if window is scrolled so top of it is above the top of the element, the element should be made not sticky", () => {
|
||||
|
||||
// scroll to top
|
||||
screenMock.scrollTo(0);
|
||||
jest.advanceTimersByTime(60); // fake advance of time to something similar to that for a scroll
|
||||
|
||||
expect(inputForm.classList.contains('content-fixed')).toBe(false);
|
||||
expect(inputForm.classList.contains('content-fixed-onload')).toBe(false); // check the class for onload isn't applied
|
||||
|
||||
});
|
||||
|
||||
});
|
||||
|
||||
});
|
||||
|
||||
describe("If intending to stick to the bottom", () => {
|
||||
|
||||
let header;
|
||||
let content;
|
||||
let pageFooter;
|
||||
let windowHeight;
|
||||
let furthestBottomPoint;
|
||||
|
||||
beforeEach(() => {
|
||||
|
||||
document.body.innerHTML = `
|
||||
<main role="main" class="column-three-quarters column-main">
|
||||
<a class="govuk-back-link" href="">Back</a>
|
||||
<h1 class="heading-large js-header">
|
||||
Preview of ‘Content email’
|
||||
</h1>
|
||||
<div class="wrapper">
|
||||
<div class="email-message-body">
|
||||
<h2>This is the title</h2>
|
||||
<p>This is a paragraph, defined as a block of content where the contents run horizontally across lines.</p>
|
||||
<table role="presentation">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<ul>
|
||||
<li>these</li>
|
||||
<li>are</li>
|
||||
<li>bullet points</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<blockquote>
|
||||
<p>This block of text is formatted to stand out from the rest</p>
|
||||
</blockquote>
|
||||
<p>This is a paragraph with a horizontal line underneath.</p>
|
||||
<hr>
|
||||
<p>This is a paragraph with a horizontal line above.</p>
|
||||
<p>This paragraph has a link in it: <a href="https://www.gov.uk">https://www.gov.uk</a>.</p>
|
||||
</div>
|
||||
<div class="page-footer js-stick-at-bottom-when-scrolling">
|
||||
<form method="post" action="">
|
||||
<button type="submit" class="button">Send 1 email </button>
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
</main>`;
|
||||
|
||||
heading = document.querySelector('.js-header');
|
||||
content = document.querySelector('.email-message-body');
|
||||
pageFooter = document.querySelector('.page-footer');
|
||||
|
||||
windowHeight = 940;
|
||||
|
||||
// mock the rendering of all components
|
||||
screenMock = new helpers.ScreenMock(jest);
|
||||
screenMock.setWindow({
|
||||
width: 1990,
|
||||
height: windowHeight,
|
||||
scrollTop: 0
|
||||
});
|
||||
screenMock.mockPositionAndDimension('heading', heading, {
|
||||
offsetHeight: 75,
|
||||
offsetWidth: 727,
|
||||
offsetTop: 185
|
||||
});
|
||||
screenMock.mockPositionAndDimension('content', content, {
|
||||
offsetHeight: 900,
|
||||
offsetWidth: 727,
|
||||
offsetTop: heading.offsetTop + heading.offsetHeight
|
||||
});
|
||||
screenMock.mockPositionAndDimension('pageFooter', pageFooter, {
|
||||
offsetHeight: 50,
|
||||
offsetWidth: 727,
|
||||
offsetTop: content.offsetTop + content.offsetHeight
|
||||
});
|
||||
|
||||
furthestBottomPoint = () => {
|
||||
const headingBottom = getScreenItemBottomPosition(headingItem);
|
||||
|
||||
// the element should stop so its top at the bottom of the heading, with a set amount of padding to separate them
|
||||
return (headingBottom + pageFooterItem.height) + STOP_PADDING;
|
||||
};
|
||||
|
||||
// the sticky JS polls for changes to position/dimension so we need to fake setTimeout and setInterval
|
||||
jest.useFakeTimers();
|
||||
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
|
||||
window.GOVUK.stickAtBottomWhenScrolling.clearEvents();
|
||||
|
||||
});
|
||||
|
||||
test("if bottom of viewport is below bottom of element on load, the element should not be marked as sticky", () => {
|
||||
|
||||
const pageFooterBottom = getScreenItemBottomPosition(pageFooter);
|
||||
|
||||
// scroll so the bottom of the window goes past the bottom of the element
|
||||
screenMock.scrollTo((pageFooterBottom - windowHeight) + 10);
|
||||
|
||||
window.GOVUK.stickAtBottomWhenScrolling.init();
|
||||
|
||||
// `.content-fixed-onload` adds the drop-shadow without fading in to show it did not become sticky from user interaction
|
||||
expect(pageFooter.classList.contains('content-fixed-onload')).toBe(false);
|
||||
expect(pageFooter.classList.contains('content-fixed')).toBe(false);
|
||||
|
||||
});
|
||||
|
||||
test("if bottom of viewport is above bottom of element on load, the element should be marked as already sticky", () => {
|
||||
|
||||
// scroll position defaults to 0 so bottom of window starts at 940px. Element bottom defaults to 1160px.
|
||||
|
||||
window.GOVUK.stickAtBottomWhenScrolling.init();
|
||||
|
||||
expect(pageFooter.classList.contains('content-fixed-onload')).toBe(true);
|
||||
expect(pageFooter.classList.contains('content-fixed')).toBe(false);
|
||||
|
||||
});
|
||||
|
||||
test("if bottom of viewport is above the furthest point the bottom of the element can go in the scroll area on load, the element should be marked as stopped", () => {
|
||||
|
||||
// change window size so its bottom can go past stopping position
|
||||
const windowHeight = 200;
|
||||
|
||||
screenMock.window.setHeightTo(windowHeight);
|
||||
|
||||
// scroll the window bottom past the furthest point
|
||||
screenMock.scrollTo((furthestBottomPoint() - windowHeight) - 10);
|
||||
|
||||
window.GOVUK.stickAtBottomWhenScrolling.init();
|
||||
|
||||
// `.content-fixed-onload` adds the drop-shadow without fading in to show it did not become sticky from user interaction
|
||||
expect(pageFooter.classList.contains('content-fixed-onload')).toBe(true);
|
||||
expect(pageFooter.classList.contains('content-fixed')).toBe(false);
|
||||
|
||||
// elements are stopped by adding inline styles
|
||||
expect(pageFooter.style.position).toEqual('absolute');
|
||||
expect(pageFooter.style.top).toEqual(`${furthestBottomPoint() - pageFooter.offsetHeight}px`);
|
||||
|
||||
});
|
||||
|
||||
describe("if viewport bottom starts below element bottom", () => {
|
||||
|
||||
let pageFooterBottom;
|
||||
|
||||
beforeEach(() => {
|
||||
|
||||
pageFooterBottom = getScreenItemBottomPosition(pageFooter);
|
||||
|
||||
// change window size so its bottom can go past stopping position
|
||||
const windowHeight = 600;
|
||||
|
||||
screenMock.window.setHeightTo(windowHeight);
|
||||
|
||||
// scroll to just below the element
|
||||
screenMock.scrollTo((pageFooterBottom - windowHeight) + 10);
|
||||
|
||||
// default scroll position is above top of form
|
||||
window.GOVUK.stickAtBottomWhenScrolling.init();
|
||||
|
||||
});
|
||||
|
||||
test("if window is scrolled so bottom of it is above the bottom of the element, the element should be marked so it becomes sticky to the user", () => {
|
||||
|
||||
// scroll above bottom of sticky element
|
||||
screenMock.scrollTo((pageFooterBottom - windowHeight) - 10);
|
||||
jest.advanceTimersByTime(60); // fake advance of time to something similar to that for a scroll
|
||||
|
||||
// `content-fixed` fades the drop-shadow in to show it became sticky from user interaction
|
||||
expect(pageFooter.classList.contains('content-fixed')).toBe(true);
|
||||
expect(pageFooter.classList.contains('content-fixed-onload')).toBe(false); // check the class for onload isn't applied
|
||||
|
||||
});
|
||||
|
||||
test("if window is scrolled so bottom of it is above the furthest point the bottom of the element can go in the scroll area, the element should be stopped", () => {
|
||||
|
||||
// scroll past top of content
|
||||
screenMock.scrollTo((furthestBottomPoint() - windowHeight) - 10);
|
||||
jest.advanceTimersByTime(60); // fake advance of time to something similar to that for a scroll
|
||||
|
||||
// `content-fixed` fades the drop-shadow in to show it became sticky from user interaction
|
||||
expect(pageFooter.classList.contains('content-fixed')).toBe(true);
|
||||
expect(pageFooter.classList.contains('content-fixed-onload')).toBe(false); // check the class for onload isn't applied
|
||||
|
||||
// elements are stopped by adding inline styles
|
||||
expect(pageFooter.style.position).toEqual('absolute');
|
||||
expect(pageFooter.style.top).toEqual(`${furthestBottomPoint() pageFooter.offsetHeight}px`);
|
||||
|
||||
});
|
||||
|
||||
});
|
||||
|
||||
describe("if viewport bottom starts above element bottom", () => {
|
||||
|
||||
let pageFooterBottom;
|
||||
|
||||
beforeEach(() => {
|
||||
|
||||
// scroll position defaults to 0 so bottom of window starts at 940px. Element bottom defaults to 1160px so will be sticky on load.
|
||||
|
||||
pageFooterBottom = getScreenItemBottomPosition(pageFooter);
|
||||
|
||||
window.GOVUK.stickAtBottomWhenScrolling.init();
|
||||
|
||||
});
|
||||
|
||||
test("if window is scrolled so bottom of it is below the bottom of the element, the element should be made not sticky", () => {
|
||||
|
||||
// scroll so bottom of window is below bottom of element
|
||||
screenMock.scrollTo((pageFooterBottom - windowHeight) + 10);
|
||||
jest.advanceTimersByTime(60); // fake advance of time to something similar to that for a scroll
|
||||
|
||||
expect(pageFooter.classList.contains('content-fixed')).toBe(false);
|
||||
expect(pageFooter.classList.contains('content-fixed-onload')).toBe(false); // check the class for onload isn't applied
|
||||
|
||||
});
|
||||
|
||||
});
|
||||
|
||||
});
|
||||
|
||||
});
|
||||
Reference in New Issue
Block a user