NarraLeaf

useQueryParams

現在の LayoutRouter のクエリパラメータを返し、変化に応じて更新される useQueryParams フック

現在のクエリパラメータをオブジェクトとして返し、LayoutRouter の変化と同期させます。

import { useQueryParams } from "narraleaf-react";

const { tab, theme } = useQueryParams<{ tab?: string; theme?: string }>();

定義

function useQueryParams<T extends Record<string,string>>(): T;

このフックは内部で router.onChange を購読しているため、ナビゲーション時や router.setQueryParam(s) によってクエリの値が変更されたときに再描画されます。

関連項目:usePathnameuseParams

このページの目次