アクション
結果表示のカスタマイズ
組み込み関数
linkToAction

linkToAction

linkToAction関数は、別のアクションの実行画面へ移動できるリンクを表示できる関数です。

基本的な使い方

ユーザーの一覧を表示するアクションの実行結果に、ユーザーの詳細を表示するアクションへ移動できるリンクを表示する例を考えます。

移動先のユーザーの詳細を表示するアクションは、以下のようなユーザーのIDをパラメーターとして受け取るアクションです。

linkToAction関数の使用例の移動先のアクション

使用例

以下がユーザーの一覧を表示するアクションに設定するスクリプトです。

const users = results[0].success;
return [
  {
    success: users.map((user) => ({
      名前: linkToAction(
        user.name,
        // ユーザーの詳細を表示するアクションの識別子を設定
        "get-user-detail",
        // 移動時にアクションを実行するように設定
        true,
        // ユーザーの詳細を表示するアクションへ渡すパラメータの値を設定
        { userId: user.id },
      ),
      メールアドレス: user.email,
    })),
  },
];

表示結果

linkToAction関数の使用例の表示結果

表示されたリンクをクリックすると、ユーザーの詳細を表示するアクションのページに移動します。

// 移動時にアクションを実行するように設定
true,

使用例のコードの上記の部分で、第3引数のopenAndRunにtrueを設定しているので、ページ移動時にユーザーの詳細を表示するアクションが実行され、以下のように実行結果のみが表示されます。

linkToAction関数の使用例の移動先のアクションの実行結果

詳細なインターフェース

引数

引数名型説明例
titlestringリンクとして表示するテキストです。必須の引数です。"実行する"
actionIdstring移動先のアクションIDまたは識別子です。必須の引数です。"get-user-detail"
openAndRunboolean移動時にアクションを実行するかどうかを指定します。true
paramsobject移動先のアクションへ渡すパラメータでキーがパラメータ名、値がパラメータに渡す値のオブジェクト。{ userID: 1 }

なお移動先のアクションのパラメータの入力値の種類ごとにparamsへ渡せる値の型は以下です。

入力値の種類型説明例
テキストstring-{ company_name: '株式会社ベースマキナ' }
数値number | null-{ user_id: 123 }
日付Date | string | number | nullstringはDate型に変換できる値、numberはUnixTimestamp (秒)を入力してください。{ created: '2023-01-01', updated: new Date(), deleted: 1609459200 }
ファイルFile | null-{ upload_text: new File(['test'], 'test.txt', { type: 'text/plain' }) }
真偽値boolean-{ checked: true }
JSON値string | number | Date | nullJSON値の種類ごとに型が異なります。
テキストならstring | null、数値ならnumber | null、日付ならstring | number | Date | nullを渡せます。
日付の場合stringはDate型に変換できる値、numberはUnixTimestamp (秒)を入力してください。　		{ company_name: '株式会社ベースマキナ', user_id: 123, created: '2023-01-01', deleted: null }
SQLstring-{ query: 'SELECT * FROM users;' }
システム値string-{ offset: '20' }
配列Array各要素の種類の型は、各入力値の種類の型と同じです。{ user_ids: [10, 11, 12] }
タプルArray各要素の種類の型は、各入力値の種類の型と同じです。{ id_and_name: [123, 'taro'] }

アクションのIDまたは識別子の確認方法

アクションのIDまたは識別子は、アクションの実行画面の編集ボタンの下から確認できます。

アクションIDまたは識別子の確認方法

戻り値

戻り値はありません。

ページネーションlinkToURL