diff --git "a/docs/manual/\347\271\260\343\202\212\350\277\224\343\201\227.md" "b/docs/manual/\347\271\260\343\202\212\350\277\224\343\201\227.md" new file mode 100644 index 0000000..6fb82e2 --- /dev/null +++ "b/docs/manual/\347\271\260\343\202\212\350\277\224\343\201\227.md" @@ -0,0 +1,210 @@ +--- +contentId: repeat-field +directory: manual +--- + +# 繰り返し + +繰り返しフィールドはカスタムフィールドを複数選択し、好きな順序で入力を繰り返すことのできるフィールドです。 +入力したデータは配列として返却されるので、フロントエンド側で自由度の高いデザインをすることが可能です。 + +繰り返しフィールドを利用するためには、事前にカスタムフィールドを作成しておく必要があります。 + +カスタムフィールドの作成についてはこちらをご覧ください。 + +https://document.microcms.io/manual/custom-field + +フィールドの設定方法 +========== + +以下のようなカスタムフィールドが作成されている前提で、設定方法をご説明します。 + + + +* **heading(見出し)**:テキストフィールド +* **link(リンク)**:テキストフィールド +* **text(テキスト)**:リッチエディタ +* **image(画像)**:画像 +* **imageText(画像 + テキスト)**:画像 + リッチエディタ +* **relatedLinks(関連記事リンク)**:複数コンテンツ参照 + +次にこれらのカスタムフィールドを使って繰り返しフィールドを設定するために、「API設定」→「APIスキーマ」に移動し、フィールドの「種類」として「繰り返し」を選択します。 + + + +モーダルウィンドウが開き、事前に設定したカスタムフィールドの中でどのカスタムフィールドを利用するか選択できます。利用したいものにチェックを入れ、「決定」をクリックします。 + + + +データの入稿方法 +======== + +次に編集画面での入稿方法をご説明します。 + +フィールドの追加 +-------- + +繰り返しフィールドが設定されていると、次のようなフィールド(繰り返しフィールド(デモ))が用意されています。 + + + +「+フィールドを追加」ボタンをクリックすると、どのカスタムフィールドを使用するか選択するためのポップアップが表示されます。 + + + +ここで「見出し」を選ぶと、見出しとして設定したカスタムフィールド(テキストフィールド)が表示されます。 + + + +また、「フィールドを追加」ボタンを押すと、下にフィールドを追加していくことができます。 + + + +三点リーダーをクリックすると表示されるメニューからは、上下にフィールドを追加できます。 + + + +今度は「画像+テキスト」のフィールドを追加します。 +すると、以下のように「1. 見出し」「2. 画像+テキスト」のフィールドを並べることができます。 + + + +「画像+テキスト」のフィールドは入力フォームが横並びになっていますが、このようなフィールドのレイアウト設定はカスタムフィールド側で行います。設定方法については以下のドキュメントをご覧ください。 + +https://document.microcms.io/manual/custom-field + +フィールドの移動 +-------- + +「=」をドラッグ&ドロップすると、フィールドを上下に移動できます。 + + + +三点リーダーをクリックすると表示されるメニューからも、フィールドを上下に移動できます。 + + + +フィールドの折りたたみ +----------- + +カスタムフィールド名の横にある矢印をクリックすると、フィールドの折りたたみ・展開ができます。 + + + +フィールドの削除 +-------- + +フィールドを削除するには、三点リーダーをクリックしてメニューを表示し「フィールドを削除」をクリックします。 + + + +API、CSVを利用した入稿については以下のドキュメントをご参照ください。 + +https://document.microcms.io/content-api/post-content#had86c3779e + +https://document.microcms.io/manual/csv-import#h2b3036ae9c + +制限事項/注意事項 +========= + +* 繰り返しフィールドで設定できるカスタムフィールド数に上限は設けていません。 +* 繰り返しフィールドで使用しているカスタムフィールドを削除すると、既にそのフィールドを使って登録していたデータは管理画面には表示され続けますが、APIレスポンスからは除外されます。 + +フィールドの詳細設定 +========== + +設定項目 + +説明 + +必須項目 + +設定をONにすると入稿時の入力が必須となります。 + +説明文 + +入稿画面に表示する説明文です。 + +繰り返しフィールド + +繰り返しフィールドに使用するカスタムフィールドを設定します。 + +並び順 + +カスタムフィールドを選択する際の並び順を設定します。 + +繰り返しフィールドの数を制限する + +繰り返しフィールドの最小数と最大数を設定します。 + +APIのレスポンス +========= + +それでは実際に値を入力して、APIからデータを取得してみましょう。確認のため、次のように入力します。 + + + +APIプレビューで実際にプレビューしてみると、次のようなレスポンスが得られます。 + + { + "id": "kkk7km7-ng", + "createdAt": "2023-08-28T06:25:36.825Z", + "updatedAt": "2023-08-28T06:25:36.825Z", + "repeat": [ + { + "fieldId": "heading", + "heading": "見出しです" + }, + { + "fieldId": "imageText", + "image": { + "url": "https://images.microcms-assets.io/assets/xxxxxx/xxxxxx/blog-template.png", + "height": 630, + "width": 1200 + }, + "text": "
カスタムフィールドを複数選択し、好きな順序で入力を繰り返すことができるフィールドです。
" + } + ] + } + + +GET APIの基本的なレスポンス形式については以下のドキュメントをご参照ください。 + +https://document.microcms.io/content-api/get-api-field-responses#hc127980c8b + +フロントエンドでの利用方法 +============= + +配列の要素ごとにコンポーネントを定義(`