デジタル庁デザインシステムをReact/Tailwind CSSで実装したサンプル集です。
各コンポーネントの動作やスタイル、使用方法や実装上の注意点等はコードスニペット(React版)Storybookでもご確認いただけます。
- デジタル庁デザインシステムに準拠
- 最小限の依存関係
- カスタマイズ可能
- シンプルな実装
本コードスニペットは以下の技術をベースに実装しています。
- React(v19)
- Tailwind CSS(v3)
- TypeScript
本コードスニペットは、デジタル庁デザインシステムのデザイントークンをベースにしたTailwind CSSのプラグインを使用しています。コードスニペット使用の際は、下記のパッケージをプロジェクトにインストールしてください。
本コードスニペットは React v19 を前提に実装しています。React v18 のプロジェクトに取り込む場合は、以下の修正が必要です。
refを受け取るコンポーネントはforwardRefで包む- 一部の hooks(
useModalDialog、useTab、useTabAria)の戻り値の型RefObject<T | null>をRefObject<T>に変更する
詳しい手順は React v18 で使用する場合 を参照してください。
各コンポーネントの動作やスタイルは、リポジトリをクローンしてローカルで Storybook を起動することでも確認できます。
任意の方法でリポジトリをクローンしてください。
https://github.com/digital-go-jp/design-system-example-components-react
npm installnpm run storybookブラウザで http://localhost:6006 にアクセスすると、すべてのコンポーネントを確認できます。
src/
├── components/ # 各コンポーネント
│ ├── Accordion/
│ ├── Blockquote/
│ └── ...
├── docs/ # ドキュメント
├── tokens/ # デザイントークン
└── index.ts # 全コンポーネントのexport
各コンポーネントディレクトリには以下のファイルが含まれています:
*.tsx- コンポーネント本体*.stories.ts- Storybookストーリーindex.ts- コンポーネントのexport
# Storybookを起動(開発用)
npm run storybook
# Storybookをビルド
npm run storybook:build
# テストを実行
npm test
# コードフォーマット
npm run format本コードスニペットはMITライセンスの下で公開されています。
本コードスニペットに関する不具合や機能要望は、Issueを作成して報告してください。Pull Requestは現時点では受け付けておりません。
デジタル庁デザインシステムのチームメンバーを募集しています。行政のデジタル環境を支える基盤づくりに、あなたのスキルや経験を活かしてみませんか? 求人ページからご応募ください。