PortableText 部品で本文を表示する

管理画面で書いた本文を段落や見出しとして表示する方法と、本文が空の場合に渡す値を確認できます。

目次

管理画面で書いた本文を表示するには、emdash/ui の PortableText に本文欄の値を渡します。「ここは見出し」「ここは普通の段落」といった情報を部品が読み、対応するHTMLを出してくれます。

部品に渡すもの

指定値の例使う場面
valuepost.data.content ?? []段落・見出しなどを並べた本文の配列。未入力なら空の配列を渡す
components(省略可)独自ブロックの種類に対応する表示部品の設定自分で追加した本文部品の表示を変えたいとき。標準の段落を出すだけなら value で足ります

記事の本文を1件表示する

「週末ノート」を準備する手順を終えると、本文が1段落入った記事 note-01 で試せます。

練習サイトの src/pages/body-sample.astro に書き、/body-sample/ を開きます。タイトルは文字列なので h1 へ、本文は構造を持つ配列なので PortableText へ渡します。

---
import { getEmDashEntry } from 'emdash';
import { PortableText } from 'emdash/ui';

const { entry: post, error } = await getEmDashEntry('posts', 'note-01');
if (error) return new Response('記事を取得できませんでした。', { status: 500 });
if (!post) return new Response('記事が見つかりません。', { status: 404 });
---
<article>
  <h1>{post.data.title}</h1>
  <PortableText value={post.data.content ?? []} />
</article>

入力した段落がどう見えるか

練習サイトの本文には「近所を歩いて、新しい景色を見つけました。」という段落が1つあります。取得した値の中では style が normal で、children に文字が入っています。公開ページでは、その一文が1つの p 要素になりました。

本文が空のとき、value={[]} からは段落が出ません。「本文を準備しています」と案内したい場合は、post.data.content?.length で段落などの数を確かめて、0件や未設定のときに案内を出します。

本文欄の識別名はサイトによって変わります。content と書いても何も出ないときは、記事のフィールドとコードの対応表を見ながら、自分のサイトの識別名を確かめてください。

公式の参照元

関連ガイド

メニュー
ホーム公式ドキュメント (別タブで開く)

キーワードを入力すると、ガイドの内容から探せます。