Skip to content

Automatically scroll on details menu when it opens off-screen #59

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

Closed
wants to merge 1 commit into from
Closed

Automatically scroll on details menu when it opens off-screen #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 17 additions & 0 deletions examples/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,23 @@ <h1>Autofocus example</h1>
</details-menu>
</details>

<details>
<summary>Scroll into view radio group</summary>
<details-menu scrollIntoView>
<ul role="radiogroup">
<li role="radio">
<label><input type="radio" name="robot" value="Hubot">Hubot</label>
</li>
<li role="radio">
<label><input type="radio" name="robot" value="Bender">Bender</label>
</li>
<li role="radio">
<label><input type="radio" name="robot" value="BB-8">BB-8</label>
</li>
</ul>
</details-menu>
</details>

<script type="text/javascript">
document.addEventListener('details-menu-selected', e => console.log(e))
</script>
Expand Down
17 changes: 17 additions & 0 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ class DetailsMenuElement extends HTMLElement {
fromEvent(details, 'keydown', e => keydown(details, this, e)),
fromEvent(details, 'toggle', () => loadFragment(details, this), {once: true}),
fromEvent(details, 'toggle', () => closeCurrentMenu(details)),
fromEvent(details, 'toggle', () => scrollIntoView(details)),
this.preload
? fromEvent(details, 'mouseover', () => loadFragment(details, this), {once: true})
: NullSubscription,
Expand Down Expand Up @@ -137,6 +138,22 @@ function autofocus(details: Element): boolean {
}
}

// Scroll entire details menu into view, center on it.
function scrollIntoView(details: Element): boolean {
if (!details.hasAttribute('open')) return false
const detailsMenu = details.querySelector<HTMLElement>('details-menu [scrollIntoView]')
if (detailsMenu) {
const innerMenu = detailsMenu.closest('[role="menu"], [role="radiogroup"]')
if (innerMenu) {
innerMenu.scrollIntoView({behavior: 'smooth', block: 'center'})
} else {
return false
}
return true
}
return false
}

// Focus first item unless an item is already focused.
function focusFirstItem(details: Element) {
const selected = document.activeElement
Expand Down
39 changes: 39 additions & 0 deletions test/test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -629,6 +629,45 @@ describe('details-menu element', function () {
})
})

describe('with input[scrollIntoView]', function () {
beforeEach(function () {
const container = document.createElement('div')
container.innerHTML = `
<details>
<summary>Scroll into view radio group</summary>
<details-menu scrollIntoView>
<ul role="radiogroup">
<li role="radio">
<label><input type="radio" name="robot" value="Hubot">Hubot</label>
</li>
<li role="radio">
<label><input type="radio" name="robot" value="Bender">Bender</label>
</li>
<li role="radio">
<label><input type="radio" name="robot" value="BB-8">BB-8</label>
</li>
</ul>
</details-menu>
</details>
`
document.body.append(container)
})

afterEach(function () {
document.body.innerHTML = ''
})

it('scrolls the inner menu into view on mouse click', function () {
const details = document.querySelector('details')
const detailsMenu = details.querySelector('details-menu')
const innerMenu = detailsMenu.closest('[role="menu"]')

details.open = true
details.dispatchEvent(new CustomEvent('toggle'))
assert.equal(0, innerMenu.scrollTop)
})
})

describe('closing the menu', function () {
beforeEach(function () {
const container = document.createElement('div')
Expand Down