@k8ordo/router

ベースパス

https://example.com/docs/のように、アプリをベースパスの下で配信するときの書き方です。ルート表は/から書いたままで、ベースパスの付け外しはルーターが行います。

このページの内容

Viteのbase

vite.config.ts
import react from '@vitejs/plugin-react';
import { defineConfig } from 'vite';

export default defineConfig({
  base: '/docs/',
  plugins: [react()],
});

ベースパスはViteのbaseで指定します。ルーターはimport.meta.env.BASE_URLからその値を読みます。

ルート表は変えません。/productsのページは、表では/productsのままで、アドレスバーでは/docs/productsになります。

ts
href('/products'); // '/docs/products'
href('/'); // '/docs/'

hrefとnavigateToは、作るURLの先頭にベースパスを付けます。そのため、hrefの戻り値の型はルート表のパスでなくstringです。

@k8ordo/frameworkでベースパスが付くURLは、デプロイで説明しています。

警告

落とし穴

hrefが返したURLを@k8ordo/stateのhrefに渡すと、ベースパスが2重に付きます。詳しくは@k8ordo/stateのリンクを見てください。

読み取るパス

ts
// at /docs/products
usePathname(); // '/products'

usePathnameは、ベースパスを外したパスを返します。/docs/productsを開いているとき、値は/productsです。返ってきたパスは、ルート表のパターンとそのまま比べられます。

useMatchと<Router>も、ベースパスを外したパスでルート表と照合します。

ベースパスの外のURLは、ルート表に何が書いてあっても<Router>は照合しません。ブラウザの通常の遷移になります。

withBaseとwithoutBase

ts
withBase('/products'); // '/docs/products'
withoutBase('/docs/products'); // '/products'
withoutBase('/docs'); // '/'
withoutBase('/elsewhere'); // null
withBase('/products', '/docs/'); // '/docs/products'
Viteを通らないコードでは、2つ目の引数でベースパスを渡す

withBaseとwithoutBaseは、ルーターが行う付け外しを自分のコードで使うための関数です。withoutBaseは、ベースパスの外のパスにnullを返します。ベースパスそのもの(/docs)は、末尾のスラッシュが無くても/になります。

Viteを通らないコードにはimport.meta.envが無いので、ルーターはベースパスを読めません。

./のような相対のbaseはパスを指していないので、どちらの関数も何も付け外ししません。

k8ordo

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