共通のparam
ロケールやテナントのように、ほとんどのパスの先頭に付くparamをbindParamsで1か所にまとめます。リンクのたびに同じ値を渡さずに済みます。
このページの内容
束ねる関数
src/links.tsimport { bindParams } from '@k8ordo/router';
import { locales } from './i18n';
export const { href, navigateTo } = bindParams(() => ({
locale: locales.getLocale(),
}));bindParamsには、束ねるparamを返す関数を渡します。返ってくるhrefとnavigateToは、渡されなかったparamをこの関数の値で埋めます。
アプリのコードでは、hrefとnavigateToをこのモジュールからimportします。
束ねたリンク
import { href, navigateTo } from './links';
href('/:locale/products/:id', { id: '42' }); // '/ja/products/42'
href('/:locale', { locale: 'en' }); // '/en'
束ねた`locale`を渡して上書きする
navigateTo('/:locale/products');パターンは/:locale/…と書いたままにします。束ねたlocaleは省けるので、渡すのはそれ以外のparamだけです。コメントの結果は、今のロケールをjaとして書いています。
言語の切り替えのように別のロケールのページを指すリンクでは、束ねたparamを渡して上書きします。
パターンを書き換えないので、Registerによる型の検査はそのまま効きます。表に無いパターンや、束ねていないparamの渡し忘れは型エラーになります。
ロケールのparam
src/components/docs-link.tsximport { useMatch } from '@k8ordo/router';
import { href } from '../links';
export function DocsLink() {
const inDocs = useMatch('/:locale/docs/*') !== null;
return (
<a aria-current={inDocs ? 'page' : undefined} href={href('/:locale/docs')}>
Docs
</a>
);
}locales.getLocale()は@k8ordo/i18nの関数です。返すロケールについては今のロケールを見てください。
useMatchも、/:locale/docs/*のようにロケールを含むパターンのまま呼べます。ロケールは:localeのparamとして一致するので、どの言語のページでも同じように一致します。
関数を呼ぶ時点
束ねる関数は、hrefやnavigateToを呼ぶたびに呼ばれます。リクエストやURLで変わる値でも、リンクを作る時点の値が入ります。
bindParamsは、モジュールのトップレベルで1度呼べば十分です。
どのパッケージが値を返すかはアプリが決めます。ルーターが知っているのはparamの名前だけです。
オプションの位置
navigateTo('/:locale', undefined, { history: 'replace' });
paramの代わりに`undefined`を渡す
navigateTo('/:locale', { locale: 'en' }, { history: 'replace' });
navigateTo('/:locale', { history: 'replace' });
オプションを2つ目に書くと型エラーになるすべてのparamを束ねたパターンでも、navigateToのオプションは3つ目の引数です。
パターンにparamがあれば、2つ目の引数はいつもparamsとして読まれます。
落とし穴
型エラーをasなどで消してオプションを2つ目に渡すと、paramsとして読まれます。historyは無視され、新しい履歴エントリが追加されます。