scrollerのダウンロードscrollerソースコードのダウンロード

scroller

その他のソースコード

v3.0.2

ダウンロード

スクロラー

高速、軽量（4KB GZIP）、および依存関係のないコンテンツスクラー。

example.mp4

さまざまな設定とUI条件でどのように機能するかの例については、このリンクをご覧ください。

インストール

npmでスクラーをインストールします：

npm install prokrutchik

プロジェクトにスクリプトとスタイルを追加します。

 import { Scroller } from "prokrutchik" ;
import "prokrutchik/styles.css" ;

または、それらをHTMLファイルに直接追加します。

 < script src =" /path/to/prokrutchik/browser.js " > </ script >
< link href =" /path/to/prokrutchik/styles.css " rel =" stylesheet " />

初期化

デフォルトでは、Screollerはページ上のすべての.scroller要素の自動初期化を提供します。

 < ul class =" scroller " >
  < li > First item </ li >
  < li > Second item </ li >
  < li > Third item </ li >
</ ul >

インスタンスを手動で初期化することもできます。

 < ul class =" foo " >
  < li > First item </ li >
  < li > Second item </ li >
  < li > Third item </ li >
</ ul >

< script type =" module " >
  import { Scroller } from "prokrutchik" ;

  const instance = new Scroller ( {
    element : document . querySelector ( ".foo" ) ,
  } ) ;
</ script >

構成

HTMLのdata-属性を介してScreollerを構成できます。

data-navigation 、ナビゲーションボタンを表示/隠し、 "visible" | "hidden" ;
data-scrollbar 、コンテンツの下にScrollbarを表示/隠し、 "visible" | "hidden" ;
data-align 、画面"start" | "center" | "end" ;
data-start-position 、コンテンツの初期位置、 number of px | "start" | "center" | "end" ;
data-start-duration 、開始アニメーション期間、 number of milliseconds 。

スクロラーアイテムは次のように構成できます。

data-anchor 、ナビゲーション内のアイテムのラベル、 string 。
data-focused 、定義されている場合、Scrollerは開始時にこのアイテムにスクロールします。

JavaScriptを使用します

configオブジェクトを使用してスクロラーを構成することもできます。

 const scroller = new Scroller ( {
  element : document . querySelector ( ".foo" ) ,

  // Show/hide the scrollbar, "visible" | "hidden":
  scrollbar : "hidden" ,

  // Show/hide the navigation, "visible" | "hidden":
  navigation : "hidden" ,

  // How to align content if it fits the screen, "start" | "center" | "end":
  align : "center" ,

  // Initial scroller content position, "start" | "center" | "end" | number of px:
  startPosition : "center" ,

  // Starting animation duration, number of milliseconds:
  startDuration : 500 ,
} ) ;

パブリックAPI

Screollerは、現在の位置を変更し、アイテムのクリックを処理し、構成を動的に更新するためのAPIを提供します。

位置の変更

位置の変更には、 scrollToメソッドを使用します。

 // Scrolls to the beginning of the content
scroller . scrollTo ( "start" ) ;

// Scrolls to the center of the content:
scroller . scrollTo ( "center" ) ;

// Scrolls to the end of the content:
scroller . scrollTo ( "end" ) ;

// Scrolls to 100px from the start of the content:
scroller . scrollTo ( 100 ) ;

// Second optional parameter specifies
// the animation duration in milliseconds.
// Scrolls to center in 500 ms:
scroller . scrollTo ( "center" , 500 ) ;

アイテムクリックコールバックをクリックします

アイテムのクリックを処理するには、構成のonItemClickハンドラーを指定します。

 const scroller = new Scroller ( {
  element : document . querySelector ( ".foo" ) ,
  onItemClick : ( event ) => {
    /* The `event` argument here is `TouchEvent` or `MouseEvent` depending on the user device. */
  } ,
} ) ;

設定の更新

構成の更新には、 update方法を使用します。

 scroller . update ( {
  scrollbar : "hidden" ,
  navigation : "hidden" ,
  align : "center" ,
  onItemClick : someFunc ,
} ) ;

例

HTML Data-Attributesを介して構成された、無効なスクロールバー、アクティブナビゲーション、および開始アラインメントを備えたスクラー：

 < head >
  < link href =" /path/to/prokrutchik/styles.css " rel =" stylesheet " />
  < script src =" /path/to/prokrutchik/browser.js " defer > </ script >
</ head >

< body >
  < ul class =" scroller " data-scrollbar =" hidden " data-align =" start " >
    < img src =" example.png " data-anchor =" anchor1 " />
    < div data-anchor =" anchor2 " > </ div >
    < table data-anchor =" anchor3 " > </ table >
    <!-- ... -->
  </ div >
</ body >

configオブジェクトを介して構成された同じ設定を持つスクローラー：

 import { Scroller } from "prokrutchik" ;
import "prokrutchik/styles.css" ;

const myScroller = new Scroller ( {
  el : document . querySelector ( ".foo" ) ,
  scrollbar : "hidden" ,
  align : "start" ,
} ) ;