--- layout: page title: インストールと設定 permalink: /install-and-settings/ ---

インストール

任意の場所に、Githubよりリポジトリをクローン、またはZIPをダウンロードし解凍します。

Github

smooziee.js を jQueryの後に読み込みます。

{% highlight html %} {% endhighlight %}

smooziee を実行します。

{% highlight js %} $(function()){ $.smooziee(); }); {% endhighlight %}

オプション

オプションについては以下のとおりです。

{% highlight js %} $(function()){ $.smooziee({ ignore: '.no-scroll', // スクロールを除外するクラス offset: -20, // 移動先のオフセット otherPageScroll: true, // 他ページへのリンクの際のスクロール scrollKey: 'scroll_id', // ハッシュタグの代わりに使用するクエリのキー speed: 1000, // スクロール開始から終了までの時間 urlHistory: 'replace', // URL書き換え時にhistoryを追加するか上書きするか urlParam: 'hash' // URLの書き換え hash, none, default }); }); {% endhighlight %}
ignore cssのセレクタ(クラス名) 指定したクラス名がついたaタグをクリックしてもスムーススクロールが発生しません。
offset int ターゲット要素のY座標にこの値を足したY座標へスクロールします。
otherPageScroll bool サイト内の他ページへリンクした際のスムーススクロールを有効・無効にする
scrollKey string 他ページへのリンクの際に、ハッシュタグに代わって使われるクエリのキーです。デフォルトでは、 http://example.com/#link へのリンクは http://example.com/?scroll_id=link に変換されます。
speed int スクロール開始から終了までの時間(ms)
urlHistory string ('replace', 'push')

URLの書き換えが発生したときに、URLの履歴(History(をどう扱うか指定します。

replace
書き換え前の履歴を現在の履歴で上書きします。
push
書き換え前の履歴の後に、現在の履歴を追加します。
urlParam string ('hash', 'none', 'default')

ハッシュタグのついたaタグをクリックした時に、URLをどう書き換えるかを指定します。

hash
通常のページ内リンクと同じくハッシュタグを付与します。http://example.com/#link
none
ページ内リンクを行っても、ハッシュタグを付与しません。http://example.com
default
他ページへのリンクをした際にはハッシュタグが変換されますが、変換されたそのままの状態でアドレスバーに表示されます。http://example.com/?scroll_id=link
また、ページ内リンクの際は何も付与しません。