FormStepIFrame
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
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?
optionalwidth?:string
Optional width, defaults to 100%
height?
optionalheight?:string
Optional height, defaults to 100%
name
name:
string
Defined in: packages/stentor-models/src/Form/FormStep.ts:95
Inherited from
title?
optionaltitle?:string
Defined in: packages/stentor-models/src/Form/FormStep.ts:96
Inherited from
subtitle?
optionalsubtitle?:string
Defined in: packages/stentor-models/src/Form/FormStep.ts:102
Optional supporting line rendered beneath title.
Consumers decide placement; the form widget renders it in the step's intro block.
Inherited from
fields
fields:
FormField[]
Defined in: packages/stentor-models/src/Form/FormStep.ts:106
The fields that are part of the form.
Inherited from
condition?
optionalcondition?:string
Defined in: packages/stentor-models/src/Form/FormStep.ts:108
Inherited from
nextAction?
optionalnextAction?:"next"|"submit"|"omit"
Defined in: packages/stentor-models/src/Form/FormStep.ts:116
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
previousAction?
optionalpreviousAction?:"submit"|"omit"|"previous"
Defined in: packages/stentor-models/src/Form/FormStep.ts:124
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
nextLabel?
optionalnextLabel?:string
Defined in: packages/stentor-models/src/Form/FormStep.ts:128
The label to use for the next button, defaults to "Next".
Inherited from
previousLabel?
optionalpreviousLabel?:string
Defined in: packages/stentor-models/src/Form/FormStep.ts:132
The label to use for the previous button, defaults to "Previous".
Inherited from
final?
optionalfinal?:boolean
Defined in: packages/stentor-models/src/Form/FormStep.ts:136
Inherited from
crmSubmit?
optionalcrmSubmit?:boolean
Defined in: packages/stentor-models/src/Form/FormStep.ts:139
Inherited from
warnBeforeUnload?
optionalwarnBeforeUnload?:boolean
Defined in: packages/stentor-models/src/Form/FormStep.ts:151
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
warnBeforeUnloadMessage?
optionalwarnBeforeUnloadMessage?:string
Defined in: packages/stentor-models/src/Form/FormStep.ts:160
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
fullBleed?
optionalfullBleed?:boolean
Defined in: packages/stentor-models/src/Form/FormStep.ts:166
Render this step edge-to-edge, suppressing the container's horizontal gutters. Third-party embeds frequently require the full container width.