Interface: FormViewerProps

@react-form-builder/viewer.FormViewerProps

Form viewer React component properties.

Hierarchy

• StoreProps

  ↳ FormViewerProps

Properties

actions

• Optional actions: ActionDefinition[]

External actions for the form viewer.

Inherited from

StoreProps.actions

---

componentWrapper

• Optional componentWrapper: ComponentType<any>

The React component that wraps every component in a form.

Inherited from

StoreProps.componentWrapper

---

data

• Optional data: Record<string, unknown>

The initial data of the form.

Inherited from

StoreProps.data

---

erroneous

• Optional erroneous: boolean

No use a error wrap component.

Inherited from

StoreProps.erroneous

---

event

• Optional event: (stream: EventStream) => void

Type declaration

▸ (stream): void

The function for processing form events.

Parameters

Name	Type	Description
stream	EventStream	the event stream of the form viewer.

Returns

void

---

formName

• Optional formName: string

the form name.

Inherited from

StoreProps.formName

---

getForm

• Optional getForm: (name?: string) => PersistedForm | Promise<PersistedForm>

Type declaration

▸ (name?): PersistedForm | Promise<PersistedForm>

Loads the form.

Parameters

Name	Type	Description
name?	string	the form name.

Returns

PersistedForm | Promise<PersistedForm>

the object or Promise with the form.

Inherited from

StoreProps.getForm

---

language

• Optional language: string

The language of form.

Inherited from

StoreProps.language

---

slotWrapper

• Optional slotWrapper: ComponentType<any>

The React component that wraps a template slot.

Inherited from

StoreProps.slotWrapper

---

view

• view: View

All the metadata of the components of the form viewer.

Inherited from

StoreProps.view

---

viewMode

• Optional viewMode: ViewMode

Display resolution type.

Inherited from

StoreProps.viewMode