instead of having to offset the padding of children of the autohiding scrollbar container, which gets fiddly quickly, add a new child to the scrollbar container that gets a negative margin of the scrollbar width when needed (on hover and overflowing when overlay is not supported). This needs an extra DOM element, but as it doesn't do anything weird layout-wise (like set position), it shouldn't affect styling at all. It also makes the auto hide scrollbar workarounds completely transparent to the rest of the code.
121 lines
4.0 KiB
JavaScript
121 lines
4.0 KiB
JavaScript
/*
|
|
Copyright 2018 New Vector Ltd
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
import React from "react";
|
|
|
|
// derived from code from github.com/noeldelgado/gemini-scrollbar
|
|
// Copyright (c) Noel Delgado <pixelia.me@gmail.com> (pixelia.me)
|
|
function getScrollbarWidth(alternativeOverflow) {
|
|
const div = document.createElement('div');
|
|
div.style.position = 'absolute';
|
|
div.style.top = '-9999px';
|
|
div.style.width = '100px';
|
|
div.style.height = '100px';
|
|
div.style.overflow = "scroll";
|
|
if (alternativeOverflow) {
|
|
div.style.overflow = alternativeOverflow;
|
|
}
|
|
div.style.msOverflowStyle = '-ms-autohiding-scrollbar';
|
|
document.body.appendChild(div);
|
|
const scrollbarWidth = (div.offsetWidth - div.clientWidth);
|
|
document.body.removeChild(div);
|
|
return scrollbarWidth;
|
|
}
|
|
|
|
function install() {
|
|
const scrollbarWidth = getScrollbarWidth();
|
|
if (scrollbarWidth !== 0) {
|
|
const hasForcedOverlayScrollbar = getScrollbarWidth('overlay') === 0;
|
|
// overflow: overlay on webkit doesn't auto hide the scrollbar
|
|
if (hasForcedOverlayScrollbar) {
|
|
document.body.classList.add("mx_scrollbar_overlay_noautohide");
|
|
} else {
|
|
document.body.classList.add("mx_scrollbar_nooverlay");
|
|
const style = document.createElement('style');
|
|
style.type = 'text/css';
|
|
style.innerText =
|
|
`body.mx_scrollbar_nooverlay { --scrollbar-width: ${scrollbarWidth}px; }`;
|
|
document.head.appendChild(style);
|
|
}
|
|
}
|
|
}
|
|
|
|
const installBodyClassesIfNeeded = (function() {
|
|
let installed = false;
|
|
return function() {
|
|
if (!installed) {
|
|
install();
|
|
installed = true;
|
|
}
|
|
};
|
|
})();
|
|
|
|
export default class AutoHideScrollbar extends React.Component {
|
|
constructor(props) {
|
|
super(props);
|
|
this.onOverflow = this.onOverflow.bind(this);
|
|
this.onUnderflow = this.onUnderflow.bind(this);
|
|
this._collectContainerRef = this._collectContainerRef.bind(this);
|
|
}
|
|
|
|
onOverflow() {
|
|
this.containerRef.classList.add("mx_AutoHideScrollbar_overflow");
|
|
this.containerRef.classList.remove("mx_AutoHideScrollbar_underflow");
|
|
}
|
|
|
|
onUnderflow() {
|
|
this.containerRef.classList.remove("mx_AutoHideScrollbar_overflow");
|
|
this.containerRef.classList.add("mx_AutoHideScrollbar_underflow");
|
|
}
|
|
|
|
_collectContainerRef(ref) {
|
|
if (ref && !this.containerRef) {
|
|
this.containerRef = ref;
|
|
const needsOverflowListener =
|
|
document.body.classList.contains("mx_scrollbar_nooverlay");
|
|
|
|
if (needsOverflowListener) {
|
|
this.containerRef.addEventListener("overflow", this.onOverflow);
|
|
this.containerRef.addEventListener("underflow", this.onUnderflow);
|
|
}
|
|
if (ref.scrollHeight > ref.clientHeight) {
|
|
this.onOverflow();
|
|
} else {
|
|
this.onUnderflow();
|
|
}
|
|
}
|
|
}
|
|
|
|
componentWillUnmount() {
|
|
if (this.containerRef) {
|
|
this.containerRef.removeEventListener("overflow", this.onOverflow);
|
|
this.containerRef.removeEventListener("underflow", this.onUnderflow);
|
|
}
|
|
}
|
|
|
|
render() {
|
|
installBodyClassesIfNeeded();
|
|
return (<div
|
|
ref={this._collectContainerRef}
|
|
className={["mx_AutoHideScrollbar", this.props.className].join(" ")}
|
|
>
|
|
<div className="mx_AutoHideScrollbar_offset">
|
|
{ this.props.children }
|
|
</div>
|
|
</div>);
|
|
}
|
|
}
|