FormStepIFrame

Stentor API Reference

---

Stentor API Reference / stentor-models/src / FormStepIFrame

Interface: FormStepIFrame

Defined in: packages/stentor-models/src/Form/FormStep.ts:7

A step is partial form. Fields plus next/prev/submit buttons as needed. We are going through these "mini screens".

Extends

• FormStep

Properties

iframe

iframe: object

Defined in: packages/stentor-models/src/Form/FormStep.ts:11

An iframe step is a form step that is rendered as an iframe.

src

src: string

The source of the iframe.

width?

optional width: string

Optional width, defaults to 100%

height?

optional height: string

Optional height, defaults to 100%

---

name

name: string

Defined in: packages/stentor-models/src/Form/FormStep.ts:32

Inherited from

FormStep.name

---

title?

optional title: string

Defined in: packages/stentor-models/src/Form/FormStep.ts:33

Inherited from

FormStep.title

---

fields

fields: FormField[]

Defined in: packages/stentor-models/src/Form/FormStep.ts:37

The fields that are part of the form.

Inherited from

FormStep.fields

---

condition?

optional condition: string

Defined in: packages/stentor-models/src/Form/FormStep.ts:39

Inherited from

FormStep.condition

---

nextAction?

optional nextAction: "next" | "submit" | "omit"

Defined in: packages/stentor-models/src/Form/FormStep.ts:47

The action to take when the user clicks the next button.

"next": move to the next step "submit": force "Next" instead of "Submit" (server generated next step). "omit": don't show the next button (for instance final "Thank you screen")

Inherited from

FormStep.nextAction

---

previousAction?

optional previousAction: "submit" | "omit" | "previous"

Defined in: packages/stentor-models/src/Form/FormStep.ts:55

The action to take when the user clicks the previous button.

"previous": move to the previous step "submit": force "Previous" instead of "Submit" (server generated previous step). "omit": don't show the previous button (for instance first step)

Inherited from

FormStep.previousAction

---

nextLabel?

optional nextLabel: string

Defined in: packages/stentor-models/src/Form/FormStep.ts:59

The label to use for the next button, defaults to "Next".

Inherited from

FormStep.nextLabel

---

previousLabel?

optional previousLabel: string

Defined in: packages/stentor-models/src/Form/FormStep.ts:63

The label to use for the previous button, defaults to "Previous".

Inherited from

FormStep.previousLabel

---

final?

optional final: boolean

Defined in: packages/stentor-models/src/Form/FormStep.ts:67

Inherited from

FormStep.final

---

crmSubmit?

optional crmSubmit: boolean

Defined in: packages/stentor-models/src/Form/FormStep.ts:70

Inherited from

FormStep.crmSubmit

---

warnBeforeUnload?

optional warnBeforeUnload: boolean

Defined in: packages/stentor-models/src/Form/FormStep.ts:82

Beta

Warn the user before unloading the page if there are unsaved changes.

This is especially helpful when either crmSubmit is true or final is true, to prevent users from accidentally losing their data.

This will trigger a browser dialog when the user attempts to close the tab or navigate away which does not work on all browsers.

This is a beta feature and may change in future releases.

Inherited from

FormStep.warnBeforeUnload

---

warnBeforeUnloadMessage?

optional warnBeforeUnloadMessage: string

Defined in: packages/stentor-models/src/Form/FormStep.ts:91

Beta

Custom message to display in the unload warning dialog. This is used when the use attempts to hit the 'X' button on the form when they have unsaved changes.

This is a beta feature and may change in future releases.

Note: Most browsers do not display custom messages anymore, but having this property allows for future compatibility and clarity.

Inherited from

FormStep.warnBeforeUnloadMessage