Gatsby で記事のトップ画像を設定

2019/07/02

多くのブログでは、記事の先頭にトップ画像を表示しています。ここでは Gatsby でトップ画像を設定し、さらにその画像を記事一覧のサムネイルとしても表示する手法について紹介します。

実装はこちら: https://github.com/suzukalight/suzukalight.github.io/pull/2

gatsby-image

gatsby-image は、Gatsby における画像表示全般を担うコンポーネントで、単なる画像表示だけではなく、下記の特徴があります;

  • Lazy loading 対応。自身が表示領域に入るまでは、画像読み込みを行わない。初期レンダリングが早くなる
  • srcset 対応。表示環境に適した画像サイズの画像を返すことで、ダウンロードサイズを削減する
import Image from 'gatsby-image';

<Image fluid={post.frontmatter.hero.childImageSharp.fluid} />;

hero カラムの追加

トップ画像を指定するカラムを、md ファイルの先頭に追加します。

---
---
hero: title.png
---

画像ファイルは、md と同じディレクトリに格納すれば OK でした。

query の追加と、トップ画像の表示

markdown からトップ画像設定を抽出し、gatsby-image が読み取れる形式に変換します;

export const pageQuery = graphql`
  query BlogPostBySlug($slug: String!) {
    ...
    markdownRemark(fields: { slug: { eq: $slug } }) {
      frontmatter {
        title
        ...
        hero {
          childImageSharp {
            fluid(maxWidth: 1280) {
              ...GatsbyImageSharpFluid
            }
          }
        }
        ...

hero で指定した画像を、 gatsby-plugin-sharp で変換します。 fluid で抽出すると、srcset で使用できるように、画像をいくつかのサイズに拡縮します。

const BlogPostTemplate = ({ location, data, pageContext }) => {
  return (
    ...
    <Image fluid={data.markdownRemark.frontmatter.hero.childImageSharp.fluid} />
    ...
  )
}:

gatsby-image には、fuild で生成された画像群をまとめて指定することができます。これにより Gatsby は表示環境にあわせて、自動的に最適な画像を選択し、表示してくれます。

記事一覧のサムネイルとして表示

基本的な手法は同じですが、fluid のかわりに fixed を指定すると、固定サイズに切り抜いた画像を用意してくれます;

export const pageQuery = graphql`
  query {
    ...
    frontmatter {
      date(formatString: "MMMM DD, YYYY")
      ...
      hero {
        childImageSharp {
          fixed(width: 128, height:128) {
            ...GatsbyImageSharpFixed
          }
        }
      }
    }
  }
`;

より正確に言うと、固定サイズに切り抜いた上で、その x2, x3 の画像もあわせて用意してくれる感じです。そうではなくて、本当に単一のファイルのみを取得したい場合には、resize オプションも用意されているようです

コンポーネント側もだいたい同じです;

<Image fixed={node.frontmatter.hero.childImageSharp.fixed} />

references

Writings

blogsnippetcourse
Home©︎ suzukalight