diff --git a/components/repeater/readme.md b/components/repeater/readme.md index 949be97c..109c9d0f 100644 --- a/components/repeater/readme.md +++ b/components/repeater/readme.md @@ -11,15 +11,33 @@ A Repeater component that allows you to add repeater fields. The type definition of the attribute needs to be set as an array and the name of the attribute should be passed to the `attribute` prop of the `Repeater` component. +For example, if a repeater item unit is a group field containing a text field and a checkbox field, the attribute would be defined in `block.json` as: + +```json +"attributes": { + "repeaterFieldData": { + "type": "array", + "default": [ + { + "text": "", + "checked": false + } + ], + } +} +``` + +**Note:** You should not provide an `id` to the repeater item unit. The Repeater component will automatically generate an `id` for each item. + ```js import { Repeater } from '@10up/block-components'; export function BlockEdit(props) { const { attributes } = props; - const { items } = attributes; + const { repeaterFieldData } = attributes; return ( - + {( item, index, setItem, removeItem ) => ( <> setItem(value)} />