アクションフック関数とアクションの状態

アクションフック関数とは

アクションフック関数は、スクリプトで利用され、アクションの各状態をフックしてスクリプトを実行できる機能です。

アクションフック関数の引数に渡される、send関数・ユーザ情報変数を利用して、アクションをカスタマイズできます。また、SDKで提供されるユーティリティーを利用して、アクションテーブル・変数・イベントハンドラーの管理ができます。詳細は以降のページで説明します。

フックされるアクションの状態

アクションフック関数は、アクションが作成されて破棄されるまでの以下の５つの状態をフックします:

アクションの作成前(スクリプトファイルのメイン関数)
アクションの表示後(onShow)
アクションが閉じる前(onClose)
ステートが変更された後(onChangeState)
アクションが破棄される前(onDestroy)

各アクションの状態遷移は以下となります:

各アクションフック関数の説明

名前	説明	ユースケース
`スクリプト`ファイルのメイン関数	アクションが作成される前に実行されるスクリプトの登録。フック関数の第一引数のコールバックには、send関数(`props.send`)、ユーザー情報変数(`props.data.XXX`が渡される。	- ページの操作 - Web APIなどでDOM要素を操作 - ページへCSSを適用 - イベントハンドラの設定 - ページ情報の取得 - スクロール情報の取得 - DOM要素の情報(テキスト・属性値の取得) - フォーム入力値の変更の検知 - ホバー操作の取得 - 閲覧アイテムの取得 - 読了状態の取得 - URLから検索クエリを取得 - APIから取得した情報の反映 - Cookie情報の取得 - localStorage情報の取得 - アクションの初期設定 - 変数の設定 - イベントハンドラの設定 - アクション自動実行の停止 - ユーザー情報変数の設定 - アクションテーブルの利用 - 初期ステートの設定 - アクションへCSSを適用 - イベントの送信
onShow(props)	アクションが表示された後に実行されるスクリプトの登録。フック関数の第一引数のコールバックには、send関数(`props.send`)、ユーザー情報変数(`props.data.XXX`が渡される。	- アクションの操作 - カルーセルやルーレットなどの処理を追加 - ステートの遷移 - アクション情報の取得 - 現在のステートの取得 - ステート一覧の取得 - イベントの送信
onClose(props, trigger)	アクションが閉じられる前に実行されるスクリプトの登録。フック関数の第一引数のコールバックには、send関数(`props.send`)、ユーザー情報変数(`props.data.XXX`が渡される。フック関数の第二引数には、閉じた時のトリガー名(`trigger`)が渡される。	- ページ情報の取得 - アクション情報の取得 - カスタムイベントの送信
onChangeState(props, newState)	アクションのステートが変更した後に実行されるスクリプトの登録。フック関数の第一引数のコールバックには、send関数(`props.send`)、ユーザー情報変数(`props.data.XXX`が渡される。フック関数の第二引数には、新しいステート(`newState`)が渡される。	- ページの操作 - ページ情報の取得 - アクションの操作 - アクション操作の後処理 - アクション情報の取得 - カスタムイベントの送信
onDestroy(props)	アクションが破棄される前に実行されるスクリプトの登録。フック関数の第一引数のコールバックには、send関数(`props.send`)、ユーザー情報変数(`props.data.XXX`が渡される。	- アクションの操作 - window.removeEventListenerなどのスクリプトの後処理 - カスタムイベントの送信

詳細な情報は以下のドキュメントを参照してください:

KARTE Action SDK API リファレンス

具体的な利用方法

アクションフック関数の利用

import type { ActionProps } from '@plaidev/karte-action-sdk';
import { onShow, onClose, onChangeState } from '@plaidev/karte-action-sdk';

onShow((props: ActionProps): void => {
	props.send('show-action', { item: props.data.uivValue });
});

onClose((props: ActionProps, trigger: CloseTrigger): void => {
	props.send('close-action', { trigger, item: props.data.uivValue }); });
});

onChangeState((props: ActionProps, newState: string): void => {
	props.send('change-state', { newState, item: props.data.uivValue }); });
});

const onCreate((props: ActionProps): void => {
  props.send('create-sction', { item: props.data.uivValue });
});

Updated 12 months ago

What’s Next

カスタムイベントの送信