leaysgur / content-scroller

ページ内の一部分をスクロールできるようにするやつ

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

content-scroller

ページ内の一部分をスクロールできるようにするやつ

See Sample

使い方

最低限のサンプルです。

HTML

<div id="js-scroll-wrap" class="scroll-wrap">
  <div id="js-scroll-bar" class="scroll-bar"></div>
  <div id="js-scroll-area" class="scroll-area">
    ここにそれはもう長い長いコンテンツを
  </div>
</div>

CSS

.scroll-wrap {
  /* 必須 */
  position: relative;
  overflow: hidden;

  /* 必須ですが好きな高さに */
  height: 100px;
}

.scroll-area {
  /* 好きなスタイルに */
}

.scroll-bar {
  /* 必須 */
  position: absolute;
  right: 0;

  /* 必須ですが好きなスタイルに */
  width: 4px;
  background-color: rgba(0,0,0,.5);
}

JavaScript

// 初期化は要素があればいつでもOKです
var scroll = new Scroll({
    scrollWrap: $('#js-scroll-wrap')[0], // jQueryではなく、生のDOMを使います
    scrollArea: $('#js-scroll-area')[0],
    scrollBar:  $('#js-scroll-bar')[0]
});

// これではじめてスクロールできるようになります
scroll.start();


// 使わなくなったらこれを
scroll.dispose();

見た目はお好きにスタイリングしてください。

初期化オプション

options.scrollWrap

スクロールで制御したい要素

options.scrollArea

実際にスクロールしたい要素

options.scrollBar

スクロールバーとして扱う要素

options.disableScrollBar

スクロールバーを使わないならtrue(デフォルトはfalse)

options.startAtBottome

スクロールしきった状態からスタートするならtrue(デフォルトはfalse)

諸注意

  • PCのマウスホイール/トラックパッドの移動には対応してません(=PCでは実質使いものにならない)

About

ページ内の一部分をスクロールできるようにするやつ

License:MIT License


Languages

Language:JavaScript 87.2%Language:HTML 12.8%