Skip to main content

IMSearch Hooks

info

全てのhooksは引数にcontextを渡すことができます。
この引数は、Providerでcontextを設定した場合に利用される事を想定しています。

useIMSearch​

検索を開始するためのFunctionを返します。

Returns​

startSearch​

  • 検索モーダルを表示します。

Arguments​​

interface StartSearchArguments​ {
  target: string;
  type: string;
  paramString: string;
}

target​

検索の種別を表す文字列です。 

ユーザ検索 > jp.co.intra_mart.master.search.user
組織検索 > jp.co.intra_mart.master.search.department
パブリックグループ検索 > jp.co.intra_mart.master.search.public_group
etc...

type​

検索のタイプを表す文字列です。

  • 単一検索の場合
    • single
  • 複数検索の場合
    • multiple

paramString​

検索についてのパラメータを含むjson文字列です。

Example Usage​

import { useIMSearch } from "@intra-mart/smartlime";

const App = () => {
  const  { startSearch } = useIMSearch();

  const onPress = {
    startSearch({
      target: "jp.co.intra_mart.master.search.user",
      type: "single",
      paramString: "{...params}"
    })
  }
}