CSS・JS・TSのエントリー

エントリーは、ビルドで処理する入口となるファイルです。例えば、HTMLから読み込むscripts.tsを入口にすると、そのファイルと、そこからimportするコードやCSSもまとめて処理されます。

CSS・JavaScript・TypeScriptは、HTMLのlinkやscriptで参照することでエントリーとして指定できます。pluginSsg()が参照先のファイルをViteで処理し、HTML内のURLをビルド後のものへ置き換えます。追加のプラグインは不要です。

ここではトップページに、ボタンを押すと挨拶を表示する通常のJavaScriptを追加します。Reactの状態を使うUIはIslandで扱います。

Table of Contents

ブラウザ用のコードを作る

src/assets/scripts.tsを作ります。このファイルはブラウザで実行されるため、documentやwindowを利用できます。

src/assets/scripts.ts
document.querySelector("[data-greeting]")?.addEventListener("click", () => {
  window.alert("こんにちは!")
})

TypeScriptを使わない場合は同じ内容をscripts.jsへ書けます。ブラウザの処理は、静的HTMLを生成するページやレイアウトのトップレベルへ置かず、このファイルへ分けます。

HTMLからエントリーを指定する

CSSはlink、JavaScript・TypeScriptはscriptで参照します。ここで使うglobals.cssはCSSのバンドルで作成したファイルです。

src/pages/index.tsx
import { Head } from "minista/head"

export default function Page() {
  return (
    <>
      <Head>
        <link rel="stylesheet" href="/src/layouts/globals.css" />
        <script type="module" src="/src/assets/scripts.ts" />
      </Head>
      <h1>My Site</h1>
      <button type="button" data-greeting>
        挨拶する
      </button>
    </>
  )
}

先頭の/はプロジェクトルートを基準にします。例えば、/src/assets/scripts.tsはプロジェクト内のsrc/assets/scripts.tsを参照します。scriptにはtype="module"を指定してください。

CSSをこの方法で指定する場合は、同じファイルのimportを外して二重読み込みを避けます。全ページ共通のエントリーなら、参照をレイアウトへ移します。

ビルド結果を確認する

npm run buildを実行すると、次の順に処理します。

  1. ページやLayoutから生成したHTMLのlinkのhref属性とscriptのsrc属性を調べ、元ファイルへの参照を見つけます。
  2. 参照先のファイルと、そのファイルがimportする依存先をViteで処理し、CSSやJavaScriptを出力します。TypeScriptはJavaScriptへ変換します。
  3. HTML内の元ファイルのURLを、出力したファイルのURLへ置き換えます。
プロジェクト構成
src/
├── assets/
│   └── scripts.ts
├── layouts/
│   ├── globals.css
│   └── index.tsx
└── pages/
    └── index.tsx
ビルド結果の例
dist/
├── index.html
└── assets/
    ├── globals-[hash].css
    └── scripts-[hash].js

生成HTMLでは、先ほどのHeadに書いた参照が次のようになります。

dist/index.htmlの抜粋
<link rel="stylesheet" href="/assets/globals-[hash].css" />
<script type="module" src="/assets/scripts-[hash].js"></script>

[hash]はファイルの内容に応じて決まる文字列です。ブラウザは出力されたCSSとJavaScriptを読み込むため、公開先へsrc/をアップロードする必要はありません。実際のファイル名や分割結果は設定と依存関係によって変わり、URLにはViteのbaseが反映されます。

JavaScriptからCSSを読み込む

エントリーからCSSをimportすることもできます。

src/assets/scripts.ts
import "../layouts/globals.css"

document.querySelector("[data-greeting]")?.addEventListener("click", () => {
  window.alert("こんにちは!")
})

この方法ではページのlinkを外します。ビルド時に、このscriptを参照するページへstylesheetが追加されます。別のページでもスタイルを使うなら、そのページや共通レイアウトから読み込んでください。

HTMLから直接参照できる範囲

このガイドのCSSはlinkのhref属性、JavaScript・TypeScriptはscriptのsrc属性から参照します。

処理対象は/から始まり、プロジェクトルート内に実ファイルがある参照です。https://や//で始まる外部URL、./scripts.jsのようなHTML内の相対URLは変更しません。一方、エントリー内のimport "../layouts/globals.css"のような相対パスは、importするファイルを基準にViteが解決します。

画像もimgのsrcやsrcsetなどから直接参照できますが、HTML内のすべてのURL属性が対象になるわけではありません。例えば、OGP用のmetaのcontent属性へ元ファイルのパスを書いても、画像の出力やURLの置き換えは行いません。画像のimportから得たURLか、publicのファイルのURLを指定してください。

画像の読み込みとOGPでの使い分けは画像のバンドル、対象の要素・属性の一覧はpluginSsgのHTMLアセット参照を参照してください。

publicのコードを併用する

既存のCSSやJavaScriptを無加工で使う場合は、public/へ置きます。

<Head>
  <link rel="stylesheet" href="/css/legacy.css" />
  <script src="/js/legacy.js" defer />
</Head>

この例はpublic/css/legacy.cssとpublic/js/legacy.jsを参照します。ソースのエントリーとpublicのファイルは同じページで併用できます。

publicのファイルはバンドルせず、そのまま出力先へコピーします。HTML内の参照URLにはViteのbaseが反映されます。配置方法はpublicを参照してください。

次は画像最適化で、プラグインを追加して画像のサイズと形式を調整します。