@k8ordo/router

エラーと読み込み中

ルート表のerrorとloadingで、ページの描画中に例外が起きたときの表示と、ページの準備ができるまでの表示を出せるようになります。React.lazyで分けたページの待ち方も扱います。

このページの内容

エラーの表示

src/routes.ts
export const routes = defineRoutes({
  '/products': {
    layout: ProductsLayout,
    error: ProductsError,
    children: {
      '/': ProductList,
      '/:id': ProductPage,
    },
  },
});
src/products-error.tsx
import type { ErrorProps } from '@k8ordo/router';

export function ProductsError({ error, reset }: ErrorProps) {
`error`は起きた例外、`reset`は再描画する関数
  const message =
    error instanceof Error ? error.message : 'Something went wrong';

  return (
    <div role="alert">
      <p>{message}</p>
      <button onClick={reset} type="button">
        Try again
      </button>
    </div>
  );
}

childrenを持つオブジェクトにはerrorを書けます。その下のページの描画中に例外が起きると、ページの代わりにerrorのコンポーネントを表示します。表示する位置はレイアウトの<Outlet />で、レイアウトはそのまま残ります。

errorの型はunknownです。reset()を呼ぶと、その場で下のページを再描画します。また例外が起きれば、errorのコンポーネントに戻ります。

エラーの表示は、別のページに移って次のページが画面に出たときに消えます。このオブジェクトの下にあるレイアウトも作り直されず、状態を保ちます。クエリだけを変える状態の更新はページの切り替えではないので、エラーの表示は残ります。

情報

メモ

レイアウト自身で例外が起きたときは、同じオブジェクトのerrorは表示されません。errorのコンポーネントはレイアウトの内側に表示するためです。その例外は外側のオブジェクトのerrorが表示し、どこにも無ければ<Router>の外まで伝わります。

読み込み中の表示

src/routes.ts
export const routes = defineRoutes({
  '/products': {
    layout: ProductsLayout,
    error: ProductsError,
    loading: ProductsLoading,
    children: {
      '/': ProductList,
      '/:id': ProductPage,
    },
  },
});
src/products-loading.tsx
export function ProductsLoading() {
  return <p role="status">Loading products…</p>;
}

loadingには、その下のページがサスペンドしている間に出すコンポーネントを書きます。propsは受け取りません。

loadingを書いた位置に<Suspense>が置かれ、loadingのコンポーネントがそのfallbackになります。errorも書いたときは、この<Suspense>はerrorのエラーバウンダリの内側に置かれます。

fallbackが出るのは、ページを最初に開いたときと、ほかのページからこのオブジェクトの下へ移ってきたときです。すでにこのオブジェクトの下にいて別のページへ移るときは、次のページの準備ができるまで前のページを出したままにします。その間に読み込み中を表示したいときは、usePendingPathnameを使います。使い方は現在地を見てください。

ページのコード分割

src/routes.ts
import { defineRoutes } from '@k8ordo/router';
import { lazy } from 'react';

const Settings = lazy(() => import('./pages/settings'));

export const routes = defineRoutes({
  '/': {
    layout: Shell,
    loading: PageLoading,
    children: {
      '/': Home,
      '/settings': Settings,
    },
  },
});

ページのコンポーネントは、React.lazyで包んでルート表に書けます。そのページを初めて描画するときにコードが読み込まれます。

読み込みの間は、上にある<Suspense>のfallbackが出ます。loadingを書くか、レイアウトで<Outlet />を<Suspense>で包んで、fallbackを出す場所を用意してください。

fallbackが出る場面はloadingと同じです。上の例では/のオブジェクトがすべてのページを包んでいます。/settingsを直接開いたときはfallbackが出て、ホームから/settingsへ移ったときはコードが読み込まれるまでホームが出たままです。

警告

落とし穴

errorを書いたオブジェクトは、下のページをfallbackがnullの<Suspense>でも包みます。その下でReact.lazyのページがサスペンドしても、上のレイアウトの<Suspense>までは伝わらず、何も表示されません。fallbackを出したいときは、同じオブジェクトにloadingを書くか、それより下に<Suspense>を置いてください。

k8ordo

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