Skip to main content

Interface: FormApi

Defined in: types.ts:335

Properties

busy

busy: boolean;

Defined in: types.ts:355


canFinish

canFinish: boolean;

Defined in: types.ts:347


canNext

canNext: boolean;

Defined in: types.ts:346


definition

definition: FormDefinition;

Defined in: types.ts:337


dirty

dirty: boolean;

Defined in: types.ts:351


engine

engine: FormEngine;

Defined in: types.ts:336


errorCount

errorCount: number;

Defined in: types.ts:352


locale

locale: string;

Defined in: types.ts:353


mode

mode: RenderMode;

Defined in: types.ts:357


page

page: number;

Defined in: types.ts:341

Index into pages (relevant pages only).


pages

pages: PageView[];

Defined in: types.ts:342


readOnly

readOnly: boolean;

Defined in: types.ts:356


status

status: SubmissionStatus;

Defined in: types.ts:339


submissionId

submissionId: string;

Defined in: types.ts:338

Methods

finalize()

finalize(): Promise<Result<Submission, ValidationResult>>;

Defined in: types.ts:349

Returns

Promise<Result<Submission, ValidationResult>>


goTo()

goTo(pageOrId): Promise<boolean>;

Defined in: types.ts:343

Parameters

ParameterType
pageOrIdstring | number

Returns

Promise<boolean>


next()

next(): Promise<boolean>;

Defined in: types.ts:344

Returns

Promise<boolean>


prev()

prev(): Promise<void>;

Defined in: types.ts:345

Returns

Promise<void>


save()

save(): Promise<void>;

Defined in: types.ts:350

Returns

Promise<void>


setLocale()

setLocale(locale): void;

Defined in: types.ts:354

Parameters

ParameterType
localestring

Returns

void


validate()

validate(): ValidationResult;

Defined in: types.ts:348

Returns

ValidationResult