@pirxpilot/antiscroll

OS X Lion style cross-browser native scrolling on the web that gets out of the way.

antiscroll

OS X Lion style cross-browser native scrolling on the web that gets out of the way. It is a component compatible, jQuery free, clone of LearnBoost/antiscroll

Antiscroll fixes a fundamental problem JavaScript UI developers commonly face: how do I customize scrollbars so that they get out of the way (for example, for different form widgets), but retain their native scrolling properties (like OS widge scrolling velocity, or OS specific inertia)?

Antiscroll addresses this issue by providing a cross-browser implementation of the scrollbars popularized by OS X Lion that retains native properties.

Installation

Install with npm:

$ npm install @pirxpilot/antiscroll

Features

  • Supports mousewheels, trackpads, other input devices natively.
  • Doesn't magically autowrap your elements with divs (manual wrapping is necessary, please see index.htmldemo)
  • Fade in/out controlled with CSS3 animations.
  • Shows scrollbars upon hovering.
  • Scrollbars are draggable.
  • Size of container can be dynamically adjusted and scrollbars will adapt.

Demo

Please click hereto see it in action.

Installation

  1. Wrap scrollable content with the class antiscroll-inner
  2. Wrap the above with the class antiscroll-wrap
  3. Include the following Javascript
var antiscroll = require('Antiscroll');

  antiscroll(document.querySelector('.antiscroll-wrap'));

Configuration

You may remove automatic scrollbar hiding by passing in a key-value to the antiscroll()function like so:

antiscroll(el, {
    autoHide: false
  });

What does it look like?

Firefox 8 overflow: scrolland antiscroll on OS X

IE 9 overflow: scrolland antiscroll

How does it work?

The idea behind Antiscroll is to leverage real scrollbars, but hide them from the view. The implementation consists of 3 steps.

1. Measure scrollbars width

In order to measure scrollbars width we use the following technique:

  1. Insert a div with a fixed width and measure the inner width
  2. Force overflow: scroll
  3. Measure the inner width. The difference is the scrollbar width

The caveat of this technique is precisely OSX Lion. Since the scrollbars floaton top of the content, their width is always zero but they still overlay your content. To address this issue we add an aditional step which consists of declaring ::-webkit-scrollbarand ::scrollbarCSS pseudo-properties that set the width of the scrollbars to zero for modern browsers.

2. Adjust the width of the inner element

The parent element receives overflow: hiddenand the desired width and height for the widget.

The inner .antiscroll-innerelement receives the same width and height, but the script augments this two values with the size of the scrollbars, effectively hiding them.

The inner element is always overflow: scroll.

3. Listen on the scroll event

We attach the scrollevent to the scrollable element, and we create our scrollbars as absolutely positioned divs. We update our scrollbars based on the detected scrollLeftand scrollTopof the element.

Credits

This technique was inspired by Facebook's chat sidebar/ticker, which also reproduces Lion's scrollbars, but relying on setting the width of the inner container to an arbitrarily large width, therefore allowing scrolling of a single axis (vertical).

Scrollbar size detection based on the work of Jonathan Sharp.

Contributors

jQuery plugin written by @guilleOther contributors listed here

TODO

  • Automatically leverage Joe Hewitt's scrollabilityas a replacement technique if a touch-enabled browser is detected.

License

(The MIT License)

Copyright (c) 2011 Guillermo Rauch <guillermo@learnboost.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Repository

https://github.com/pirxpilot/antiscroll.git


上一篇:@pirxpilot/tip
下一篇:computed-style-component

相关推荐

  • code42day-antiscroll

    OS X Lion style crossbrowser native scrolling on the web that gets out of the way. antiscroll OS ...

    5 个月前
  • antiscroll

    OS X Lion style crossbrowser native scrolling on the web that gets out of the way. Antiscroll: cro...

    2 年前
  • @pirxpilot/tip

    Tip component Tip Tip component. Inspired by tipsy(https://github.com/jaz303/tipsy) without the...

    7 个月前
  • @pirxpilot/swipe

    Swipe component with touch support Swipe Swipe component with touch support, for image carouse...

    6 个月前
  • @pirxpilot/replay

    When API testing slows you down: record and replay HTTP responses like a boss Node Replay When ...

    4 个月前
  • @pirxpilot/popover

    Popover component Popover Popover component built on top of Tip(http://github.com/pirxpilot/ti...

    6 个月前
  • @pirxpilot/metalsmith-lunr-index

    Generate lunr indexes with full body search metalsmithlunrindex A Metalsmith(https://github.com/s...

    16 天前
  • @pirxpilot/k

    keyboard event dispatcher k keyboard event dispatcher. Installation $ component install ...

    4 个月前
  • @pirxpilot/jade-core

    Jade version 1.x with security patches Jade Node Template Engine(http://garthdb.com/img/jadebrand...

    4 个月前
  • @pirxpilot/events

    Simple dom event management. NPM versionnpmimagenpmurl Build Statustravisimagetravisurl Dependency ...

    6 个月前

官方社区

扫码加入 JavaScript 社区