概要

Onboardingにはガイドの一連の動作を成り立たせるための、いくつかの代表的なイベントが存在しています。

このカスタムファンクションは、それらのイベントに対してお客様が自由に処理を行えるようにすることで、ガイドのカスタマイズ性を高めるための機能です。

イベント一覧

以下がカスタムファンクションで利用可能なイベント一覧です。

イベント名	引数	引数の型	概要
`ready`	`第一引数`:初めてのOnboarding起動であれば`True` 、2回目以降であれば`False`	`第一引数`: boolean	Onboardingのスクリプトが初期化され、利用可能となったタイミングで発生します。JavaScriptタグが読みこまれるたびにコールされます。
`intro_displayed`			イントロが表示されたタイミングで発生します。
`goal_started`	`第一引数`: 開始されたゴールID `第二引数` : 開始されたステップID	`第一引数`: string `第二引数`: string	ゴールが開始されたタイミングで発生します。
`step_displayed`	`第一引数`: 表示中のゴールID `第二引数` : 表示されたステップID	`第一引数`: string `第二引数`: string	ステップが表示されたタイミングで発生します。
`step_forwarded`	`第一引数`: 表示中のゴールID `第二引数` : 次に表示されるステップID	`第一引数`: string `第二引数`: string	ステップが次へ進んだタイミングで発生します。
`step_aborted`	`第一引数`: 離脱されたゴールID `第二引数` : 離脱されたステップID	`第一引数`: string `第二引数`: string	ステップから離脱したタイミングで発生します。
`goal_completed`	`第一引数`: 完了されたゴールID `第二引数` : 完了されたステップID	`第一引数`: string `第二引数`: string	ゴールが完了されたタイミングで発生します。
`hint_displayed`	`第一引数`: 表示されたヒントID	`第一引数`: string	ヒントが表示されたタイミングで発生します。
`hint_hidden`	`第一引数`: 閉じられたヒントID	`第一引数`: string	ヒントが閉じられたタイミングで発生します。

設定方法

以下のように、OnboardingのJavaScriptタグの ONB._custom_functions に記述します。

以下の例では仮でmyFunc という関数を渡しています。こちらはお客様の定義する関数名に適宜修正ください。

ONB._custom_functions = {
		"ready": "myFunc", 
}

このように、キーにイベント名、値にはそのイベントで行いたい処理が定義された関数名を指定します。

それにより、該当のイベントが発生するタイミングで、値に設定された関数がコールバック関数として実行されます。

利用例

本機能の利用例の一部をご紹介します。

以下の記述により、「初めてお客様サイトにアクセスしたユーザーにイントロを表示する」という設定を行なっています。

<script type="text/javascript">
	// 略

	ONB._custom_functions = {
	    "ready": "myFunc",
	}
	
	function myFunc(isFirst) {
		if (isFirst) {
		  STANDSMotion.showIntro()
		}
	}

	// 略
</script>

※ イントロを表示するため、Onboarding JavaScript API を利用

Onboarding ヘルプページ

カスタムファンクション設定

概要

目次

イベント一覧

設定方法

利用例