Skip to content

Latest commit

 

History

History
68 lines (36 loc) · 1.56 KB

ArrayFieldProps.md

File metadata and controls

68 lines (36 loc) · 1.56 KB

@lynxts/coreDocs


@lynxts/core / ArrayFieldProps

Interface: ArrayFieldProps<T, K>

The props of the ArrayField component.

Type Parameters

T extends Struct

struct type of the form values

K extends Path<T, unknown[]>

the path type of the array field

Properties

children()

children: (props) => ReactNode

Parameters

props: UseArrayField<ArrayValue<T, K>>

render props same as the useArrayField hook result

Returns

ReactNode

a React.js node

Defined in

components/ArrayField.component.tsx:42


deps?

optional deps: DependencyList

The children render result is memoized in this component and it will only change if the array field value changes. This prop lets you add an additional dependency list to that memoization, so you can add external state changes when required.

Defined in

components/ArrayField.component.tsx:49


name

name: K

The path to the array field in T.

Defined in

components/ArrayField.component.tsx:53