API Docs for: 0.9.9
Show:

Kazitori Class

Defined in: kazitori.js:70
Module: Kazitori.js

Kazitori のメインクラス

Constructor

Kazitori

()

Defined in kazitori.js:70

Methods

appendRouter

(
  • child
  • childRoot
)

Defined in kazitori.js:658

ルーターを動的に追加します。
ルーターの追加に成功した場合、ADDED イベントがディスパッチされます。

example

fooRouter = new FooRouter();
app.appendRouter(foo);

Parameters:

beforeFailedHandler

()

Defined in kazitori.js:194

before 処理が失敗した時に実行されます。
デフォルトでは空の function になっています。

change

(
  • fragment
  • options
)

Defined in kazitori.js:446

url を変更します。
無事 URL が切り替わった場合、CHANGE イベントがディスパッチされます。

example

app.change('/someurl');

Parameters:

  • fragment String

    変更したい URL

  • options Object

    オプション

extractParams

(
  • rule
  • fragment
  • test
)

Defined in kazitori.js:1136

URL パラメータを分解

Parameters:

getFragment

(
  • fragment
)

Defined in kazitori.js:1071

URL ルート以下を取得

Parameters:

getHash

() String

Defined in kazitori.js:1119

URL の # 以降を取得

Returns:

String: URL の # 以降の文字列

loadURL

(
  • fragmentOverride
  • options
)

Defined in kazitori.js:778

ブラウザから現在の URL を読み込みます。

Parameters:

match

(
  • fragment
)
Boolean

Defined in kazitori.js:801

指定した 文字列に対応した URL ルールが設定されているかどうか
Boolean で返します。

example

app.match('/hoge');

Parameters:

Returns:

omokazi

(
  • options
)

Defined in kazitori.js:411

ブラウザヒストリー機能を利用して「戻る」を実行します。
成功した場合 PREV イベントがディスパッチされます。

Parameters:

reject

()

Defined in kazitori.js:553

中止します。

removeRouter

(
  • child
  • childRoot
)

Defined in kazitori.js:713

動的に追加したルーターを削除します。 ルーターの削除に成功した場合、REMOVED イベントがディスパッチされます。

example

foo = new FooRouter();
app.appendRouter(foo);
app.removeRouter(foo);

Parameters:

replace

(
  • fragment
  • options
)

Defined in kazitori.js:496

pushState ではなく replaceState で処理します。
replaceState は現在の URL を置き換えるため、履歴には追加されません。

example

app.replace('/someurl');

Parameters:

  • fragment String

    変更したい URL

  • options Object

    オプション

resume

()

Defined in kazitori.js:584

処理を再開します。
RESUME イベントがディスパッチされます。

start

(
  • options
)

Defined in kazitori.js:329

Kazitori.js を開始します。
START イベントがディスパッチされます。

Parameters:

  • options Object

    オプション

stop

()

Defined in kazitori.js:383

Kazitori.js を停止します。
STOP イベントがディスパッチされます。

suspend

()

Defined in kazitori.js:568

処理を一時停止します。
SUSPEND イベントがディスパッチされます。

torikazi

(
  • options
)

Defined in kazitori.js:399

ブラウザのヒストリー機能を利用して「進む」を実行します。
成功した場合 NEXT イベントがディスパッチされます。

Parameters:

Properties

beforeAnytimeHandler

Array

Defined in kazitori.js:115

URL が変わる際、事前に実行したい処理を定義します。
このプロパティに登録された処理は、与えられた URL にマッチするかどうかにかかわらず、常に実行されます。

Default: []

befores

Object

Defined in kazitori.js:103

マッチした URL に対する処理を行う前に実行したい処理を定義します。

Default: {}

fragment

String

Defined in kazitori.js:224

現在の URL を返します。

Default: null

isSuspend

Boolean

Defined in kazitori.js:248

一時停止しているかどうかを返します。

Default: false

lastFragment

String

Defined in kazitori.js:234

現在の URL から 1つ前の URL を返します。

Default: null

notFound

String

Defined in kazitori.js:154

現在の URL にマッチするルールがなかった場合に変更する URL

Default: null

root

String

Defined in kazitori.js:137

ルートを指定します。
ここで指定された値が URL の prefix として必ずつきます。
物理的に URL のルートより 1ディレクトリ下がった箇所で pushState を行いたい場合
この値を / 以外に指定します。

example

コンテンツを配置する実ディレクトリが example だった場合

app = new Router({root:'/example/'})

Default: /

rootFiles

Array

Defined in kazitori.js:128

特定のファイル名が URL に含まれていた時、ルートとして処理するリストです。

routes

Object

Defined in kazitori.js:86

マッチするURLのルールと、それに対応する処理を定義します。

example

routes:
  '/':'index'
  '/<int:id>':'show'

Default: {}

silent

Boolean

Defined in kazitori.js:168

URL を実際には変更しないようにするかどうかを決定します。
true にした場合、URL は変更されず、内部で保持している状態管理オブジェクトを基準に展開します。

Default: false

started

Boolean

Defined in kazitori.js:179

pushState への監視が開始されているかどうか

Default: false