Module: Repeater

A Repeater component with id wrapper.

Parameters:

Name Type Description

props

object

Component props.

Properties

Name Type Description

addButtonAttributes

object

Custom attributes for the add button.

addButtonClasses

string | Array | object

Custom classes for the add button.

customAttributes

object

Custom attributes for the component.

customClasses

string | Array | object

Custom classes for the component.

depth

number

The current depth of the repeater.

i18n

object

The i18n object for speak functions and a11y.

Properties

Name	Type	Description
`beginDrag`	object	The message to speak when beginning a drag event (used for a11y).
`deleteLabel`	object	The label for the delete button (used for a11y).
`dragLabel`	object	The label for the drag button (used for a11y).
`endDrag`	object	The message to speak when ending a drag event (used for a11y).
`endDrop`	object	The message to speak when an item is dropped (used for a11y).
`moveItem`	object	The message to speak when moving an item (used for a11y).

id

string

The ID of the repeater.

isDraggable

boolean

Whether the items in this list are draggable.

isSortable

boolean

Whether the items in this list are sortable.

items

Array

The items for the repeater.

maxItems

number

The max number of items to allow.

maxNesting

number

The max number of levels of nesting to allow.

minItems

number

The min number of items to allow.

newItemProps

object

The props to use for new items.

NewItemTemplate

string | function | element

The template to use for new items.

screenReaderTextAttributes

object

Custom attributes for the screen reader.

screenReaderClasses

string | Array | object

Custom classes for the screen reader.

showAdd

boolean

Whether to show the add button.

showArrows

boolean

Whether to show the navigation arrows.

showDragHandle

boolean

Whether to show the drag handle.

showDropZone

boolean

Whether to show the drop zone.

spacing

string | number | Array | object

The spacing for the component, as a string, number, array, or object.

ref

string

The ref to the component.

Since: 4.7.0
Source: modules/Repeater/index.js, line 401

Returns:

The Repeater component.

Type:: JSX.Element

Example

import Repeater from '@gravityforms/components/react/admin/modules/Repeater';

return (
     <Repeater
         items={ [] }
         spacing={ { '': 6, md: 8 } }
     />
);