<Image>
このAPIリファレンスでは、Imageコンポーネントで利用可能なpropsと設定オプションの使用方法を理解するのに役立ちます。機能と使用方法については、Imageコンポーネントページを参照してください。
import Image from 'next/image'
export default function Page() {
return (
<Image
src="/profile.png"
width={500}
height={500}
alt="著者の写真"
/>
)
}
Props
Imageコンポーネントで利用可能なpropsの概要:
Prop | 例 | タイプ | ステータス |
---|---|---|---|
src | src="/profile.png" | 文字列 | 必須 |
width | width={500} | 整数 (px) | 必須 |
height | height={500} | 整数 (px) | 必須 |
alt | alt="著者の写真" | 文字列 | 必須 |
loader | loader={imageLoader} | 関数 | - |
fill | fill={true} | 真偽値 | - |
sizes | sizes="(max-width: 768px) 100vw, 33vw" | 文字列 | - |
quality | quality={80} | 整数 (1-100) | - |
priority | priority={true} | 真偽値 | - |
placeholder | placeholder="blur" | 文字列 | - |
style | style={{objectFit: "contain"}} | オブジェクト | - |
onLoadingComplete | onLoadingComplete={img => done())} | 関数 | 非推奨 |
onLoad | onLoad={event => done())} | 関数 | - |
onError | onError(event => fail()} | 関数 | - |
loading | loading="lazy" | 文字列 | - |
blurDataURL | blurDataURL="data:image/jpeg..." | 文字列 | - |
overrideSrc | overrideSrc="/seo.png" | 文字列 | - |
必須Props
Imageコンポーネントには以下のプロパティが必要です: src
、width
、height
、alt
。
import Image from 'next/image'
export default function Page() {
return (
<div>
<Image
src="/profile.png"
width={500}
height={500}
alt="著者の写真"
/>
</div>
)
}
src
以下のいずれかである必要があります:
外部URLを使用する場合、next.config.js
のremotePatternsに追加する必要があります。
width
width
プロパティはピクセル単位の_レンダリング_幅を表すため、画像の表示サイズに影響します。
静的インポートされた画像またはfill
プロパティを持つ画像を除き、必須です。
height
height
プロパティはピクセル単位の_レンダリング_高さを表すため、画像の表示サイズに影響します。
静的インポートされた画像またはfill
プロパティを持つ画像を除き、必須です。
alt
alt
プロパティは、スクリーンリーダーや検索エンジン向けに画像を説明するために使用されます。また、画像が無効になっている場合や画像の読み込み中にエラーが発生した場合のフォールバックテキストでもあります。
ページの意味を変えずに画像を置き換えることができるテキストを含める必要があります。画像を補足するためのものではなく、画像の上または下のキャプションですでに提供されている情報を繰り返すべきではありません。
画像が純粋に装飾的であるか、ユーザー向けではない場合、alt
プロパティは空の文字列(alt=""
)にする必要があります。
オプショナルProps
<Image />
コンポーネントは、必須プロパティ以外にも多くの追加プロパティを受け入れます。このセクションでは、Imageコンポーネントの最も一般的に使用されるプロパティについて説明します。より高度なプロパティの詳細については、高度なPropsセクションを参照してください。
loader
画像URLを解決するためのカスタム関数。
loader
は、以下のパラメータを指定して画像のURL文字列を返す関数です:
カスタムローダーを使用する例:
'use client'
import Image from 'next/image'
const imageLoader = ({ src, width, quality }) => {
return `https://example.com/${src}?w=${width}&q=${quality || 75}`
}
export default function Page() {
return (
<Image
loader={imageLoader}
src="me.png"
alt="著者の写真"
width={500}
height={500}
/>
)
}
知っておくと良い:
loader
のような関数を受け入れるpropsを使用するには、提供された関数をシリアライズするためにクライアントコンポーネントを使用する必要があります。
または、next.config.js
のloaderFile設定を使用して、propsを渡さずにアプリケーション内のすべてのnext/image
インスタンスを設定できます。
fill
fill={true} // {true} | {false}
width
とheight
が不明な場合に便利な、親要素を埋めるように画像を配置する真偽値。
親要素にはposition: "relative"
、position: "fixed"
、またはposition: "absolute"
スタイルを割り当てる_必要_があります。
デフォルトでは、img要素には自動的にposition: "absolute"
スタイルが割り当てられます。
画像にスタイルが適用されていない場合、画像はコンテナに合わせて伸縮します。アスペクト比を維持しながらコンテナに合わせてレターボックス表示するには、object-fit: "contain"
を設定することをお勧めします。
または、object-fit: "cover"
を設定すると、画像はアスペクト比を維持しながらコンテナ全体を埋めるように拡大され、必要に応じて切り取られます。これを正しく表示するには、親要素にoverflow: "hidden"
スタイルを割り当てる必要があります。
詳細については、以下も参照してください:
sizes
メディアクエリに似た文字列で、異なるブレークポイントでの画像の幅に関する情報を提供します。sizes
の値は、fill
を使用する画像やレスポンシブサイズになるようにスタイル設定された画像のパフォーマンスに大きく影響します。
sizes
プロパティは、画像パフォーマンスに関連する2つの重要な目的を果たします:
sizes
の値は、ブラウザがnext/image
が自動生成するsrcset
からどのサイズの画像をダウンロードするかを決定するために使用されます。ブラウザが選択する時点では、ページ上の画像のサイズを知らないため、ビューポートと同じサイズまたはそれより大きい画像を選択します。sizes
プロパティを使用すると、画像が実際にはフルスクリーンより小さいことをブラウザに伝えることができます。fill
プロパティを持つ画像にsizes
値を指定しない場合、デフォルト値の100vw
(フルスクリーン幅)が使用されます。sizes
プロパティは、自動生成されるsrcset
値の動作を変更します。sizes
値が存在しない場合、固定サイズの画像(1x/2xなど)に適した小さなsrcset
が生成されます。sizes
が定義されている場合、レスポンシブ画像(640w/750wなど)に適した大きなsrcset
が生成されます。sizes
プロパティに50vw
などのビューポート幅の割合が含まれている場合、srcset
は必要以上に小さな値を含まないようにトリミングされます。
例えば、モバイルデバイスではフル幅、タブレットでは2列レイアウト、デスクトップでは3列レイアウトで表示されることがわかっている場合、次のようなsizesプロパティを含める必要があります:
import Image from 'next/image'
export default function Page() {
return (
<div className="grid-element">
<Image
fill
src="/example.png"
sizes="(max-width: 768px) 100vw, (max-width: 1200px) 50vw, 33vw"
/>
</div>
)
}
このsizes
の例は、パフォーマンス指標に劇的な影響を与える可能性があります。33vw
のsizesがない場合、サーバーから選択される画像は必要な幅の3倍になります。ファイルサイズは幅の2乗に比例するため、sizes
がないとユーザーは必要なサイズの9倍の大きさの画像をダウンロードすることになります。
srcset
とsizes
について詳しく学ぶ:
quality
quality={75} // {number 1-100}
最適化された画像の品質で、1
から100
の整数です。100
が最高品質で、したがって最大ファイルサイズになります。デフォルトは75
です。
next.config.js
でqualities
設定が定義されている場合、quality
プロパティは設定で定義された値のいずれかと一致する必要があります。
知っておくと良い: 元のソース画像がすでに低品質の場合、qualityプロパティを高く設定しすぎると、結果として最適化された画像が元のソース画像よりも大きくなる可能性があります。
priority
priority={false} // {false} | {true}
trueの場合、画像は高優先度と見なされ、プリロードされます。priority
を使用する画像では、遅延読み込みが自動的に無効になります。
Largest Contentful Paint (LCP)要素として検出された画像にはpriority
プロパティを使用する必要があります。異なるビューポートサイズで異なる画像がLCP要素になる可能性があるため、複数の優先度画像を持つことが適切な場合があります。
折りたたみより上に表示される画像にのみ使用してください。デフォルトはfalse
です。
placeholder
placeholder = 'empty' // "empty" | "blur" | "data:image/..."
画像の読み込み中に使用するプレースホルダー。可能な値はblur
、empty
、またはdata:image/...
です。デフォルトはempty
です。
blur
の場合、blurDataURL
プロパティがプレースホルダーとして使用されます。src
が静的インポートからのオブジェクトで、インポートされた画像が.jpg
、.png
、.webp
、または.avif
の場合、blurDataURL
は自動的に入力されます(アニメーション画像と検出された場合を除く)。
動的画像の場合は、blurDataURL
プロパティを提供する必要があります。Plaiceholderなどのソリューションがbase64
生成に役立ちます。
data:image/...
の場合、Data URLが画像の読み込み中のプレースホルダーとして使用されます。
empty
の場合、画像の読み込み中はプレースホルダーがなく、空のスペースのみが表示されます。
デモを試す:
高度なProps
場合によっては、より高度な使用方法が必要になることがあります。<Image />
コンポーネントは、以下の高度なプロパティをオプションで受け入れます。
style
基礎となる画像要素にCSSスタイルを渡すことができます。
const imageStyle = {
borderRadius: '50%',
border: '1px solid #fff',
}
export default function ProfileImage() {
return <Image src="..." style={imageStyle} />
}
必要なwidthとheightのpropsがスタイルと相互作用する可能性があることに注意してください。スタイルを使用して画像の幅を変更する場合は、アスペクト比を維持するために高さもauto
にスタイル設定する必要があります。そうしないと画像が歪む可能性があります。
onLoadingComplete
'use client'
<Image onLoadingComplete={(img) => console.log(img.naturalWidth)} />
警告: Next.js 14以降では非推奨で、代わりに
onLoad
を使用してください。
画像が完全に読み込まれ、プレースホルダーが削除された後に呼び出されるコールバック関数。
コールバック関数は、基礎となる<img>
要素への参照である1つの引数で呼び出されます。
知っておくと良い:
onLoadingComplete
のような関数を受け入れるpropsを使用するには、提供された関数をシリアライズするためにクライアントコンポーネントを使用する必要があります。
onLoad
<Image onLoad={(e) => console.log(e.target.naturalWidth)} />
画像が完全に読み込まれ、プレースホルダーが削除された後に呼び出されるコールバック関数。
コールバック関数は、基礎となる<img>
要素を参照するtarget
を持つEventオブジェクトの1つの引数で呼び出されます。
知っておくと良い:
onLoad
のような関数を受け入れるpropsを使用するには、提供された関数をシリアライズするためにクライアントコンポーネントを使用する必要があります。
onError
<Image onError={(e) => console.error(e.target.id)} />
画像の読み込みに失敗した場合に呼び出されるコールバック関数。
知っておくと良い:
onError
のような関数を受け入れるpropsを使用するには、提供された関数をシリアライズするためにクライアントコンポーネントを使用する必要があります。
loading
推奨事項: このプロパティは高度なユースケース専用です。画像を
eager
で読み込むように変更すると、通常はパフォーマンスが低下します。代わりにpriority
プロパティを使用することを推奨します。このプロパティは画像を積極的にプリロードします。
loading = 'lazy' // {lazy} | {eager}
画像の読み込み動作。デフォルトはlazy
です。
lazy
の場合、ビューポートから計算された距離に達するまで画像の読み込みを遅延させます。
eager
の場合、画像を即座に読み込みます。
loading
属性について詳しく学ぶ。
blurDataURL
src
画像が正常に読み込まれる前にプレースホルダーとして使用されるData URL。placeholder="blur"
と組み合わせた場合のみ有効です。
base64エンコードされた画像である必要があります。拡大されてぼかされるため、非常に小さい画像(10px以下)が推奨されます。大きな画像をプレースホルダーとして含めると、アプリケーションのパフォーマンスが低下する可能性があります。
デモを試す:
また、画像に合わせて単色のData URLを生成することもできます。
unoptimized
unoptimized = {false} // {false} | {true}
trueの場合、ソース画像は品質、サイズ、フォーマットを変更せずにそのまま提供されます。デフォルトはfalse
です。
import Image from 'next/image'
const UnoptimizedImage = (props) => {
return <Image {...props} unoptimized />
}
Next.js 12.3.0以降、このプロパティはnext.config.js
を以下の設定で更新することで全ての画像に適用できます:
module.exports = {
images: {
unoptimized: true,
},
}
overrideSrc
<Image>
コンポーネントにsrc
プロップを提供すると、結果の<img>
に対してsrcset
とsrc
属性が自動的に生成されます。
<Image src="/me.jpg" />
<img
srcset="
/_next/image?url=%2Fme.jpg&w=640&q=75 1x,
/_next/image?url=%2Fme.jpg&w=828&q=75 2x
"
src="/_next/image?url=%2Fme.jpg&w=828&q=75"
/>
場合によっては、src
属性が生成されることが望ましくない場合があり、overrideSrc
プロップを使用して上書きしたいことがあります。
例えば、既存のウェブサイトを<img>
から<Image>
にアップグレードする場合、画像ランキングや再クロールを避けるなどのSEO目的で同じsrc
属性を維持したいことがあります。
<Image src="/me.jpg" overrideSrc="/override.jpg" />
<img
srcset="
/_next/image?url=%2Fme.jpg&w=640&q=75 1x,
/_next/image?url=%2Fme.jpg&w=828&q=75 2x
"
src="/override.jpg"
/>
decoding
ブラウザに対し、他のコンテンツの更新を表示する前に画像のデコードを待つべきかどうかを示すヒント。デフォルトはasync
です。
可能な値は以下の通り:
async
- 画像を非同期にデコードし、完了前に他のコンテンツをレンダリングできるようにします。sync
- 画像を同期的にデコードし、他のコンテンツとアトミックに表示します。auto
- デコードモードに優先順位なし。ブラウザが最適なものを決定します。
decoding
属性について詳しく学ぶ。
その他のプロパティ
<Image />
コンポーネントの他のプロパティは、以下の例外を除いて、基盤となるimg
要素に渡されます:
srcSet
。代わりにデバイスサイズを使用してください。
設定オプション
プロパティに加えて、next.config.js
でImageコンポーネントを設定できます。以下のオプションが利用可能です:
localPatterns
特定のパスのみを最適化し、他の全てのパスをブロックするために、next.config.js
ファイルでlocalPatterns
をオプションで設定できます。
module.exports = {
images: {
localPatterns: [
{
pathname: '/assets/images/**',
search: '',
},
],
},
}
知っておくと良いこと: 上記の例では、
next/image
のsrc
プロパティが/assets/images/
で始まり、クエリ文字列を持たないことを保証します。他のパスを最適化しようとすると400 Bad Requestで応答します。
remotePatterns
悪意のあるユーザーからアプリケーションを保護するため、外部画像を使用するには設定が必要です。これにより、Next.jsの画像最適化APIから提供される外部画像があなたのアカウントからのみであることが保証されます。これらの外部画像は、以下のようにnext.config.js
ファイルのremotePatterns
プロパティで設定できます:
module.exports = {
images: {
remotePatterns: [
{
protocol: 'https',
hostname: 'example.com',
port: '',
pathname: '/account123/**',
search: '',
},
],
},
}
知っておくと良いこと: 上記の例では、
next/image
のsrc
プロパティがhttps://example.com/account123/
で始まり、クエリ文字列を持たないことを保証します。他のプロトコル、ホスト名、ポート、または一致しないパスは400 Bad Requestで応答します。
以下は、hostname
にワイルドカードパターンを使用したnext.config.js
ファイルのremotePatterns
プロパティの例です:
module.exports = {
images: {
remotePatterns: [
{
protocol: 'https',
hostname: '**.example.com',
port: '',
search: '',
},
],
},
}
知っておくと良いこと: 上記の例では、
next/image
のsrc
プロパティがhttps://img1.example.com
またはhttps://me.avatar.example.com
、または任意の数のサブドメインで始まる必要があります。ポートやクエリ文字列を持つことはできません。他のプロトコルや一致しないホスト名は400 Bad Requestで応答します。
ワイルドカードパターンはpathname
とhostname
の両方で使用でき、以下の構文を持ちます:
*
単一のパスセグメントまたはサブドメインに一致**
末尾の任意の数のパスセグメントまたは先頭のサブドメインに一致
**
構文はパターンの途中では機能しません。
知っておくと良いこと:
protocol
、port
、pathname
、またはsearch
を省略すると、ワイルドカード**
が暗黙的に適用されます。これは推奨されません。意図しないURLを最適化する可能性があるためです。
以下は、search
を使用したnext.config.js
ファイルのremotePatterns
プロパティの例です:
module.exports = {
images: {
remotePatterns: [
{
protocol: 'https',
hostname: 'assets.example.com',
search: '?v=1727111025337',
},
],
},
}
知っておくと良いこと: 上記の例では、
next/image
のsrc
プロパティがhttps://assets.example.com
で始まり、正確なクエリ文字列?v=1727111025337
を持つ必要があります。他のプロトコルやクエリ文字列は400 Bad Requestで応答します。
domains
警告: アプリケーションを悪意のあるユーザーから保護するため、Next.js 14以降は厳格な
remotePatterns
を推奨します。domains
は、そのドメインから提供される全てのコンテンツを所有している場合にのみ使用してください。
remotePatterns
と同様に、domains
設定を使用して外部画像の許可されたホスト名のリストを提供できます。
ただし、domains
設定はワイルドカードパターンマッチングをサポートせず、プロトコル、ポート、またはパス名を制限できません。
以下は、next.config.js
ファイルのdomains
プロパティの例です:
module.exports = {
images: {
domains: ['assets.acme.com'],
},
}
loaderFile
Next.js組み込みの画像最適化APIの代わりにクラウドプロバイダーを使用して画像を最適化したい場合、next.config.js
で以下のようにloaderFile
を設定できます:
module.exports = {
images: {
loader: 'custom',
loaderFile: './my/image/loader.js',
},
}
これはNext.jsアプリケーションのルートからの相対パスでファイルを指す必要があります。ファイルは文字列を返すデフォルト関数をエクスポートする必要があります。例えば:
'use client'
export default function myImageLoader({ src, width, quality }) {
return `https://example.com/${src}?w=${width}&q=${quality || 75}`
}
または、loader
プロップを使用してnext/image
の各インスタンスを設定できます。
例:
知っておくと良いこと: 関数を受け入れる画像ローダーファイルのカスタマイズには、提供された関数をシリアライズするためにクライアントコンポーネントを使用する必要があります。
高度な設定
以下の設定は高度なユースケース向けで、通常は必要ありません。以下のプロパティを設定すると、将来の更新でNext.jsのデフォルトに対する変更を上書きします。
deviceSizes
ユーザーの予想されるデバイス幅がわかっている場合、next.config.js
でdeviceSizes
プロパティを使用してデバイス幅のブレークポイントのリストを指定できます。これらの幅は、next/image
コンポーネントがsizes
プロップを使用してユーザーのデバイスに適した画像を提供する際に使用されます。
設定が提供されない場合、以下のデフォルトが使用されます。
module.exports = {
images: {
deviceSizes: [640, 750, 828, 1080, 1200, 1920, 2048, 3840],
},
}
imageSizes
next.config.js
ファイルのimages.imageSizes
プロパティを使用して画像幅のリストを指定できます。これらの幅はデバイスサイズの配列と連結され、画像srcsetを生成するために使用される完全なサイズの配列を形成します。
2つの別々のリストがある理由は、imageSizesはsizes
プロップを提供する画像にのみ使用され、その画像が画面の全幅よりも小さいことを示すためです。したがって、imageSizesのサイズは全てdeviceSizesの最小サイズよりも小さくする必要があります。
設定が提供されない場合、以下のデフォルトが使用されます。
module.exports = {
images: {
imageSizes: [16, 32, 48, 64, 96, 128, 256, 384],
},
}
qualities
デフォルトの画像最適化APIは、1から100までの全ての品質を自動的に許可します。許可される品質を制限したい場合、next.config.js
に設定を追加できます。
module.exports = {
images: {
qualities: [25, 50, 75],
},
}
上記の例では、25、50、75の3つの品質のみが許可されます。quality
プロップがこの配列の値と一致しない場合、画像は400 Bad Requestで失敗します。
formats
デフォルトの画像最適化APIは、リクエストのAccept
ヘッダーを介してブラウザがサポートする画像フォーマットを自動的に検出します。
Accept
ヘッダーが設定されたフォーマットの複数と一致する場合、配列の最初の一致が使用されます。したがって、配列の順序が重要です。一致がない場合(またはソース画像がアニメーションの場合)、画像最適化APIは元の画像のフォーマットにフォールバックします。
設定が提供されない場合、以下のデフォルトが使用されます。
module.exports = {
images: {
formats: ['image/webp'],
},
}
以下の設定でAVIFサポートを有効にできます。
module.exports = {
images: {
formats: ['image/avif', 'image/webp'],
},
}
知っておくと良いこと:
- AVIFは一般的にエンコードに20%長くかかりますが、WebPと比べて20%小さく圧縮されます。つまり、画像が最初にリクエストされたときは通常遅くなり、キャッシュされた後続のリクエストは速くなります。
- Next.jsの前にProxy/CDNを自己ホストしている場合、
Accept
ヘッダーを転送するようにProxyを設定する必要があります。
キャッシュ動作
以下は、デフォルトのローダーのキャッシュアルゴリズムについて説明しています。他の全てのローダーについては、クラウドプロバイダーのドキュメントを参照してください。
画像はリクエスト時に動的に最適化され、<distDir>/cache/images
ディレクトリに保存されます。最適化された画像ファイルは、有効期限に達するまで後続のリクエストに対して提供されます。キャッシュされているが期限切れのファイルに一致するリクエストが行われた場合、期限切れの画像がすぐに提供されます(stale)。その後、バックグラウンドで画像が再び最適化され(再検証)、新しい有効期限日付でキャッシュに保存されます。
画像のキャッシュステータスは、x-nextjs-cache
レスポンスヘッダーの値を読むことで確認できます。可能な値は以下の通り:
MISS
- パスがキャッシュにない(最初の訪問時に最大1回発生)STALE
- パスはキャッシュにあるが再検証時間を超えたため、バックグラウンドで更新されるHIT
- パスはキャッシュにあり、再検証時間を超えていない
有効期限(またはMax Age)は、minimumCacheTTL
設定または上流の画像Cache-Control
ヘッダーのどちらか大きい方によって定義されます。具体的には、Cache-Control
ヘッダーのmax-age
値が使用されます。s-maxage
とmax-age
の両方が見つかった場合、s-maxage
が優先されます。max-age
はCDNやブラウザを含む下流のクライアントにも渡されます。
- 上流の画像に
Cache-Control
ヘッダーがないか、値が非常に低い場合、minimumCacheTTL
を設定してキャッシュ期間を延長できます。 deviceSizes
とimageSizes
を設定して、生成される可能性のある画像の総数を減らせます。- フォーマットを設定して、複数のフォーマットを無効にし、単一の画像フォーマットを優先できます。
minimumCacheTTL
キャッシュされた最適化画像のTime to Live(TTL)を秒単位で設定できます。多くの場合、ファイル内容を自動的にハッシュし、Cache-Control
ヘッダーをimmutable
として画像を永久にキャッシュする静的画像インポートを使用する方が良いです。
module.exports = {
images: {
minimumCacheTTL: 60,
},
}
最適化画像の有効期限(またはMax Age)は、minimumCacheTTL
または上流の画像Cache-Control
ヘッダーのどちらか大きい方によって定義されます。
画像ごとにキャッシュ動作を変更する必要がある場合、headers
を設定して上流の画像(例:/_next/image
自体ではなく/some-asset.jpg
)にCache-Control
ヘッダーを設定できます。
現時点でキャッシュを無効化するメカニズムはないため、minimumCacheTTL
を低く保つことが最善です。そうでない場合、手動でsrc
プロップを変更するか、<distDir>/cache/images
を削除する必要があります。
disableStaticImages
デフォルトの動作では、import icon from './icon.png'
のような静的ファイルをインポートし、それをsrc
プロパティに渡すことができます。
場合によっては、この機能がインポートの動作が異なることを期待する他のプラグインと競合するため、無効にしたいことがあります。
next.config.js
内で静的画像インポートを無効にできます:
module.exports = {
images: {
disableStaticImages: true,
},
}
dangerouslyAllowSVG
デフォルトのローダーは、いくつかの理由でSVG画像を最適化しません。第一に、SVGはベクター形式であり、ロスレスでサイズ変更が可能です。第二に、SVGにはHTML/CSSと同様の機能が多く含まれており、適切なContent Security Policy (CSP) ヘッダーがない場合、脆弱性につながる可能性があります。
そのため、src
プロパティがSVGであることがわかっている場合は、unoptimized
プロパティを使用することを推奨します。これはsrc
が".svg"
で終わる場合に自動的に行われます。
ただし、デフォルトの画像最適化APIでSVG画像を提供する必要がある場合は、next.config.js
内でdangerouslyAllowSVG
を設定できます:
module.exports = {
images: {
dangerouslyAllowSVG: true,
contentDispositionType: 'attachment',
contentSecurityPolicy: "default-src 'self'; script-src 'none'; sandbox;",
},
}
さらに、画像に埋め込まれたスクリプトの実行を防ぐために、contentDispositionType
を設定してブラウザに画像をダウンロードさせること、およびcontentSecurityPolicy
を設定することを強く推奨します。
アニメーション画像
デフォルトのローダーは、アニメーション画像に対して自動的に画像最適化をバイパスし、画像をそのまま提供します。
アニメーションファイルの自動検出はベストエフォートで行われ、GIF、APNG、WebPをサポートしています。特定のアニメーション画像に対して明示的に画像最適化をバイパスしたい場合は、unoptimizedプロパティを使用してください。
レスポンシブ画像
デフォルトで生成されるsrcset
には、異なるデバイスのピクセル密度をサポートするために1x
と2x
の画像が含まれています。ただし、ビューポートに合わせて伸縮するレスポンシブ画像をレンダリングしたい場合があります。その場合は、sizes
とstyle
(またはclassName
)を設定する必要があります。
以下のいずれかの方法を使用してレスポンシブ画像をレンダリングできます。
静的インポートを使用したレスポンシブ画像
ソース画像が動的でない場合は、静的インポートを使用してレスポンシブ画像を作成できます:
import Image from 'next/image'
import me from '../photos/me.jpg'
export default function Author() {
return (
<Image
src={me}
alt="著者の写真"
sizes="100vw"
style={{
width: '100%',
height: 'auto',
}}
/>
)
}
試してみる:
アスペクト比を指定したレスポンシブ画像
ソース画像が動的またはリモートURLの場合は、レスポンシブ画像の正しいアスペクト比を設定するためにwidth
とheight
も指定する必要があります:
import Image from 'next/image'
export default function Page({ photoUrl }) {
return (
<Image
src={photoUrl}
alt="著者の写真"
sizes="100vw"
style={{
width: '100%',
height: 'auto',
}}
width={500}
height={300}
/>
)
}
試してみる:
fill
を使用したレスポンシブ画像
アスペクト比がわからない場合は、fill
プロパティを設定し、親要素にposition: relative
を設定する必要があります。オプションで、目的の伸縮またはクロップ動作に応じてobject-fit
スタイルを設定できます:
import Image from 'next/image'
export default function Page({ photoUrl }) {
return (
<div style={{ position: 'relative', width: '300px', height: '500px' }}>
<Image
src={photoUrl}
alt="著者の写真"
sizes="300px"
fill
style={{
objectFit: 'contain',
}}
/>
</div>
)
}
試してみる:
テーマ検出CSS
ライトモードとダークモードで異なる画像を表示したい場合は、2つの<Image>
コンポーネントをラップし、CSSメディアクエリに基づいて正しい方を表示する新しいコンポーネントを作成できます。
.imgDark {
display: none;
}
@media (prefers-color-scheme: dark) {
.imgLight {
display: none;
}
.imgDark {
display: unset;
}
}
import styles from './theme-image.module.css'
import Image, { ImageProps } from 'next/image'
type Props = Omit<ImageProps, 'src' | 'priority' | 'loading'> & {
srcLight: string
srcDark: string
}
const ThemeImage = (props: Props) => {
const { srcLight, srcDark, ...rest } = props
return (
<>
<Image {...rest} src={srcLight} className={styles.imgLight} />
<Image {...rest} src={srcDark} className={styles.imgDark} />
</>
)
}
import styles from './theme-image.module.css'
import Image from 'next/image'
const ThemeImage = (props) => {
const { srcLight, srcDark, ...rest } = props
return (
<>
<Image {...rest} src={srcLight} className={styles.imgLight} />
<Image {...rest} src={srcDark} className={styles.imgDark} />
</>
)
}
知っておくと良いこと:
loading="lazy"
のデフォルトの動作により、正しい画像のみがロードされます。priority
やloading="eager"
は使用できません。これらは両方の画像をロードしてしまうためです。代わりにfetchPriority="high"
を使用できます。
試してみる:
getImageProps
より高度なユースケースでは、getImageProps()
を呼び出して基礎となる<img>
要素に渡されるプロパティを取得し、それらを別のコンポーネント、スタイル、キャンバスなどに渡すことができます。
これはReactのuseState()
を呼び出さないため、パフォーマンスの向上につながる可能性がありますが、placeholder
プロパティと一緒に使用することはできません。プレースホルダーが削除されないためです。
テーマ検出Picture
ライトモードとダークモードで異なる画像を表示したい場合は、<picture>
要素を使用して、ユーザーのpreferred color schemeに基づいて異なる画像を表示できます。
import { getImageProps } from 'next/image'
export default function Page() {
const common = { alt: 'テーマ例', width: 800, height: 400 }
const {
props: { srcSet: dark },
} = getImageProps({ ...common, src: '/dark.png' })
const {
props: { srcSet: light, ...rest },
} = getImageProps({ ...common, src: '/light.png' })
return (
<picture>
<source media="(prefers-color-scheme: dark)" srcSet={dark} />
<source media="(prefers-color-scheme: light)" srcSet={light} />
<img {...rest} />
</picture>
)
}
アートディレクション
モバイルとデスクトップで異なる画像を表示したい場合(アートディレクションと呼ばれることもあります)、getImageProps()
に異なるsrc
、width
、height
、quality
プロパティを提供できます。
import { getImageProps } from 'next/image'
export default function Home() {
const common = { alt: 'アートディレクション例', sizes: '100vw' }
const {
props: { srcSet: desktop },
} = getImageProps({
...common,
width: 1440,
height: 875,
quality: 80,
src: '/desktop.jpg',
})
const {
props: { srcSet: mobile, ...rest },
} = getImageProps({
...common,
width: 750,
height: 1334,
quality: 70,
src: '/mobile.jpg',
})
return (
<picture>
<source media="(min-width: 1000px)" srcSet={desktop} />
<source media="(min-width: 500px)" srcSet={mobile} />
<img {...rest} style={{ width: '100%', height: 'auto' }} />
</picture>
)
}
背景CSS
srcSet
文字列をimage-set()
CSS関数に変換して、背景画像を最適化することもできます。
import { getImageProps } from 'next/image'
function getBackgroundImage(srcSet = '') {
const imageSet = srcSet
.split(', ')
.map((str) => {
const [url, dpi] = str.split(' ')
return `url("${url}") ${dpi}`
})
.join(', ')
return `image-set(${imageSet})`
}
export default function Home() {
const {
props: { srcSet },
} = getImageProps({ alt: '', width: 128, height: 128, src: '/img.png' })
const backgroundImage = getBackgroundImage(srcSet)
const style = { height: '100vh', width: '100vw', backgroundImage }
return (
<main style={style}>
<h1>Hello World</h1>
</main>
)
}
既知のブラウザバグ
このnext/image
コンポーネントはブラウザネイティブの遅延読み込みを使用しており、Safari 15.4以前の古いブラウザでは積極的読み込みにフォールバックする可能性があります。ブラーアッププレースホルダーを使用する場合、Safari 12以前の古いブラウザでは空のプレースホルダーにフォールバックします。width
/height
にauto
を使用したスタイルを使用する場合、Safari 15以前のアスペクト比を保持しない古いブラウザでレイアウトシフトを引き起こす可能性があります。詳細については、このMDNビデオを参照してください。
- Safari 15 - 16.3は読み込み中に灰色の境界線を表示します。Safari 16.4でこの問題は修正されました。可能な解決策:
- CSS
@supports (font: -apple-system-body) and (-webkit-appearance: none) { img[loading="lazy"] { clip-path: inset(0.6px) } }
を使用 - 画像が折り返し線より上にある場合は
priority
を使用
- CSS
- Firefox 67+は読み込み中に白い背景を表示します。可能な解決策:
- AVIF
formats
を有効化 placeholder
を使用
- AVIF
バージョン履歴
バージョン | 変更内容 |
---|---|
v14.2.23 | qualities 設定を追加 |
v14.2.15 | decoding プロパティを追加、localPatterns 設定を追加 |
v14.2.14 | remotePatterns.search プロパティを追加 |
v14.2.0 | overrideSrc プロパティを追加 |
v14.1.0 | getImageProps() が安定版に |
v14.0.0 | onLoadingComplete プロパティと domains 設定を非推奨化 |
v13.4.14 | placeholder プロパティで data:/image... をサポート |
v13.2.0 | contentDispositionType 設定を追加 |
v13.0.6 | ref プロパティを追加 |
v13.0.0 | next/image インポートが next/legacy/image に名称変更。next/future/image インポートが next/image に名称変更。コードモッド が利用可能で、安全に自動的にインポート名を変更できます。<span> ラッパーを削除。layout 、objectFit 、objectPosition 、lazyBoundary 、lazyRoot プロパティを削除。alt が必須に。onLoadingComplete が img 要素への参照を受け取るよう変更。ビルトインローダー設定を削除。 |
v12.3.0 | remotePatterns と unoptimized 設定が安定版に |
v12.2.0 | 試験的 remotePatterns と試験的 unoptimized 設定を追加。layout="raw" を削除 |
v12.1.1 | style プロパティを追加。試験的に layout="raw" をサポート |
v12.1.0 | dangerouslyAllowSVG と contentSecurityPolicy 設定を追加 |
v12.0.9 | lazyRoot プロパティを追加 |
v12.0.0 | formats 設定を追加。AVIF サポートを追加。 ラッパー <div> を <span> に変更 |
v11.1.0 | onLoadingComplete と lazyBoundary プロパティを追加 |
v11.0.0 | src プロパティで静的インポートをサポート。placeholder プロパティを追加。blurDataURL プロパティを追加 |
v10.0.5 | loader プロパティを追加 |
v10.0.1 | layout プロパティを追加 |
v10.0.0 | next/image を導入 |