カスタマイズ
独自の再利用可能な設定プリセットを作成する。
デフォルトでは、独自の`tailwind.config.js`ファイルに追加する設定は、デフォルト設定とインテリジェントにマージされ、独自の構成はオーバーライドと拡張のセットとして機能します。
`presets`オプションを使用すると、ベースとして使用する異なる設定を指定できるため、複数のプロジェクトで再利用したいカスタマイズのセットを簡単にパッケージ化できます。
/** @type {import('tailwindcss').Config} */
module.exports = {
presets: [
require('@acmecorp/tailwind-base')
],
// ...
}
これは、同じブランドの複数のTailwindプロジェクトを管理するチームにとって非常に役立ちます。カラー、フォント、その他の共通のカスタマイズについて、単一の真実の情報源を持つことができます。
プリセットは通常のTailwind設定オブジェクトであり、`tailwind.config.js`ファイルに追加する設定とまったく同じ形状をしています。
// Example preset
module.exports = {
theme: {
colors: {
blue: {
light: '#85d7ff',
DEFAULT: '#1fb6ff',
dark: '#009eeb',
},
pink: {
light: '#ff7ce5',
DEFAULT: '#ff49db',
dark: '#ff16d1',
},
gray: {
darkest: '#1f2d3d',
dark: '#3c4858',
DEFAULT: '#c0ccda',
light: '#e0e6ed',
lightest: '#f9fafc',
}
},
fontFamily: {
sans: ['Graphik', 'sans-serif'],
},
extend: {
flexGrow: {
2: '2',
3: '3',
},
zIndex: {
60: '60',
70: '70',
80: '80',
90: '90',
100: '100',
},
}
},
plugins: [
require('@tailwindcss/typography'),
require('@tailwindcss/aspect-ratio'),
],
}
ご覧のとおり、プリセットには、テーマのオーバーライドと拡張、プラグインの追加、プレフィックスの設定など、これまで使用してきたすべての設定オプションを含めることができます。設定のマージ方法の詳細については、こちらをご覧ください。
このプリセットが`./my-preset.js`に保存されていると仮定すると、`presets`キーの下にある実際のプロジェクトの`tailwind.config.js`ファイルに追加して使用します。
/** @type {import('tailwindcss').Config} */
module.exports = {
presets: [
require('./my-preset.js')
],
// Customizations specific to this project would go here
theme: {
extend: {
minHeight: {
48: '12rem',
}
}
},
}
デフォルトでは、プリセット自体は、独自の構成と同様に、Tailwindのデフォルト設定を拡張します。デフォルト設定を完全に置き換えるプリセットを作成する場合は、プリセット自体に空の`presets`キーを含めます。
// Example preset
module.exports = {
presets: [],
theme: {
// ...
},
plugins: [
// ...
],
}
詳細については、デフォルト設定の無効化に関する情報をご覧ください。
プロジェクト固有の設定(`tailwind.config.js`ファイルにあるもの)は、デフォルト設定に対してマージされるのと同じ方法でプリセットに対してマージされます。
`tailwind.config.js`の次のオプションは、プリセットに存在する場合、同じオプションを単に置き換えます。
content
darkMode
prefix
important
variantOrder
separator
safelist
残りのオプションは、それぞれオプションに最も適した方法で慎重にマージされ、以下で詳しく説明します。
`theme`オブジェクトは浅くマージされ、`tailwind.config.js`のトップレベルキーは、すべてのプリセットの同じトップレベルキーを置き換えます。この例外は`extend`キーであり、これはすべての設定にわたって収集され、テーマ設定の残りの部分の上に適用されます。
テーマ設定ドキュメントで`theme`オプションの動作方法の詳細をご覧ください。
`presets`配列は設定間でマージされるため、プリセットに独自のプリセットを含めることができ、それにも独自のプリセットを含めることができます。
`plugins`配列は設定間でマージされるため、プリセットがプラグインを登録し、プロジェクトレベルで追加のプラグインを追加することもできます。
つまり、プリセットによって追加されたプラグインを無効にすることはできません。プリセットのプラグインを無効にしたい場合は、プリセットからそのプラグインを削除してプロジェクトごとに含めるか、プリセットを2つのプリセットに分割することを検討する必要があります。
corePlugins
オプションは、オブジェクトとして設定するか、配列として設定するかによって動作が異なります。
corePlugins
をオブジェクトとして設定した場合、設定間でマージされます。
module.exports = {
// ...
corePlugins: {
float: false,
},
}
/** @type {import('tailwindcss').Config} */
module.exports = {
presets: [
require('./my-preset.js'),
],
// This configuration will be merged
corePlugins: {
cursor: false
}
}
corePlugins
を配列として設定した場合、設定済みのプリセットによって提供されるcorePlugins
設定を置き換えます。
module.exports = {
// ...
corePlugins: {
float: false,
},
}
/** @type {import('tailwindcss').Config} */
module.exports = {
presets: [
require('./example-preset.js'),
],
// This will replace the configuration in the preset
corePlugins: ['float', 'padding', 'margin']
}
presets
オプションは配列であり、複数のプリセットを受け入れることができます。これは、再利用可能なカスタマイズを、独立してインポートできる構成可能なチャンクに分割したい場合に便利です。
/** @type {import('tailwindcss').Config} */
module.exports = {
presets: [
require('@acmecorp/tailwind-colors'),
require('@acmecorp/tailwind-fonts'),
require('@acmecorp/tailwind-spacing'),
]
}
複数のプリセットを追加する際には、それらが何らかの形で重複する場合、独自のプリセットに対するカスタマイズと同じ方法で解決され、最後の設定が優先されることに注意することが重要です。
例えば、これらの設定の両方がカスタムカラーパレットを提供する場合(そしてextend
を使用していない場合)、configuration-b
のカラーパレットが使用されます。
/** @type {import('tailwindcss').Config} */
module.exports = {
presets: [
require('@acmecorp/configuration-a'),
require('@acmecorp/configuration-b'),
]
}
デフォルト設定を完全に無効化し、ベース設定なしで開始するには、presets
を空の配列に設定します。
/** @type {import('tailwindcss').Config} */
module.exports = {
presets: [],
// ...
}
これにより、Tailwindのデフォルト設定(色、フォントファミリー、フォントサイズ、スペース値など)はすべて完全に無効化されます。
プリセット内からこれを行うこともできます。プリセットがTailwindのデフォルトを拡張しない独自の完全なデザインシステムを提供する場合に便利です。
module.exports = {
presets: [],
// ...
}
/** @type {import('tailwindcss').Config} */
module.exports = {
presets: [
require('./my-preset.js')
],
// ...
}