@k8ordo/router

現在地

ブラウザが今開いているパスを読んで、現在のページへのリンクにaria-currentを付けたり、読み込み中のページを表示したりします。

このページの内容

今のパス

src/current-path.tsx
import { usePathname } from '@k8ordo/router';

export function CurrentPath() {
  const pathname = usePathname();
  return <p>You are at {pathname}</p>;
}

usePathnameは、ブラウザが今開いているパスを返します。末尾のスラッシュは取り除いて返します。パスはデコードしないので、日本語のような文字はパーセントエンコードされたまま返ります。

再描画されるのはパスが変わったときだけです。クエリは返さず、クエリが変わっても再描画されません。クエリは@k8ordo/stateで読みます。

ルート表は要らないので、@k8ordo/frameworkの下でも同じように使えます。

ページの判定

src/products-link.tsx
import { href, useMatch } from '@k8ordo/router';

export function ProductsLink() {
  const isCurrent = useMatch('/products') !== null;

  return (
    <a
      aria-current={isCurrent ? 'page' : undefined}
      href={href('/products')}
    >
      Products
    </a>
  );
}

useMatchは、今のパスがパターンに合えばそのparamを返します。合わなければnullを返します。ナビゲーションのリンクにaria-currentを付けるときに使います。

<Link>のようなコンポーネントは無いので、aria-currentはこのように自分で付けます。useMatchも、再描画されるのはパスが変わったときだけです。

/*のパターン

ts
matchPath('/products/*', '/products/42'); // {}
matchPath('/products/*', '/products'); // null
matchPath('/products/*', '/products', { inclusive: true }); // {}

パターンの後ろに/*を付けると、そのパターンより下のパスに合います。サイドバーのように、どの節を開いているかを知りたいときに使います。

/products/*は、/productsそのものには合いません。/productsそのものにも合わせるときは、{ inclusive: true }を渡します。

matchPathは、渡したパスに対してuseMatchと同じ判定をする関数です。/*を付けられるのは、ルート表にあるパターンの後ろだけです。Registerを拡張していれば、表に無いパターンは型エラーになります。

Playground

照合のデモ

このページでusePathnameが返したパスから始めて、matchPathの結果を確かめます。

usePathname()の値/ja/router/location

呼び出し
matchPath('/:locale/router/*', '/ja/router/location')
結果
{ locale: 'ja' }

試してみる

  1. 最初は、パターンが/:locale/router/*で、パスがこのページのパスです。結果は{ locale: 'ja' }で、/*に合った部分はparamに入りません。
  2. パスを/ja/routerに書き換えると、結果はnullになります。/*は、パターン自身のページには合いません。
  3. 「inclusive」をオンにすると、結果が{ locale: 'ja' }に戻ります。
  4. パスの末尾に/を足しても、結果は変わりません。比べる前に末尾のスラッシュを取り除きます。

読み込み中のパス

src/progress.tsx
import { usePendingPathname } from '@k8ordo/router';

export function Progress() {
  const pending = usePendingPathname();
  if (pending === null) return null;

  return <p role="status">Loading {pending}…</p>;
}

usePendingPathnameは、読み込み中のページのパスを返します。何も読み込んでいないときはnullです。

ページを移るとき、URLが先に書き換わり、新しいページは準備ができてから画面に出ます。遅いナビゲーションでは、usePathnameがもう新しいパスを返しているのに、画面には前のページが残っています。

値はナビゲーションが始まった時点で入り、新しいページが画面に出るとnullに戻ります。ナビゲーションの中断や読み込みの失敗でもnullに戻ります。クエリだけを変える更新では、ページが読み込み直さない限り値は入りません。

paramの読み取り

src/pages/product-page.tsx
import { useParams } from '@k8ordo/router';

export function ProductPage() {
  const { id } = useParams('/products/:id');
  return <h1>Product {id}</h1>;
}

<Router>が表示するページは、useParamsに自分のパターンを渡してparamを読みます。型はパターンの文字列から推論され、値はいつも文字列です。

渡すパターンは、このコンポーネントがそのパターンのページとして表示されるという宣言でもあります。別のパターンのページの中で表示すると、次のエラーになります。

text
useParams("/products/:id") rendered under "/products"

複数のページで使い回すコンポーネントは、useRouteで、今選ばれているパターンとparamを型の無い形で受け取ります。

ts
const { pattern, params } = useRoute();
警告

落とし穴

@k8ordo/frameworkの下ではuseParamsとuseRouteは使えず、ページはparamsをpropsで受け取ります(パラメータ)。

k8ordo

Baselineに入った機能を、制限なく使うReactのライブラリ群。