styled-components の特徴と Next.js のプロジェクトへstyled-componentsを導入するまでの手順

styled-components(スタイルドコンポーネント)
styled-componentsとは?
CSS in JSのライブラリでJSファイルの中にスタイルを記述して利用します。
ReactJSと相性が良くコンポーネント単位でスタイルを記述していくことができます。
公式サイト
styled-componentsを使うメリット
styled-componentsを利用するメリットはたくさんあると感じていますが
私が感じていることを簡潔にまとめています。
コンポーネント管理がしやすい
コンポーネントとスタイルを合わせて管理できるため管理が行いやすいです。
pages/index.tsxconst Title = styled.h1`
color: blue;
font-size: 50px;
`;
const Home = (): ReactElement => {
return <Title>Hello, world!</Title>;
};
このようにコンポーネントのファイルへスタイルを合わせて記述します。
スタイルが閉じられている
コンポーネントのスタイルは同じコンポーネントへしか当たりません。
任意のIDが割り振られ同じコンポーネントのみスタイルが当たるようになあります。
コンパイル後
php-template<style>
.bQcLNl {
color: blue;
font-size: 50px;
}
</style>
<h1 class="pages__Title-sc-16nru3a-0 bQcLNl">Hello, world!</h1>
スタイルの影響を防ぐためにBEPなどの複雑な命名規則を考える必要がありません。
CSSの文法をそのまま利用できる
オブジェクトではなくCSSの文法をそのまま利用できます。
pages/index.tsxconst Title = styled.h1`
color: blue;
font-size: 50px;
`;
それでは早速使っていきます。
環境
- Mac OS Big SUR 11.3.1
- yarn 1.22.10
- Node 14.15.3
- Next.js 10.2.3
- styled-components 5.3
ファイル操作で利用する Unix コマンドについて
基本的なディレクトリ作成やファイル操作は Unix コマンドを利用します。
Unix コマンドについて詳しくはこちらの記事を参考にしてください。
Next.js 環境の構築
前回Next.js
をインストールした環境の状態から変更を加えて行きます。
前回の記事については下記になりますので事前にご確認いただければと思います。
styled-componentsのインストール
styled-componentsのインストール
パッケージのインストール
プロジェクトディレクトリへ移動
前回作成したプロジェクトのディレクトリへ移動します。
terminalcd ~/next-sample
styled-components のインストール
yarn install
コマンドでstyled-components
をインストールします。
terminal$ yarn add styled-components
yarn add v1.22.10
// 中略
✨ Done in 4.67s.
関連パッケージのインストール
yarn install
コマンドでbabel-plugin-styled-components
と@types/styled-components
をインストールします。
terminal$ yarn add -D babel-plugin-styled-components @types/styled-components
yarn add v1.22.10
info No lockfile found.
// 中略
success Saved lockfile.
success Saved 3 new dependencies.
info Direct dependencies
├─ @types/styled-components@5.1.10
└─ babel-plugin-styled-components@1.12.0
info All dependencies
├─ @types/hoist-non-react-statics@3.3.1
├─ @types/styled-components@5.1.10
└─ babel-plugin-styled-components@1.12.0
✨ Done in 4.71s.
@types/styled-components
styled-componentsの型定義ファイルになります。
babel-plugin-styled-components
styled-componentsのデバッグ系の設定を追加したり
SSRで利用できるようにするための設定を拡張するプラグインになります。
インストールしたパッケージの確認
package.json
を開きインストールされたパッケージを確認します。
perl "dependencies": {
"next": "^10.2.3",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"styled-components": "^5.3.0"
},
"devDependencies": {
"@types/node": "^15.12.2",
"@types/react": "^17.0.11",
"@types/styled-components": "^5.1.10",
"babel-plugin-styled-components": "^1.12.0",
"typescript": "^4.3.2"
}
サンプルアプリの変更
前回作成したNext.jsのアプリケーションへ変更を加えていきます。
styled-componentsをNext.jsで使う設定
styled-componentsを利用できるようにするために
pages ディレクトリの直下に_document.tsx
を作成します。
terminal$ vim ~/next-sample/pages/_document.tsx
下記内容を追記します。
_document.tsx
_document.tsximport Document, { DocumentContext } from 'next/document'
import { ServerStyleSheet } from 'styled-components'
export default class MyDocument extends Document {
static async getInitialProps(ctx: DocumentContext) {
const sheet = new ServerStyleSheet()
const originalRenderPage = ctx.renderPage
try {
ctx.renderPage = () =>
originalRenderPage({
enhanceApp: (App) => (props) =>
sheet.collectStyles(<App {...props} />),
})
const initialProps = await Document.getInitialProps(ctx)
return {
...initialProps,
styles: (
<>
{initialProps.styles}
{sheet.getStyleElement()}
</>
),
}
} finally {
sheet.seal()
}
}
}
_document.tsxとは
_document.tsx_はNext.jsで提供されているdocument系の定義をいこなうためのコンポーネントです。ここで定義した内容は通常のpages内のコンポーネントのページへアクセスがあった際にサーバー側のレンダリング時に呼ばれます。
index.tsxの変更
styled-componentsをインポートして
実際に使っていきます。
terminal$ vim ~/next-sample/pages/index.tsx
下記内容を追記します。
index.tsx
index.tsximport React, { ReactElement } from 'react';
import styled from 'styled-components';
const Title = styled.h1`
color: blue;
font-size: 50px;
`;
const Home = (): ReactElement => {
return <Title>Hello, world!</Title>;
};
export default Home;
.babelrcの設定追加
babel
の設定ファイルである.babelrc
を作成し設定内容を追記します。
terminal$ vim ~/next-sample/.babelrc
下記を追記します。
追記する内容
json{
"presets": ["next/babel"],
"plugins": [
[
"styled-components",
{ "ssr": true, "displayName": true }
]
]
}
ssr
サーバーサイドレンダリング時に利用できるようにします。
displayName
コンポーネントが書かれているファイル名をクラス名に出力することができます。
babelとは
JavaScriptのコードを変換するツールです。
次の世代のJavaScriptの標準機能をブラウザのサポートを待たずに使えるようにします。
Next.js アプリの起動
アプリケーションを起動させていきます。
起動コマンドの実行
yarn dev
コマンド実行します。
terminal$ yarn dev
ready - started server on 0.0.0.0:3000, url: http://localhost:3000
// 中略
wait - compiling...
event - compiled successfully
コンソールへsuccessfully
と表示されたらアプリケーション起動は成功です。
ブラウザからアクセス
アプリケーションが起動したのでブラウザからアクセスしてみます。
http:localhost:3000
へアクセスしてみてください。
青い色のHello, world!と表示が確認できます。
- article
Next.js で環境変数を安全に管理するベストプラクティス
- article
shadcn/ui × Next.js:モダンな UI を爆速構築する方法
- article
Next.js の Image コンポーネント徹底攻略:最適化・レスポンシブ・外部 CDN 対応
- article
NextJS で始める Web アプリケーションの多言語・国際化対応の方法
- article
【徹底解説】Next.js での SSG・SSR・ISR の違いと使い分け
- article
shadcn/ui とは?Next.js 開発を加速する最強 UI ライブラリ徹底解説
- article
Storybook × Sass/Styled-Components で美しい UI 量産
- article
styled-components の特徴と Next.js のプロジェクトへstyled-componentsを導入するまでの手順
- article
【実践編】JavaScript の正規表現活用術:効率的に文字列を処理する方法
- article
JavaScript の this キーワードを完全理解!初心者がつまずくポイント解説
- article
【徹底比較】JavaScript での null と undefined の違いと正しい使い分け
- article
JavaScript のクロージャ完全ガイド:スコープとメモリの仕組みを深掘り
- article
【保存版】JavaScript のイベントループとタスクキューを図解で理解する
- article
JavaScript モジュール徹底解説:CommonJS・AMD・ESM の違いと使い分け
- article
Python 標準ライブラリが強い理由:pathlib・itertools・functools 活用レシピ 30 選
- article
Next.js で環境変数を安全に管理するベストプラクティス
- article
Tauri の設定ファイル(tauri.conf.json)完全ガイド
- article
タグ vs フォルダ:Obsidian での最適なノート整理術
- article
Nuxt での画像最適化戦略:nuxt/image と外部 CDN 徹底比較.md
- article
TypeScript による型安全なエラーハンドリング:Result 型と Neverthrow の活用
- blog
Googleストアから訂正案内!Pixel 10ポイント有効期限「1年」表示は誤りだった
- blog
【2025年8月】Googleストア「ストアポイント」は1年表記はミス?2年ルールとの整合性を検証
- blog
Googleストアの注文キャンセルはなぜ起きる?Pixel 10購入前に知るべき注意点
- blog
Pixcel 10シリーズの発表!全モデル Pixcel 9 から進化したポイントを見やすく整理
- blog
フロントエンドエンジニアの成長戦略:コーチングで最速スキルアップする方法
- blog
失敗を称賛する文化はどう作る?アジャイルな組織へ生まれ変わるための第一歩
- review
今の自分に満足していますか?『持たざる者の逆襲 まだ何者でもない君へ』溝口勇児
- review
ついに語られた業界の裏側!『フジテレビの正体』堀江貴文が描くテレビ局の本当の姿
- review
愛する勇気を持てば人生が変わる!『幸せになる勇気』岸見一郎・古賀史健のアドラー実践編で真の幸福を手に入れる
- review
週末を変えれば年収も変わる!『世界の一流は「休日」に何をしているのか』越川慎司の一流週末メソッド
- review
新しい自分に会いに行こう!『自分の変え方』村岡大樹の認知科学コーチングで人生リセット
- review
科学革命から AI 時代へ!『サピエンス全史 下巻』ユヴァル・ノア・ハラリが予見する人類の未来