Skip to main content

Type Alias: OpenApiFormField

OpenApiFormField = object

Defined in: form/OpenApiForm.tsx:40

A field of OpenApiForm. Give only name to keep the schema-driven label and control; add label, description or render to take over any of them.

Properties​

description?​

optional description?: string

Defined in: form/OpenApiForm.tsx:46

Help text under the label. Defaults to the schema description.


label?​

optional label?: string

Defined in: form/OpenApiForm.tsx:44

Label. Defaults to the schema title, else the humanized name.


name​

name: string

Defined in: form/OpenApiForm.tsx:42

Property of the request body.


render?​

optional render?: (props) => React.ReactNode

Defined in: form/OpenApiForm.tsx:48

Custom control. Receives the value, a change handler and validity.

Parameters​

ParameterType
propsFieldRenderProps

Returns​

React.ReactNode