openActionLink

openActionLink は、指定したアクションへのリンクを開くための関数です。リンクを開く際に、引数やオプションを指定できます。

基本的な使い方


import { openActionLink } from "@basemachina/view";
 
const App = () => {
  const handleClick = () => {
    openActionLink(
      "action-id",
      {
        param1: "value1",
        param2: "value2",
      },
      {
        newTab: true,
        openAndRun: true,
      },
    );
  };
 
  return <button onClick={handleClick}>Open link</button>;
};

詳細なインターフェース

引数

引数名	型	説明	例
`actionId`	`string`	開きたいアクションのID、または識別子。	`c3hc2ii23akg0sokf9j0`, `get-user`
`params`	`object`	アクションを開く際に指定する引数。引数の名前と値のペアを持つオブジェクトです。	`{ param1: "value1", param2: "value2" }`
`options`	`object`	リンクを開くオプションを指定するオブジェクト。新しいタブで開くかどうかを指定する `newTab` プロパティと、リンクを開いたときにアクションを即時実行する `openAndRun` プロパティを持つことができます。	`{ newTab: true, openAndRun: true }`

戻り値

openActionLink 関数は戻り値を返しません。

ただし、関数の実行によりアクションへのリンクが開かれ、その結果が画面に表示されます。