step-form
step-form
Classes
StepFormState
Defined in: packages/ui/build/step-form/step-form-state.svelte.d.ts:3
Type Parameters
| Type Parameter |
|---|
T extends FormSchema |
Constructors
Constructor
new StepFormState<T>(config): StepFormState<T>;Defined in: packages/ui/build/step-form/step-form-state.svelte.d.ts:9
Parameters
| Parameter | Type |
|---|---|
config |
StepFormConfig<T> |
Returns
Properties
currentStep
currentStep: number;Defined in: packages/ui/build/step-form/step-form-state.svelte.d.ts:4
progress
progress: number;Defined in: packages/ui/build/step-form/step-form-state.svelte.d.ts:8
steps
readonly steps: Step<T>[];Defined in: packages/ui/build/step-form/step-form-state.svelte.d.ts:5
submission
readonly submission: StepFormSubmitContract<InferSchema<T>>;Defined in: packages/ui/build/step-form/step-form-state.svelte.d.ts:6
Methods
next()
next(): void;Defined in: packages/ui/build/step-form/step-form-state.svelte.d.ts:11
Returns
void
previous()
previous(): void;Defined in: packages/ui/build/step-form/step-form-state.svelte.d.ts:12
Returns
void
validateCurrentStep()
validateCurrentStep(): boolean;Defined in: packages/ui/build/step-form/step-form-state.svelte.d.ts:10
Returns
boolean
Type Aliases
Step
type Step<TFinal> = object;Defined in: packages/ui/build/step-form/types.d.ts:3
Type Parameters
| Type Parameter |
|---|
TFinal extends FormSchema |
Properties
| Property | Type | Defined in |
|---|---|---|
description |
string |
packages/ui/build/step-form/types.d.ts:5 |
schema |
FormSchema |
packages/ui/build/step-form/types.d.ts:6 |
title |
string | Snippet |
packages/ui/build/step-form/types.d.ts:4 |
StepForm
type StepForm<T> = InstanceType<typeof StepForm>;Defined in: packages/ui/build/step-form/step-form.svelte.d.ts:30
Type Parameters
| Type Parameter |
|---|
T extends FormSchema |
StepFormConfig
type StepFormConfig<T> = object;Defined in: packages/ui/build/step-form/types.d.ts:20
Type Parameters
| Type Parameter |
|---|
T extends FormSchema |
Properties
| Property | Type | Defined in |
|---|---|---|
onStepValidationFailed? |
() => void |
packages/ui/build/step-form/types.d.ts:23 |
steps |
Step<T>[] |
packages/ui/build/step-form/types.d.ts:21 |
submission |
StepFormSubmitContract<InferSchema<T>> |
packages/ui/build/step-form/types.d.ts:22 |
StepFormSubmitContract
type StepFormSubmitContract<TData> = object;Defined in: packages/ui/build/step-form/types.d.ts:12
Type Parameters
| Type Parameter |
|---|
TData |
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
clearErrors |
public |
() => void |
packages/ui/build/step-form/types.d.ts:17 |
errors |
readonly |
StepFormSubmitErrors |
packages/ui/build/step-form/types.d.ts:15 |
getData |
public |
() => TData |
packages/ui/build/step-form/types.d.ts:16 |
handleSubmit |
public |
(event) => void | Promise<void> |
packages/ui/build/step-form/types.d.ts:13 |
isSubmitting |
readonly |
boolean |
packages/ui/build/step-form/types.d.ts:14 |
setErrors |
public |
(errors) => void |
packages/ui/build/step-form/types.d.ts:18 |
StepFormSubmitErrors
type StepFormSubmitErrors = object;Defined in: packages/ui/build/step-form/types.d.ts:8
Properties
| Property | Type | Defined in |
|---|---|---|
fieldErrors |
Record<string, string[]> |
packages/ui/build/step-form/types.d.ts:9 |
formErrors |
string[] |
packages/ui/build/step-form/types.d.ts:10 |
Variables
StepForm
const StepForm: $$IsomorphicComponent;Defined in: packages/ui/build/step-form/step-form.svelte.d.ts:30
References
Root
Renames and re-exports StepForm