Lism Tips

はじめに・ステップ 3 / 7

読み込み方(インストール)

Lism CSS を読み込む方法を、CDN の link 1行・npm・create lism のテンプレート・React と Astro・Next.js・UI 部品の順にまとめます。

Lism CSS を使うには、まず CSS ファイルをページに読み込みます。いちばん簡単なのは HTML に1行足す方法です。React・Astro・Next.js で使う方法と、UI 部品の入れ方もこのページにまとめます。

どの方法を選ぶ?#

やりたいこと 方法
ふつうの HTML で試したい CDN の link を1行足す
ゼロから新しく作りたい create lism でひな形を作る
React・Astro の部品も使いたい npm で lism-css を入れる
Next.js で使いたい lism-css を入れる(lism.config.js の反映や型の生成もするなら @lism-css/plugin も入れる)
タブやモーダルなどの部品も使いたい @lism-css/ui を入れる

HTML に1行足す(CDN)#

CDN(ファイルをネットから配ってくれるサービス)の CSS を、HTML の <head> の中で読み込みます。準備はこれだけです。

html
<link href="https://cdn.jsdelivr.net/npm/lism-css@1.0.1/dist/css/main.css" rel="stylesheet" />

lism-css@1.0.1 の部分が版(バージョン)です。CSS ファイルを自分のパソコンに保存して、そのファイルを読み込んでもかまいません。

ページ全体の例は次のとおりです。

html
<!doctype html>
<html lang="ja">
<head>
  <meta charset="utf-8">
  <link href="https://cdn.jsdelivr.net/npm/lism-css@1.0.1/dist/css/main.css" rel="stylesheet" />
</head>
<body>
  <p class="-p:20 -bd">Lism のクラスが効きます</p>
</body>
</html>

ひな形から始める(create lism)#

新しいプロジェクトを最初から作るなら、create lism のコマンドがいちばん早い方法です。どのひな形を使うか、どこに作るかは、コマンドを実行したあとに質問されて選べます。

bash
npm create lism@latest

pnpm・yarn(npm と同じ役目の道具)を使う場合は次のとおりです。

bash
pnpm create lism@latest
bash
yarn create lism

このコマンドは lism-cli create と同じ働きをします。

ひな形を先に指定する#

--template を付けると、質問を飛ばして、使うひな形を直接決められます。

bash
npm create lism@latest -- --template minimal-astro
bash
pnpm create lism@latest --template minimal-astro
bash
yarn create lism --template minimal-astro
補足

npm のときだけ、--template の前に -- が要ります。

選べるひな形#

ひな形 中身
minimal-astro Astro を使った、いちばん小さい形
minimal-vite Vite と React を使った、いちばん小さい形
blog-astro-minimal 記事の一覧・記事・タグだけの小さな Astro のブログ
blog-astro-personal 個人の日記やエッセイ向け。年と月ごとの記事一覧つきの Astro のブログ
blog-astro-techlog 技術ブログ向け。コードの色分け・カテゴリ・タグ・目次・年月の一覧・検索つきの Astro のブログ
lp-astro-corporate 会社のサイト向けの、Astro の1枚もののページ(ランディングページ)
lp-astro-interior インテリアや暮らしのサービス向けの、Astro のランディングページ
lp-astro-ryokan 旅館や宿向けの、Astro のランディングページ

React・Astro で使う(npm)#

React(.tsx)と Astro(.astro)の部品は、npm のパッケージ lism-css に入っています。

1. パッケージを入れる#

bash
npm i lism-css
bash
pnpm add lism-css
bash
yarn add lism-css

2. CSS を読み込む#

js
import 'lism-css/main.css';

Next.js(16 以降)では、App Router の場合、いちばん外側のレイアウトのファイル app/layout.tsx に書きます。

3. 部品を読み込む#

React なら lism-css/react、Astro なら lism-css/astro から読み込みます。

jsx
import { Box, Flex } from 'lism-css/react';
jsx
import { Box, Flex } from 'lism-css/astro';

部品の書き方は Lism コンポーネント(React・Astro) で説明しています。

Next.js で使う#

Next.js では、@lism-css/plugin の withLism() を使います。設定ファイル lism.config.js の中身を反映した CSS を作る・型(TypeScript の入力補完の情報)を作る・CSS の読み込みを差しかえる、をまとめてやってくれます。

補足

対応しているのは Next.js の 16 以降 です。16 が標準で使う Turbopack のほか、next dev --webpack・next build --webpack の webpack でも動きます。

1. パッケージを入れる#

本体の lism-css と、作るとき(ビルド)だけ使う @lism-css/plugin を入れます。

bash
npm i lism-css
npm i -D @lism-css/plugin
bash
pnpm add lism-css
pnpm add -D @lism-css/plugin
bash
yarn add lism-css
yarn add -D @lism-css/plugin

2. next.config.mjs を withLism() で包む#

js
import { withLism } from '@lism-css/plugin/next';

/** @type {import('next').NextConfig} */
const nextConfig = {};

export default withLism(nextConfig);

Next.js は、読み込んだファイルをその場で作りかえることができません。そこで withLism() が、開発やビルドを始める前に、あなたの設定(lism.config.js)を入れた CSS を .lism-css/css/ の中に用意しておきます。コードの中の import 'lism-css/main.css' は、自動でその用意した CSS を指すようになります。すでに書いてある nextConfig の設定は消えません。

3. CSS と部品を読み込む#

CSS は、App Router の場合 app/layout.tsx(いちばん外側のレイアウト)に書きます。部品は lism-css/react から読み込みます。

tsx
import 'lism-css/main.css';
import { Box, Flex } from 'lism-css/react';

4. lism.config.js で変える(しなくてもよい)#

プロジェクトのいちばん上のフォルダに lism.config.js を置くと、トークンや Props を足したり変えたりできます。next dev を動かしたまま保存すれば、CSS と型が作り直されます。開発用のサーバーを止めて立て直す必要はありません。

js
export default {
  tokens: {
    color: {
      // --success を作り、c="success" などで使えるようにする
      success: 'oklch(0.6 0.15 150)',
    },
  },
};

設定できることは lism.config.js で設定する で説明しています。

5. 作られたファイルの扱い#

withLism() は、プロジェクトのいちばん上に lism-env.d.ts を作ります。入力補完を効かせるために、tsconfig.json の include に足し、git にもコミットします。

json
{
  "include": ["next-env.d.ts", "lism-env.d.ts", "**/*.ts", "**/*.tsx"]
}

いっぽう .lism-css/(作られた CSS)はビルドの出力なので、.gitignore に足して git に入れません。

bash
# .gitignore
.lism-css/
補足

使わない CSS を消す機能(CSS Purge)は、Next.js ではまだ使えません(Vite と Astro だけ)。Next.js では、lism.config.js を入れた CSS がまるごと読み込まれます。

UI 部品を入れる(@lism-css/ui)#

アコーディオン・タブ・モーダルなどの UI 部品は、別のパッケージ @lism-css/ui に入っています。

パッケージとして使う#

bash
npm i @lism-css/ui
bash
pnpm add @lism-css/ui

部品は1つずつ、それぞれのパスから読み込みます。

js
// React
import { Accordion } from '@lism-css/ui/react/Accordion';
import { Tabs } from '@lism-css/ui/react/Tabs';

// Astro
import { Accordion } from '@lism-css/ui/astro/Accordion';
import { Tabs } from '@lism-css/ui/astro/Tabs';
補足

@lism-css/ui/react からまとめて読み込むこともできます。ただ、作り方によっては、使っていない部品のプログラムや CSS まで出来上がりに入ってしまうことがあります。公開するものを作るときは、上のように1つずつ読み込むのがおすすめです。

自分のプロジェクトに写す#

lism-cli ui add を使うと、UI 部品のソースコードを自分のプロジェクトに写せます。写したものは自由に書きかえられます。

bash
# 1つ足す(はじめての時は質問に答えて準備する)
npx lism-cli ui add Accordion

# いくつかまとめて足す
npx lism-cli ui add Accordion Modal Tabs NavMenu

# 全部足す
npx lism-cli ui add --all

部品の名前は、読み込むときと同じ書き方(NavMenu のように単語の頭を大文字にする形)がおすすめです。大文字・小文字・-・_ の違いは区別されないので、navmenu や nav-menu と書いても同じ部品になります。

CSS ファイルの種類#

lism-css には、使いみちのちがう CSS ファイルが4つ入っています。ふだんは main.css を使います。

ファイル 中身
lism-css/main.css ふつうの版(@layer あり)
lism-css/main_no_layer.css @layer を使わない版
lism-css/full.css 全部入りの版(@layer あり。CSS Purge と一緒に使う前提)
lism-css/full_no_layer.css 全部入りの、@layer を使わない版

@layer(CSS の強さの順番を決める仕組み)については CSS のレイヤーと強さの順番、それぞれのファイルのちがいは CSS ファイルの種類 で説明しています。

使わない CSS を消す(CSS Purge)#

公開するものを作るときに、使っていない Lism のクラスを取りのぞいて CSS を軽くできます。@lism-css/plugin の Vite・Astro 用のプラグイン lismCss() に purge: true を渡すと有効になります。手順は 使わない CSS を消す(CSS Purge) を見てください。

AI のツールと一緒に使う#

Claude Code・Cursor・Codex などの AI のコーディングツールに、Lism の書き方を教える仕組みもあります。

次に読むページ#

公式ドキュメント

2026年10月5日時点の内容(lism-css 1.0.1・@lism-css/ui 0.40.1)をもとに、やさしい日本語でまとめています。

ページの一覧