TailwindCSSでUIライブラリを作る際のハマりどころ

Meguro.css #10 で発表した資料です

Transcript

1. TailwindCSSで UIライブラリを作る際の ハマりどころ 2024/05/10 did0es
2. 自己紹介 did0es(Hirai Shuta) SWE @ CyberAgent, Inc. Main organizer @ Meguro.es X: https://x.com/did0es GH: https://github.com/shuta13
3. 目次 1. 背景 2. ハマりどころ 3. まとめ
4. 背景
5. Webフロントエンドエンジニアが少ない (様々な登壇で言及している話なので耳タコかもですが) 自身の所属している組織はインフラチームです ・フロントエンドエンジニアが2人しかいない ・主にインフラの管理画面を開発する 　・AWSやGCPのコンソールを思い浮かべてください ・2人で進捗を最大化する必要がある
6. Web SDK化計画 開発に必要なものを全てSDKにして配ってしまおう ・必要なSDKをインストールして組み合わせるだけでWebサービスができる ・DIY原則 SDK化しているもの ・UI ・ロジック(React Hooksや共通処理) ・OAS ・Dependencies などなど...
7. Web SDK化計画 開発に必要なものを全てSDKにして配ってしまおう ・必要なSDKをインストールして組み合わせるだけでWebサービスができる ・DIY原則 SDK化しているもの ・UI ・ロジック(React Hooksや共通処理) ・OAS ・Dependencies などなど...
8. UIの共通化 従来は外部のUIライブラリを使用していた ・MUI v5とNextUI v1を使っていた ・アプデがつらすぎる 　・特に NextUI v1 は alpha 版だった 　・UI ライブラリで alpha 版... 上記のライブラリと互換性のあるUIライブラリを作る ・全てのプロジェクトで React を使っているので React 製 ・CSS をゴリゴリ書いても良かったが... 　・プロダクト全体で使う TailwindCSS を流用
9. UIの紹介
10. ハマりどころ
11. Preflightの衝突 TailwindCSSにはPreflightという初期化・正規化機能がある ・modern-normalize を包含したもの TailwindCSSをコンパイルすると1つのCSSファイルになる ・これを使う側で読み込むとStyleが反映される クライアントサイドでこのCSSファイルと TailwindCSS を読み込むと衝突 ・初期化・正規化が2回走り、CSSファイルの内容を上書きする ・詳細度バトルに敗北すると上書きされる
12. Preflightの衝突の解決方法 使う側で Preflight を無効にする https://tailwindcss.com/docs/preflight#disabling-preflight
13. classNameの衝突 こちらも TailwindCSS と UI ライブラリを併せて使うときに発生 ・TailwindCSS を入れた側で theme を extend できなくなる ・正確には UI ライブラリ側にある className しか使えなくなる UI ライブラリを使う側では TailwindCSS のドキュメントから 逸脱したことをやりたくない ・ユーザーはあまりフロントエンドに詳しくない場合もある ・独自 className しか使えない状況は避けたい
14. classNameの衝突の解決方法 UIライブラリ側で prefix を片っ端からつけていく ・手動でやるとぶっ倒れるかもしれないので自動化 ・codemodを書いた(CSSの話から逸れるので省略)
15. まとめ
16. TailwindCSSを使う前に 以下を確認しましょう ・本当に TailwindCSS が必要ですか？ 　・CSS 構文のブラウザサポートを見てみましょう ・className prefix は設定しましたか？ ・Preflight が重複していませんか？ 　・重複しても大丈夫なCSSを書く or 自前の normalize にする そもそも... ・本当にUIライブラリを自作する必要がありますか？ 　・TailwindCSS ベースが良いなら daisyUI などを検討しましょう 　・すいません...
17. ご清聴 ありがとうございました！ ご質問などあれば懇親会でお願いします