🍦

Vanilla-Extract と戯れてみた

2022/11/16に公開約9,000字

オハコンバンニチハ。kiiiyoです。

以前から気になっていた CSS in JS ライブラリの vanilla-extract と戯れてみたのでご紹介します。

vanilla-extract とは

公式サイトでは以下のように紹介されています。

Zero-runtime Stylesheets in TypeScript.
Use TypeScript as your preprocessor. Write type‑safe, locally scoped classes, variables and themes, then generate static CSS files at build time.

TypeScript をプリプロセッサとして使用します。タイプセーフで、ローカルにスコープされたクラス、変数、テーマを記述し、ビルド時に静的なCSSファイルを生成します。

2022年11月から Shopify でお仕事されてるみたいです。

https://twitter.com/markdalgleish/status/1589347170737868803

開発環境の設定

各開発環境の設定を紹介してくれています。

ドキュメント上で紹介されているのは以下の6つでした。概ね主要ツールでの利用はできるみたいです。

実行環境の作成

今回は技術検証をかねているので、サクッと環境を構築できる Viteを利用しました。

$ npm create vite@latest

✔ Project name: … app
✔ Select a framework: › React
✔ Select a variant: › TypeScript

Scaffolding project in /<Work Directory>/app...

インストールが完了後、コメントの言われる通り実行します。

cd app
npm install
npm run dev

起動後、以下の画面が表示されると思います。

vanilla-extract with Vite

vanilla-extractでは、Vite環境用のプラグインを用意してくれているのでインストールします。

npm install --save-dev @vanilla-extract/vite-plugin

インストール完了後、Viteの設定ファイルを修正します。

vite.config.js
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'
import { vanillaExtractPlugin } from '@vanilla-extract/vite-plugin';

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [react(), vanillaExtractPlugin()]
})

ミニマムな設定これにて完了です。

スタイルを書き直す

create vite@latestで作成したアプリケーションをvanilla-extractを利用してスタイル適用してみたいと思います。

初期化時のアプリケーションに適用されているcssファイルは以下になります。

  • index.css
  • App.css
index.css
:root {
  font-family: Inter, Avenir, Helvetica, Arial, sans-serif;
  font-size: 16px;
  line-height: 24px;
  font-weight: 400;

  color-scheme: light dark;
  color: rgba(255, 255, 255, 0.87);
  background-color: #242424;

  font-synthesis: none;
  text-rendering: optimizeLegibility;
  -webkit-font-smoothing: antialiased;
  -moz-osx-font-smoothing: grayscale;
  -webkit-text-size-adjust: 100%;
}

a {
  font-weight: 500;
  color: #646cff;
  text-decoration: inherit;
}
a:hover {
  color: #535bf2;
}

body {
  margin: 0;
  display: flex;
  place-items: center;
  min-width: 320px;
  min-height: 100vh;
}

h1 {
  font-size: 3.2em;
  line-height: 1.1;
}

button {
  border-radius: 8px;
  border: 1px solid transparent;
  padding: 0.6em 1.2em;
  font-size: 1em;
  font-weight: 500;
  font-family: inherit;
  background-color: #1a1a1a;
  cursor: pointer;
  transition: border-color 0.25s;
}
button:hover {
  border-color: #646cff;
}
button:focus,
button:focus-visible {
  outline: 4px auto -webkit-focus-ring-color;
}

@media (prefers-color-scheme: light) {
  :root {
    color: #213547;
    background-color: #ffffff;
  }
  a:hover {
    color: #747bff;
  }
  button {
    background-color: #f9f9f9;
  }
}

App.css
#root {
  max-width: 1280px;
  margin: 0 auto;
  padding: 2rem;
  text-align: center;
}

.logo {
  height: 6em;
  padding: 1.5em;
  will-change: filter;
}
.logo:hover {
  filter: drop-shadow(0 0 2em #646cffaa);
}
.logo.react:hover {
  filter: drop-shadow(0 0 2em #61dafbaa);
}

@keyframes logo-spin {
  from {
    transform: rotate(0deg);
  }
  to {
    transform: rotate(360deg);
  }
}

@media (prefers-reduced-motion: no-preference) {
  a:nth-of-type(2) .logo {
    animation: logo-spin infinite 20s linear;
  }
}

.card {
  padding: 2em;
}

.read-the-docs {
  color: #888;
}

vanilla-extract で書いてみる

vanilla-extractでのCSS in JSのファイルフォーマットはxxx.css.tsとのことで従って以下の.tsファイルを作成します。

  • index.css.ts
  • App.css.ts
index.css.ts
import { globalStyle } from '@vanilla-extract/css'

globalStyle(':root', {
  fontFamily: 'Inter, Avenir, Helvetica, Arial, sans-serif',
  lineHeight: '24px',
  fontWeight: 400,
  colorScheme: 'light dark',
  color: 'rgba(255, 255, 255, 0.87)',
  backgroundColor: '#242424',
  fontSynthesis: 'none',
  textRendering: 'optimizeLegibility',
  WebkitFontSmoothing: 'antialiased',
  WebkitTextSizeAdjust: '100%',
  MozOsxFontSmoothing: 'grayscale',
  '@media': {
    '(prefers-color-scheme: light)': {
      color: '#213547',
      backgroundColor: '#ffffff',
    },
  },
})

globalStyle('a', {
  fontWeight: 500,
  color: '#646cff',
  textDecoration: 'inherit',
})

globalStyle('a:hover', {
  color: '#535bf2',
  '@media': {
    '(prefers-color-scheme: light)': {
      color: '#747bff',
    },
  },
})

globalStyle('body', {
  margin: 0,
  display: 'flex',
  placeItems: 'center',
  minWidth: '320px',
  minHeight: '100vh',
})

globalStyle('h1', {
  fontSize: '3.2em',
  lineHeight: 1.1,
})

globalStyle('button', {
  borderRadius: '8px',
  border: '1px solid transparent',
  padding: '0.6em 1.2em',
  fontWeight: 500,
  fontFamily: 'inherit',
  backgroundColor: '#1a1a1a',
  cursor: 'pointer',
  transition: 'border-color 0.25s',
  '@media': {
    '(prefers-color-scheme: light)': {
      backgroundColor: '#f9f9f9',
    },
  },
})

globalStyle('button:hover', {
  borderColor: '#646cff',
})

globalStyle('button:focus, button:focus-visible', {
  outline: '4px auto -webkit-focus-ring-color',
})

App.css.ts
import { keyframes, style, globalStyle } from '@vanilla-extract/css'

globalStyle('#root', {
  maxWidth: 1280,
  margin: '0 auto',
  padding: '2rem',
  textAlign: 'center',
})

export const logo = style({
  height: '6em',
  padding: '1.5em',
  willChange: 'filter',
})

export const logoVite = style([
  logo,
  {
    ':hover': {
      filter: 'drop-shadow(0 0 2em #646cffaa)',
    },
  },
])

const animationLogoSpin = keyframes({
  from: { transform: 'rotate(0deg)' },
  to: { transform: 'rotate(360deg)' },
})

export const logoReact = style([
  logo,
  {
    ':hover': {
      filter: 'drop-shadow(0 0 2em #61dafbaa)',
    },
    '@media': {
      '(prefers-reduced-motion: no-preference)': {
        animationName: animationLogoSpin,
        animationDuration: '20s',
        animationTimingFunction: 'linear',
        animationIterationCount: 'infinite',
      },
    },
  },
])

export const card = style({
  padding: '2em',
})

export const readTheDocs = style({
  color: '#888',
})

書く読み込み先のファイルを修正してスタイル適用してみます。

main.tsx
import React from 'react'
import ReactDOM from 'react-dom/client'
import App from './App'
import './index.css'

ReactDOM.createRoot(document.getElementById('root') as HTMLElement).render(
  <React.StrictMode>
    <App />
  </React.StrictMode>
)

App.tsx はスタイル適用を反映するためclassNameプロパティに該当スタイル適用するよう修正しました。

App.tsx
import { useState } from 'react'
import reactLogo from './assets/react.svg'
import * as styles from './App.css'

function App() {
  const [count, setCount] = useState(0)

  return (
    <div>
      <div>
        <a href="https://vitejs.dev" target="_blank">
          <img src="/vite.svg" className={styles.logoVite} alt="Vite logo" />
        </a>
        <a href="https://reactjs.org" target="_blank">
          <img src={reactLogo} className={styles.logoReact} alt="React logo" />
        </a>
      </div>
      <h1>Vite + React</h1>
      <div className={styles.card}>
        <button onClick={() => setCount((count) => count + 1)}>
          count is {count}
        </button>
        <p>
          Edit <code>src/App.tsx</code> and save to test HMR
        </p>
      </div>
      <p className={styles.readTheDocs}>
        Click on the Vite and React logos to learn more
      </p>
    </div>
  )
}

export default App

起動して確認

大きな差分は無さそうなので、一旦これで戯れは終わりにしたいと思います。

修正前 修正後

所感

実際に書いてみてたり、ドキュメントを参照してみての感想として

  • xxxx.css.tsのファイルフォーマットは自分は嫌いじゃないかも
  • スタイリングする上でミニマムな機能は揃っているので概ね良さそう、theme関連とか
  • スタイル指定時のネスト制限があるのは好き辛いが分かれるかも
  • Thailand css みたいにサクサク実装するものではなく、1から自ら構築していくのでそれなりの設計力が必要かも
  • Zero-runtime の恩恵はもう少し調査してからわかるかも

自分の感想としては好印象なライブラリだったので、まずは個人プロダクトで使ってみて知見をためてみようと覆います。

参考

Discussion

ログインするとコメントできます