LocalFormBase | WebHare Platform SDK

Class LocalFormBase<DataShape>

Type Parameters

DataShape extends object = Record<string, unknown>

Hierarchy (View Summary)

FormFieldMap<DataShape>
- LocalFormBase
  - FormBase

Index

Constructors

constructor

new LocalFormBase<DataShape extends object = Record<string, unknown>>(
node: HTMLFormElement,
): LocalFormBase<DataShape>
Type Parameters
- DataShape extends object = Record<string, unknown>
Parameters
- node: HTMLFormElement
Returns LocalFormBase<DataShape>
Overrides FormFieldMap<DataShape>.constructor
- Defined in modules/publisher/js/forms/formbase.ts:263

Properties

__scheduleUpdateConditions

__scheduleUpdateConditions: () => Promise<void> = ...

`Protected`_submitstart

_submitstart: undefined | number

`Readonly`data

data: DataShape = ...

`Readonly`elements

elements: HTMLFormControlsCollection

Deprecated

Use node.elements if you want a true HTMLFormControlsCollection, use getElementByName since WH5.4+ for properly typed elements

`Protected`fieldmap

fieldmap: Map<string, FormField> = ...

Field mapping. Uses original names

`Protected`fieldName

fieldName: string

`Readonly`node

node: HTMLFormElement

Methods

`Protected`__formStarted

__formStarted(): void
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:338

_addDescribedBy

_addDescribedBy(contextnode: HTMLElement, messageid: string): void
Parameters
- contextnode: HTMLElement
- messageid: string
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:531

_applyPrefills

_applyPrefills(): void
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:401

_checkClick

_checkClick(evt: DocEvent<MouseEvent>): void
Parameters
- evt: DocEvent<MouseEvent>
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:712

_doSetFieldError

_doSetFieldError(evt: DocEvent<CustomEvent<SetFieldErrorData>>): void
Parameters
- evt: DocEvent<CustomEvent<SetFieldErrorData>>
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:568

_doSubmit

_doSubmit(evt: null | SubmitEvent, extradata: unknown): Promise<void>
Parameters
- evt: null | SubmitEvent
- extradata: unknown
Returns Promise<void>
- Defined in modules/publisher/js/forms/formbase.ts:659

_executeNextValidation

_executeNextValidation(): Promise<void>
Returns Promise<void>
- Defined in modules/publisher/js/forms/formbase.ts:1607

_executeQueuedValidation

_executeQueuedValidation(
limitset?: LimitSet,
options?: ValidationOptions,
): Promise<FormValidationResult>
Parameters
- Optionallimitset: LimitSet
- Optionaloptions: ValidationOptions
Returns Promise<FormValidationResult>
- Defined in modules/publisher/js/forms/formbase.ts:1620

_getConditionRawValue

_getConditionRawValue(
fieldname: string,
options?: { checkdisabled?: boolean },
): null | string | string[]
Parameters
- fieldname: string
- Optionaloptions: { checkdisabled?: boolean }
Returns null | string | string[]
- Defined in modules/publisher/js/forms/formbase.ts:1077

_getFieldsToValidate

_getFieldsToValidate(startingpoint?: HTMLElement): HTMLElement[]
Parameters
- Optionalstartingpoint: HTMLElement
Returns HTMLElement[]
- Defined in modules/publisher/js/forms/formbase.ts:646

_getPageTitle

_getPageTitle(pagenum: number): string
Parameters
- pagenum: number
Returns string
- Defined in modules/publisher/js/forms/formbase.ts:814

_getQueryiedFieldValue

_getQueryiedFieldValue(
field: FormControlDescription,
): string[] | Promise<unknown>
getValue from a field as returned by _queryAllFields (supporting both multilevel and plain fields)
Parameters
- field: FormControlDescription
Returns string[] | Promise<unknown>
promise
- Defined in modules/publisher/js/forms/formbase.ts:1437

_getVariableValueForConditions

_getVariableValueForConditions(
conditionfield: string,
options?: { checkdisabled?: boolean; matchcase?: boolean },
): null | string | string[]
Parameters
- conditionfield: string
- Optionaloptions: { checkdisabled?: boolean; matchcase?: boolean }
Returns null | string | string[]
- Defined in modules/publisher/js/forms/formbase.ts:1115

_isNowSettable

_isNowSettable(node: HTMLElement): boolean
Parameters
- node: HTMLElement
Returns boolean
- Defined in modules/publisher/js/forms/formbase.ts:1456

_isPartOfForm

_isPartOfForm(el: HTMLElement): boolean
Parameters
- el: HTMLElement
Returns boolean
- Defined in modules/publisher/js/forms/formbase.ts:1377

_matchesCondition

_matchesCondition(conditiontext: undefined | string): boolean
Parameters
- conditiontext: undefined | string
Returns boolean
- Defined in modules/publisher/js/forms/formbase.ts:1070

_matchesConditionRecursive

_matchesConditionRecursive(condition: FormCondition): boolean
Parameters
- condition: FormCondition
Returns boolean
- Defined in modules/publisher/js/forms/formbase.ts:1166

_navigateToThankYou

_navigateToThankYou(richvalues?: RichValues): void
Parameters
- Optionalrichvalues: RichValues
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:1250

_onInputChange

_onInputChange(): void
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:866

_onTakeFocus

_onTakeFocus(evt: DocEvent<TakeFocusEvent>): void
Parameters
- evt: DocEvent<TakeFocusEvent>
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:702

_processFieldValue

_processFieldValue(
    outdata: FormResultValue,
    fieldpromises: Promise<void>[],
    fieldname: string,
    receivedvalue: unknown,
): void
Parameters
- outdata: FormResultValue
- fieldpromises: Promise<void>[]
- fieldname: string
- receivedvalue: unknown
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:1480

_queryAllFields

_queryAllFields(
    options?: {
        onlysettable?: boolean;
        skiparraymembers?: boolean;
        skipfield?: HTMLElement;
        startnode?: HTMLElement;
    },
): FormControlDescription[]
Parameters
- Optionaloptions: {
      onlysettable?: boolean;
      skiparraymembers?: boolean;
      skipfield?: HTMLElement;
      startnode?: HTMLElement;
  }
Returns FormControlDescription[]
- Defined in modules/publisher/js/forms/formbase.ts:1384

_removeDescribedBy

_removeDescribedBy(contextnode: HTMLElement, messageid: string): void
Parameters
- contextnode: HTMLElement
- messageid: string
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:543

_reportFieldValidity

_reportFieldValidity(node: HTMLElement): boolean
Parameters
- node: HTMLElement
Returns boolean
false on error
- Defined in modules/publisher/js/forms/formbase.ts:577

_rewriteEnableOn

_rewriteEnableOn(): void
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:380

_submit

_submit(evt: null | SubmitEvent, extradata: unknown): Promise<void>
Parameters
- evt: null | SubmitEvent
- extradata: unknown
Returns Promise<void>
- Defined in modules/publisher/js/forms/formbase.ts:599

_submitHasTimedOut

_submitHasTimedOut(): void
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:692

_updateConditions

_updateConditions(isinit: boolean): Promise<void>
Parameters
- isinit: boolean
Returns Promise<void>
- Defined in modules/publisher/js/forms/formbase.ts:871

_updateFieldGroupErrorState

_updateFieldGroupErrorState(field: HTMLElement): void
Parameters
- field: HTMLElement
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:560

_updateFieldGroupMessageState

_updateFieldGroupMessageState(
    field: HTMLElement,
    type: "error" | "suggestion",
    getError: (field: HTMLElement) => null | FormFrontendMessage,
): void
Set or update the message for the specified field
Parameters
- field: HTMLElement
  node on which the validation triggered
- type: "error" | "suggestion"
  type of the message ("error" or "suggestion") - a field or group can have both an "error" and "suggestion" visible
- getError: (field: HTMLElement) => null | FormFrontendMessage
  function which returns a reference to the error node (or DocumentFragment) or a text
  
  .wh-form__field--error - Used to indicate this element has an error .wh-form__field--suggestion - Used to indicate this element has an suggestion .wh-form__error - The error message container .wh-form_suggestion - The suggestion message container
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:440

_updateFieldGroupSuggestionState

_updateFieldGroupSuggestionState(field: HTMLElement): void
Parameters
- field: HTMLElement
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:564

_updatePageNavigation

_updatePageNavigation(): void
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:1236

_updatePageVisibility

_updatePageVisibility(pagelist: HTMLElement[], currentpage: number): void
Parameters
- pagelist: HTMLElement[]
- currentpage: number
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:740

_validateSingleFieldOurselves

_validateSingleFieldOurselves(field: HTMLElement): Promise<boolean>
Parameters
- field: HTMLElement
Returns Promise<boolean>
- Defined in modules/publisher/js/forms/formbase.ts:1562

assign

assign(
data: RecursivePartial<DataShape>,
ignoreUnknownFields?: { ignoreUnknownFields?: boolean },
): void
Set a value for multiple fields
Parameters
- data: RecursivePartial<DataShape>
  The data to set
- ignoreUnknownFields: { ignoreUnknownFields?: boolean } = {}
  Do not throw if a field is not found in the form. This is the default
Returns void
Inherited from FormFieldMap.assign
- Defined in jssdk/forms/src/fieldmap.ts:284

beforeSubmit

beforeSubmit(extradata: unknown): boolean | Promise<boolean>
Override beforeSubmit to have a last chance to block/confirm actual form submission
Parameters
- extradata: unknown
Returns boolean | Promise<boolean>
true to continue submitting
- Defined in modules/publisher/js/forms/formbase.ts:595

executeFormAction

executeFormAction(action: string): Promise<void>
Parameters
- action: string
Returns Promise<void>
- Defined in modules/publisher/js/forms/formbase.ts:821

fixupMergeFields

fixupMergeFields(nodes: HTMLElement[]): Promise<void>
Parameters
- nodes: HTMLElement[]
Returns Promise<void>
- Defined in modules/publisher/js/forms/formbase.ts:1049

getCurrentPage

getCurrentPage(): null | HTMLElement
Returns null | HTMLElement
- Defined in modules/publisher/js/forms/formbase.ts:748

getCurrentPageNumber

getCurrentPageNumber(): number
Get the current page number

Returns number
0-based index of page to jump to
- Defined in modules/publisher/js/forms/formbase.ts:769

getElementByName

getElementByName(
name: string,
): null | FormControlElement | ConstrainedRadioNodeList
Parameters
- name: string
Returns null | FormControlElement | ConstrainedRadioNodeList
- Defined in modules/publisher/js/forms/formbase.ts:313

getField

getField(name: string, options: { allowMissing: true }): null | FormField
Get a field handler by name
Parameters
- name: string
- options: { allowMissing: true }
Returns null | FormField
Inherited from FormFieldMap.getField
- Defined in jssdk/forms/src/fieldmap.ts:262
getField(name: string, options?: { allowMissing?: boolean }): FormField
Get a field handler by name
Parameters
- name: string
- Optionaloptions: { allowMissing?: boolean }
Returns FormField
Inherited from FormFieldMap.getField
- Defined in jssdk/forms/src/fieldmap.ts:263

getFieldGroup

getFieldGroup(name: string): null | HTMLElement
get the fieldgroup for an element
Parameters
- name: string
Returns null | HTMLElement
- Defined in modules/publisher/js/forms/formbase.ts:1526

getFieldNames

getFieldNames(): string[]
Returns string[]
Inherited from FormFieldMap.getFieldNames
- Defined in jssdk/forms/src/fieldmap.ts:276

getFieldValue

getFieldValue(field: HTMLElement): Promise<unknown>
Parameters
- field: HTMLElement
Returns Promise<unknown>
- Defined in modules/publisher/js/forms/formbase.ts:1313

getFormElementNames

getFormElementNames(): string[]
Return the names of all form elements

Returns string[]
- Defined in modules/publisher/js/forms/formbase.ts:1431

getFormValue

getFormValue(): Promise<FormResultValue>
Return a promise resolving to the submittable form value

Returns Promise<FormResultValue>
- Defined in modules/publisher/js/forms/formbase.ts:1445

getLangCode

getLangCode(): string
Get language for this form

Returns string
- Defined in modules/publisher/js/forms/formbase.ts:318

getOptions

getOptions(
    name: string,
): {
    fieldline: null | HTMLElement;
    inputnode: Node & HTMLInputElement;
    value: string;
}[]
Parameters
- name: string
Returns {
    fieldline: null | HTMLElement;
    inputnode: Node & HTMLInputElement;
    value: string;
}[]
- Defined in modules/publisher/js/forms/formbase.ts:1498

getSelectedOption

getSelectedOption(
    name: string,
):
    | null
    | {
        fieldline: null
        | HTMLElement;
        inputnode: Node & HTMLInputElement;
        value: string;
    }
get the selected option associated with a radio/checkbox group. returns an object that's either null or the first selected option
Parameters
- name: string
Returns
    | null
    | {
        fieldline: null
        | HTMLElement;
        inputnode: Node & HTMLInputElement;
        value: string;
    }
- Defined in modules/publisher/js/forms/formbase.ts:1520

getSelectedOptions

getSelectedOptions(
    name: string,
): {
    fieldline: null | HTMLElement;
    inputnode: Node & HTMLInputElement;
    value: string;
}[]
gets the selected option associated with a radio/checkbox group as an array
Parameters
- name: string
Returns {
    fieldline: null | HTMLElement;
    inputnode: Node & HTMLInputElement;
    value: string;
}[]
- Defined in modules/publisher/js/forms/formbase.ts:1512

gotoPage

gotoPage(
page: number | HTMLElement,
__namedParameters?: { __isSubmit?: boolean },
): Promise<void>
Goto a specific page
Parameters
- page: number | HTMLElement
  0-based index of page or the HTML element of the page to jump to
- __namedParameters: { __isSubmit?: boolean } = {}
Returns Promise<void>
- Defined in modules/publisher/js/forms/formbase.ts:775

refreshConditions

refreshConditions(): Promise<void>
Returns Promise<void>
- Defined in modules/publisher/js/forms/formbase.ts:862

reset

reset(): void
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:1687

resetServerSideErrors

resetServerSideErrors(): void
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:651

scrollIntoView

scrollIntoView(scrollto?: HTMLElement): void
Position the specified element's group or the form itself into view, using .wh-anchor nodes to correct for fixed headers
Parameters
- Optionalscrollto: HTMLElement
  Element to position into view. If not set, the form it scrolled into view
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:755

`Protected`sendFormEvent

sendFormEvent(event?: FormAnalyticsSubEvents): void
Parameters
- Optionalevent: FormAnalyticsSubEvents
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:341

setFieldError

setFieldError(
    field: HTMLElement,
    error: string,
    options?: Partial<FieldErrorOptions>,
): void
Parameters
- field: HTMLElement
- error: string
- Optionaloptions: Partial<FieldErrorOptions>
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:1554

setFieldValue

setFieldValue(fieldnode: HTMLElement, value: unknown): void
Parameters
- fieldnode: HTMLElement
- value: unknown
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:1342

submit

submit(
extradata?: unknown,
): Promise<
{ result?: FormSubmitEmbeddedResult<{ [key: string]: unknown }> },
>
Parameters
- Optionalextradata: unknown
Returns Promise<{ result?: FormSubmitEmbeddedResult<{ [key: string]: unknown }> }>
- Defined in modules/publisher/js/forms/formbase.ts:697

updateRichValues

updateRichValues(page: HTMLElement, richvalues?: RichValues): void
Parameters
- page: HTMLElement
- Optionalrichvalues: RichValues
Returns void
- Defined in modules/publisher/js/forms/formbase.ts:1291

validate

validate(
limitset?: LimitSet,
options?: ValidationOptions,
): Promise<FormValidationResult>
validate the form
Parameters
- Optionallimitset: LimitSet
  A single element, nodelist or array of elements to validate (or their children)
- Optionaloptions: ValidationOptions
Returns Promise<FormValidationResult>
a promise that will fulfill when the form is validated
- Defined in modules/publisher/js/forms/formbase.ts:1592

validateAndSubmit

validateAndSubmit(extradata: unknown): Promise<void>
Parameters
- extradata: unknown
Returns Promise<void>
- Defined in modules/publisher/js/forms/formbase.ts:588

validateSingleFormField

validateSingleFormField(field: HTMLElement): Promise<boolean>
Parameters
- field: HTMLElement
Returns Promise<boolean>
- Defined in modules/publisher/js/forms/formbase.ts:1558

`Static`getForNode

getForNode<DataShape extends object = Record<string, unknown>>(
node: HTMLElement,
): null | LocalFormBase<DataShape>
Type Parameters
- DataShape extends object = Record<string, unknown>
Parameters
- node: HTMLElement
Returns null | LocalFormBase<DataShape>
- Defined in modules/publisher/js/forms/formbase.ts:308

`Static`setFieldError

setFieldError(
    field: HTMLElement,
    error: string,
    options?: Partial<FieldErrorOptions>,
): void
Parameters
- field: HTMLElement
- error: string
- Optionaloptions: Partial<FieldErrorOptions>
Returns void
Deprecated
Just import setFieldError from @mod-publisher/js/forms
- Defined in modules/publisher/js/forms/formbase.ts:1550

`Static`setupValidator

setupValidator(
node: HTMLElement,
checker: (node: HTMLElement) => string | Promise<string>,
): void
Parameters
- node: HTMLElement
- checker: (node: HTMLElement) => string | Promise<string>
Returns void
Deprecated
Just import setupValidator from @mod-publisher/js/forms
- Defined in modules/publisher/js/forms/formbase.ts:1545

Class LocalFormBase<DataShape>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns LocalFormBase<DataShape>

Properties

__scheduleUpdateConditions

Protected_submitstart

Readonlydata

Readonlyelements

Deprecated

Protectedfieldmap

ProtectedfieldName

Readonlynode

Methods

Protected__formStarted

Returns void

_addDescribedBy

Parameters

Returns void

_applyPrefills

Returns void

_checkClick

Parameters

Returns void

_doSetFieldError

Parameters

Returns void

_doSubmit

Parameters

Returns Promise<void>

_executeNextValidation

Returns Promise<void>

_executeQueuedValidation

Parameters

Returns Promise<FormValidationResult>

_getConditionRawValue

Parameters

Returns null | string | string[]

_getFieldsToValidate

Parameters

Returns HTMLElement[]

_getPageTitle

Parameters

Returns string

_getQueryiedFieldValue

Parameters

Returns string[] | Promise<unknown>

_getVariableValueForConditions

Parameters

Returns null | string | string[]

_isNowSettable

Parameters

Returns boolean

_isPartOfForm

Parameters

Returns boolean

_matchesCondition

Parameters

Returns boolean

_matchesConditionRecursive

Parameters

Returns boolean

_navigateToThankYou

Parameters

Returns void

_onInputChange

Returns void

_onTakeFocus

Parameters

Returns void

_processFieldValue

Parameters

`Protected`_submitstart

`Readonly`data

`Readonly`elements

`Protected`fieldmap

`Protected`fieldName

`Readonly`node

`Protected`__formStarted