インラインスタイルと Tailwind CSS と Tailwind CSS 入力補助ライブラリと Tailwind CSS in JS

2021/03/25
このエントリーをはてなブックマークに追加

この記事では Tailwind CSS 自体の紹介はしません。公式ページを参照してください。
https://tailwindcss.com/

Tailwind CSS とインラインスタイル

Tailwind CSS 関連の記事を目にする機会が増えました。私もプロダクトに導入してしばらく使っていますが、 CSS in JS だと 10 行だったスタイルが 1 行にまとまり、コードの見通しが非常に良くなりました。多くの方には受け入れられている印象ですが、中には「なにそれインラインスタイルと同じじゃんダメじゃん」みたいな反応も見られます。まずはこれに反論しておきたいです。


Linaria (CSS in JS) から Tailwind CSS へ

インラインスタイルの問題点

そもそもインラインスタイルにはどんな問題があるでしょう?

  1. Content-Security-Policy: style-src 'unsafe-inline';
  2. 擬似クラス(:focus, :first-child など)、擬似要素(::before, ::placeholder など)、メディアクエリ(@media)などが使えない
  3. 詳細度が無条件に高い
  4. 1 行にまとめると長く読みづらくなりがち
  5. デザインシステムから逸脱しやすい
  6. 「DRY 原則」違反: あちこちで同じ記述をすることになりやすい
  7. 「関心の分離」違反: マークアップ(構造)とスタイルが分離されない

Tailwind CSS は 1., 2., 3. を解決、 4., 5. を軽減してくれます。 6. は HTML 内では問題になりますが、スクリプト内ではスタイルのまとまりを変数に格納して使いまわせば問題になりません。実際にはスタイルを React などのコンポーネントに閉じ込めてしまって、使いまわすのはコンポーネント、ということが多いと思いますが。

特筆しておきたいのは 7. です。 HTML 構造とそのスタイルは、同じ目的(たとえば「ここに検索窓を置きたい」)のために一緒に作られて、要件が変われば同時に変更される可能性が高い、同じ関心事のまとまりです。 CSS だけでは見た目が調整しきれず <div> を追加することもあるでしょう。 display: grid を使って HTML のネストを浅くすることもあるでしょう。 HTML と CSS は切っても切れません。分離すべきは「あるコンポーネントの関心事と他のコンポーネントの関心事」であって、「あるコンポーネント内の HTML とスタイル」ではありません。

インラインスタイルのメリット

さて、インラインスタイルにメリットはあるでしょうか?

  1. スタイル変更の影響範囲が極小
  2. クラスの命名に悩まない
  3. マークアップの構造とスタイルを一緒に読める

カオスな CSS に出会ったことがある方なら 1. がどれほど大きなメリットかご理解いただけると思います。また、クラスの命名は日常のストレスであり、 1 度つけた名前を後から変えたくなることも多く、 2. も意外に重要です。 3. はインラインの意味そのものであり分かりやすいメリットですが、あえて例を出すなら、たとえばマージンや flex: auto など親子兄弟関係に影響のあるスタイルプロパティは構造と合わせて把握する必要があり、 CSS が別ファイルだと非常にメンテナンスしづらいことが分かると思います。

これらのメリットは Tailwind CSS でももちろん享受できます。

Tailwind CSS のスタイル制約

インラインスタイルとは異なり、 Tailwind CSS (2.0) はスタイルに制約を与えます。サイズや余白、色として指定できる値は限られており、候補値から選ぶことで視覚的に一貫した UI が構築しやすくなります。

この制約はデザインシステムとして働く重要な機能である一方、既存プロジェクトへの Tailwind CSS 導入には妨げになる可能性があります。既存プロジェクトで Tailwind CSS にないプロパティ値を多用していた場合、 Tailwind CSS に合わせてスタイルを変更するか、 tailwind.config.js で候補値を追加するか、 Tailwind CSS を使わずにスタイリングする必要が出てきます。

制約に縛られることなく Tailwind CSS の他のメリットを享受したい場合には、 Windi CSS という選択肢があります。

Windi CSS

Windi CSS は Tailwind CSS 2.0 互換の CSS フレームワークです。さらに "p-0.8" のような半端な値や "p-3px" "p-0.75em" のような単位付きの値、 "bg-hex-00ccff" のような具体的な色指定、さらには CSS カスタムプロパティの利用と、自由度の高い記述ができます。

そして Tailwind CSS 2.0 の Purge と比較すると爆速です。

Windi CSS の詳細については中の人の記事を参照してください。

Windi CSS 導入してみたよ

設定ファイルを作るでもなく、 windicss --init みたいなこともせず、単に windicss コマンドを実行すれば CSS が吐かれます。簡単。

$ npm i -D windicss
$ npx windicss 'src/**/*.(html|ts|tsx)' -o dist/utilities.css

VS Code 向け拡張機能 でコード補完も効きます。各種ビルドツール向けプラグインも用意されているのでビルド環境に合わせてご利用ください。

tailwindcss-jit

Tailwind CSS に倣って Windi CSS が作られたわけですが、今度は Tailwind CSS 側が Windi CSS に倣って tailwindcss-jit なるツールを作っています。

機能的には Windi CSS とほぼ同じかと思います。 Tailwind CSS の候補値以外の指定に "p-[3px]" のような [] 付き書式を用いる点が異なります。あとは PostCSS のプラグインとして動作する点も異なりますね(Windi CSS は単体で動作します)。

(Windi CSS のパクり感が強く、本家という安心感があることで Windi CSS が勝負しづらそうなのが気になりますが… 競って高め合ってもらえるならありがたいです。)


4/7 追記

Tailwind CSS v2.1 がリリースされ、早速 JIT 機能が本体に(プレビューとして)取り込まれました。上記リポジトリはすでにアーカイブされています。


Tailwind CSS 入力補助ライブラリ

ここからは Tailwind CSS の関連ツールを紹介します。

tailwindcss-classnames

tailwindcss-classnames

import classnames from 'tailwindcss-classnames';
const className = classnames('border-none', 'rounded-sm', { ['bg-gray-200']: true });

tailwindcss-classnames は classnames の引数の型を TypeScript のリテラル型で宣言したライブラリです。 Tailwind CSS で利用できないクラス名が使われていればトランスパイルエラーにしてくれます。便利。

そのままだとクラス名の結合は実行時になりますが、ビルド時に結合してしまいたければ babel-plugin-optimize-clsx が使えます(使えました)。

Typed Tailwind

import { Tw } from "./tw";
const Foo = () => (
<p className={Tw().textBlue().fontBold().$()}>
Bold, blue text
</p>
);

Typed Tailwind はビルダーパターンで Tailwind CSS クラス名を生成するための TypeScript のクラスです。 TypeScript の型が付いており誤りを検出できます。 npm からインストールするのではなく、 https://typed.tw/ に自分の tailwind.config.js の中身を貼り付けて出てきたソースコードをコピペして使うみたいです。私は使いません。

Tailwind CSS in JS (TS)

Tailwind CSS を便利に使うべく、 JavaScript の世界に Tailwind CSS を持ち込もうとする動きがあります。

twind

import { tw } from 'twind'
const className = tw`h-screen bg-purple-400 flex items-center justify-center`

twind は実行時にタグ付きテンプレートリテラルで使われたクラス名から <style> 要素を生成するライブラリです。 SSR にも対応しています。
クラス名の記法は Tailwind CSS から拡張されており、 tw`sm:(border(2 black opacity-50 hover:dashed))` のような例を見ると DSL 感強めな印象です。

ソースコードを静的解析して CSS ファイルを吐くような仕組みはないようです。 README にはビルド時に prepass してランタイムを取り除けるっぽい記述がありますが、やり方は見つけられませんでした。できるとしても twind の仕組み的に tw`` を呼んでまわる形で、カバレッジが試されることになるんじゃないかと想像します(間違っていたらごめんなさい)。そもそも twind はビルド不要で動的にスタイルを生成できることに価値を置いているようですので、ビルドにこだわるなら twind が解決したいところとは課題が違うとも思います。

twin.macro

import tw from 'twin.macro'
const css = tw`text-sm md:text-lg`
const Input = tw.input`border hover:border-black`
const interactionStyles = () => (
<div tw="hover:(text-black underline) focus:(text-blue-500 underline)" />
)

import _styled from "@emotion/styled";
const css = {
"fontSize": "0.875rem",
"lineHeight": "1.25rem",
"@media (min-width: 768px)": {
"fontSize": "1.125rem",
"lineHeight": "1.75rem"
}
};
const Input = _styled.input({
"borderWidth": "1px",
":hover": {
"--tw-border-opacity": "1",
"borderColor": "rgba(0, 0, 0, var(--tw-border-opacity))"
}
});
const interactionStyles = () => /*#__PURE__*/React.createElement("div", {
css: {
":hover": {
"--tw-text-opacity": "1",
"color": "rgba(0, 0, 0, var(--tw-text-opacity))",
"textDecoration": "underline"
},
":focus": {
"--tw-text-opacity": "1",
"color": "rgba(59, 130, 246, var(--tw-text-opacity))",
"textDecoration": "underline"
}
}
});

twin.macro は Babel のマクロ(babel-plugin-macros)です。タグ付きテンプレートリテラルをオブジェクト形式のスタイルに変換したり、 styled-components にしたり、 JSX の tw 属性に渡したクラス名から css 属性に渡すオブジェクトに変換したりと、他の CSS in JS ライブラリと組み合わせて利用する前提になっています。

xwind

import xw from "xwind";
// または
// import xw from 'xwind/lib/macro';
const bg = "bg-red-100";
const className1 = xw`text-green-200 ${bg}`;
const className2 = xw("text-green-200", bg);

xwind は Babel のプラグインまたはマクロとしてビルド時に動作します。タグ付きテンプレートリテラルまたは関数呼び出しで Tailwind CSS のクラスを記述しますが、特徴的なのは出力形式を選べることです。 twin.macro のようにオブジェクト形式に変換して CSS in JS で利用したり、 CSS 文字列に変換して別の CSS in JS で利用したり、あるいは(ほぼ)そのまま Tailwind CSS 2.0 互換のクラス名で出力しつつ外部 CSS を吐き出すこともできます(ほぼ、と書いたのは若干の拡張構文があるからで、拡張構文分は Tailwind CSS 2.0 互換クラス名に変換されます)。また、静的に解決できる式は解決してくれます。

twstyled

export const HeroHeading = (props) => (
<h1
tw="font-semibold text-3xl md:text-4xl lg:text-5xl not-italic"
{...props}
/>
)

or

export const HeroHeading = (props) => (
<h1 font-semibold- text-3xl- md--={['text-4xl']} lg--={['text-5xl']} not-italic->
{...props}
/>
)

twstyled は Babel のプリセットとして提供されており、 JSX を拡張して tw 属性や Tailwind CSS のクラス名に該当する属性を記述できるようにしてくれるようです。
非常に興味深いのですが、私はうまく動かせませんでした(@twstyled/babel-preset@3.2.4 時点)。まず README に npm install --save twstyled @twstyled/babel-preset と書いてありますが npm に twstyled というパッケージがありません。 package.json の resolutions フィールドでパッケージを読み替えるような指示もあり(この時点でかなり嫌悪感ある)、 npm + npm-force-resolutions で試したのですが、もしかしたら yarn 前提かもしれません(yarn では試してません)。

おわりに

あるプロダクトで、開始当初は Linaria でスタイルを構築して、途中から Tailwind CSS を導入しました。可能なら Linaria への依存をなくしてビルドプロセスを減らしたいと思っていたのですが、どうしても Tailwind CSS の制約により一部 Linaria なコードが残っていました。これから Windi CSS を導入して Linaria 依存を断ち切ろうと画策しています。

新規プロダクトならむしろスタイルに制約を課したくなりますが、 Windi CSS や tailwindcss-jit ではかなり自由に記述できるようになったので、 tailwindcss-classnames などで縛るのもアリかなと思います。

Tailwind CSS in JS なツールをいくつか紹介しましたが、 tailwindcss-jit の登場でスタイル制約が取り払われることにより、またこれから情勢が変わるんじゃないかと想像します。

私は Awesome Tailwind CSS を全部なめたわけではないので、他にもおもしろいツールがあるかもしれません。

null でした。

その他の記事

Other Articles

2022/06/03
拡張子に Web アプリを関連付ける File Handling API の使い方

2022/03/22
<selectmenu> タグできる子; <select> に代わるカスタマイズ可能なドロップダウンリスト

2022/03/02
Java 15 のテキストブロックを横目に C# 11 の生文字列リテラルを眺めて ECMAScript String dedent プロポーザルを想う

2021/10/13
Angularによる開発をできるだけ型安全にするためのKabukuでの取り組み

2021/09/30
さようなら、Node.js

→
←

関連職種

Recruit

→
←

お客様のご要望に「Kabuku」はお応えいたします。
ぜひお気軽にご相談ください。

お電話でも受け付けております
03-6380-2750
営業時間:09:30~18:00
※土日祝は除く