Skip to content

Add hash scroll offset #1945

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 2, 2019
Merged

Add hash scroll offset #1945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8ee5db7
temporary workaround for hash scroll
syntony Aug 1, 2019
1bb8df3
Add tests to ensure the docs scroll properly when clicking on a toc link
jennifer-shehane Aug 1, 2019
fb91d3a
Merge branch 'develop' into add-scroll-offset
jennifer-shehane Aug 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
171 changes: 95 additions & 76 deletions cypress/integration/table_of_contents.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,115 +4,134 @@ const API_PATH = '/api/api/table-of-contents'

describe('Table of Contents', () => {
beforeEach(function () {
//# skip running this test if we are in interactive mode
if (Cypress.config('isInteractive')) {
this.skip()
}

cy.server()
})

context('API', () => {
context('scrolls to right position on click', () => {
beforeEach(() => {
cy.visit(`${API_PATH}.html`)
cy.visit(GUIDES_PATH)
})

it('displays toc', function () {
cy.get('.sidebar-link')
.each((linkElement) => {
cy.log(linkElement[0].innerText)
it('displays header text on click', () => {
cy.get('.toc-link')
.each(($el) => {
const text = $el.text()

cy.request(linkElement[0].href).its('body')
.then((body) => {
const $body = Cypress.$(body)
cy.wrap($el).click()
cy.get('.article-content').contains(text).should('be.visible')
})
})
})

const $h1s = $body.find('.article h1').not('.article-title')
const $h2s = $body.find('.article h2')
describe('links', () => {
beforeEach(function () {
//# skip running this test if we are in interactive mode
if (Cypress.config('isInteractive')) {
this.skip()
}

const $h1links = $body.find('.toc-level-1>.toc-link')
const $h2links = $body.find('.toc-level-2>.toc-link')
context('API', () => {
beforeEach(() => {
cy.visit(`${API_PATH}.html`)
})

if ($h1links.length) {
$h1s.each((i, el) => {
const $h1 = Cypress.$(el)
const $link = $h1links.eq(i)
it('displays toc', function () {
cy.get('.sidebar-link')
.each((linkElement) => {
cy.log(linkElement[0].innerText)

expect($link.text()).to.eq($h1.text())
cy.request(linkElement[0].href).its('body')
.then((body) => {
const $body = Cypress.$(body)

expect($link.attr('href')).to.eq(`#${$h1.attr('id')}`)
})
}
const $h1s = $body.find('.article h1').not('.article-title')
const $h2s = $body.find('.article h2')

if ($h2links.length) {
$h2s.each((i, el) => {
const $h2 = Cypress.$(el)
const $link = $h2links.eq(i)
const $h1links = $body.find('.toc-level-1>.toc-link')
const $h2links = $body.find('.toc-level-2>.toc-link')

expect($link.text()).to.eq($h2.text())
if ($h1links.length) {
$h1s.each((i, el) => {
const $h1 = Cypress.$(el)
const $link = $h1links.eq(i)

expect($link.attr('href')).to.eq(`#${$h2.attr('id')}`)
expect($link.text()).to.eq($h1.text())

expect($link.attr('href')).to.eq(`#${$h1.attr('id')}`)
})
}

if ($h2links.length) {
$h2s.each((i, el) => {
const $h2 = Cypress.$(el)
const $link = $h2links.eq(i)

expect($link.text()).to.eq($h2.text())

expect($link.attr('href')).to.eq(`#${$h2.attr('id')}`)
})
}
})
}
})
})
})
})
})

context('FAQ', () => {
beforeEach(() => {
cy.visit(`${FAQ_PATH}.html`)
})
context('FAQ', () => {
beforeEach(() => {
cy.visit(`${FAQ_PATH}.html`)
})

it('displays toc links', () => {
cy.get('.toc-level-2>.toc-link').as('tocLinks')
it('displays toc links', () => {
cy.get('.toc-level-2>.toc-link').as('tocLinks')

cy.get('.faq h2').not('.article-title').each(($h2, i) => {
cy.get('@tocLinks').eq(i).then(($link) => {
expect($link.text()).to.eq($h2.text())
cy.get('.faq h2').not('.article-title').each(($h2, i) => {
cy.get('@tocLinks').eq(i).then(($link) => {
expect($link.text()).to.eq($h2.text())

expect($link.attr('href')).to.eq(`#${$h2.attr('id')}`)
expect($link.attr('href')).to.eq(`#${$h2.attr('id')}`)
})
})
})
})
})
})

context('Guides', function () {
before(() => {
cy.visit(GUIDES_PATH)
})
context('Guides', function () {
before(() => {
cy.visit(GUIDES_PATH)
})

it('displays toc', () =>
cy.get('.sidebar-link')
.each(function (linkElement) {
cy.log(linkElement[0].innerText)
cy.request(linkElement[0].href).its('body')
.then(function (body) {
const $body = Cypress.$(body)
it('displays toc', () =>
cy.get('.sidebar-link')
.each(function (linkElement) {
cy.log(linkElement[0].innerText)
cy.request(linkElement[0].href).its('body')
.then(function (body) {
const $body = Cypress.$(body)

const $h1s = $body.find('.article h1').not('.article-title')
const $h2s = $body.find('.article h2')
const $h1s = $body.find('.article h1').not('.article-title')
const $h2s = $body.find('.article h2')

const $h1links = $body.find('.toc-level-1>.toc-link')
const $h2links = $body.find('.toc-level-2>.toc-link')
const $h1links = $body.find('.toc-level-1>.toc-link')
const $h2links = $body.find('.toc-level-2>.toc-link')

$h1s.each(function (i, el) {
const $h1 = Cypress.$(el)
const $link = $h1links.eq(i)
$h1s.each(function (i, el) {
const $h1 = Cypress.$(el)
const $link = $h1links.eq(i)

expect($link.text()).to.eq($h1.text())
expect($link.attr('href')).to.eq(`#${$h1.attr('id')}`)
})
expect($link.text()).to.eq($h1.text())
expect($link.attr('href')).to.eq(`#${$h1.attr('id')}`)
})

$h2s.each(function (i, el) {
const $h2 = Cypress.$(el)
const $link = $h2links.eq(i)
$h2s.each(function (i, el) {
const $h2 = Cypress.$(el)
const $link = $h2links.eq(i)

expect($link.text()).to.eq($h2.text())
expect($link.attr('href')).to.eq(`#${$h2.attr('id')}`)
expect($link.text()).to.eq($h2.text())
expect($link.attr('href')).to.eq(`#${$h2.attr('id')}`)
})
})
})
})
)
})
)
})
})
})

Loading