API · その他
riot.version
現在のバージョン番号を文字列として: '3.13.2'
riot.settings.keepValueAttributes (default false)
>= v3.13
Riotはデフォルトで全ての falsy な属性式を削除します。しかし、 <input> 要素などの場合では、 value という属性は常に維持されるべきです。 参照 issue/2629 keepValueAttributes=true を設定することにより、Riot はその値が falsy でも value 属性を削除しなくなります。
riot.settings.keepValueAttributes = true
riot.settings.skipAnonymousTags (default true)
>= v3.2
Riotでは、ループ内の全ての新しいタグは新しいRiotタグインスタンスを生成します。これはカスタムタグや、<li each={ item in items }>{ item }</li>のようなanonymousタグに対しても発生します。ループの終わりでは、それらは渡されるべきではない、かつ riot mixins に渡す必要がないため、ため、Riotはより軽量なタグインスタンスを生成します。このことがレンダリングの処理を格段に速めるでしょう。
しかし、バージョンが3.2以下の Riot は、全ての anonymous タグを完全にカスタムタグをインスタンス化するために使用されました。skipAnonymousTags = falseの場合、anonymousタグはもはや軽いタグとして生成されなくなり、あなたのアプリケーションは〜30%遅くなります。
riot.settings.skipAnonymousTags = false
riot.settings.autoUpdate (default true)
>= v3.6
アップデートイベントは、ユーザーがRiotタグのいずれかをディスパッチする際に、DOMハンドラ（onclickなど）を含むRiotタグ内で自動的にトリガーされます。autoUpdateオプションをfalseに設定すると、この動作が無効になり、手動でタグのアップデートをトリガーする必要があります。
riot.settings.autoUpdate = false
riot.settings.brackets (default { })
テンプレート変数の開始/終了トークンをカスタマイズするための、Riotのグローバル設定。例:
riot.settings.brackets = '[% %]'
<p>[% like_this %]</p>のように書けます。開始と終了はスペースで区切られています。
riot.settings.asyncRenderTimeout
riot.renderAsync のタイムアウト時間を変更することができます(デフォルト値は 1000ミリ秒)。
riot.settings.asyncRenderTimeout = 2000 // ms
riot.util.tmpl
Riotの内部で使われているテンプレートエンジンを参照します。
riot.util.tmpl.errorHandler
Riotのテンプレートエンジンによって隠蔽されたすべてのエラーを補足するためのユーティリティフックです。
riot.util.tmpl.errorHandler = function (err) {
console.error(err.message + ' in ' + err.riotData.tagName) // あなたのエラーロジックはここに格納
}
riot.util.styleManager
カスタムタグのCSSを生成し、挿入するために使用されるオブジェクトです。
riot.util.vdom
Riotによって作成された全てのタグのインスタンスに対して、参照、デバッグ、フィルタリングなどを行うために、Riotが内部で持つタグのキャッシュを公開します。
riot.tag('foo', '<p>{ msg }</p>', function() {
this.msg = 'hi'
})
riot.mount('foo')
console.log(riot.vdom[0].msg) // 'hi'
riot.util.dom
クエリを発行する $ や、ノードに属性を追加する setAttr のようなDOM要素を更新するようなユーティリティ関数の集まりです。
riot.util.check
型をチェックするために必要とされるヘルパ関数の集まりです。
riot.util.misc
オブジェクトを拡張する extend や、配列をループする each などのヘルパ関数の集まりです。
riot.util.tags
全てのRiotのタグインスタンスを内部的に管理するために必要な関数の集まりです。