useURLQueries

useURLQueries は、現在のURLのクエリパラメータを取得するためのフックです。これにより、アプリケーション内の各コンポーネントがURLパラメータを使用して動作を調整することが可能になります。

基本的な使い方

import {
    useURLQueries
} from '@basemachina/view'
 
const App = () => {
    const urlQueries = useURLQueries();
    console.log(urlQueries); // クエリパラメータのオブジェクトが出力されます
    ...
}

詳細なインターフェース

引数

このフックは引数を取りません。

戻り値

型	説明	例
`object`	URLのクエリパラメータを表すオブジェクト。キーはクエリパラメータの名前で、値はそのパラメータの値を表します。パラメータが存在しない場合、その値は空オブジェクトとなります。	`{ query1: 'value1', query2: 'value2' }`

なお、戻り値のオブジェクトは、各プロパティの値が string | string[] | undefined 型になります。

これは、同一のクエリパラメータ名がURL内に複数存在する場合、その値を配列として表現するためです。例えば、URLが http://example.com?query=value1&query=value2 の場合、戻り値のオブジェクトは { query: ['value1', 'value2'] } となります。

useBaseMachinaContext copyToClipboard