Interface: FormContext
Properties
fields
• fields: any
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:95
labelWidth
• Optional labelWidth: FormLabelWidth
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:103
layout
• Optional layout: FormLayout
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:104
submittingRef
• submittingRef: MutableRefObject<boolean>
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:121
validationsRef
• validationsRef: MutableRefObject<AnonymousObject<FieldValidation>>
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:123
valuesRef
• valuesRef: MutableRefObject<any>
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:122
Methods
add
▸ add(fieldArrayName, initialValue?): void
Parameters
| Name | Type |
|---|---|
fieldArrayName | string |
initialValue? | any |
Returns
void
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:93
clearValidation
▸ clearValidation(fieldName, validatorName, code): void
Parameters
| Name | Type |
|---|---|
fieldName | string |
validatorName | string |
code | ValidationCode |
Returns
void
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:94
getContainerFieldValidation
▸ getContainerFieldValidation(validations, fields, prefix?, touchedOnly?): ContainerValidation
Parameters
| Name | Type |
|---|---|
validations | AnonymousObject<FieldValidation> |
fields | AnonymousObject<Field> |
prefix? | string |
touchedOnly? | boolean |
Returns
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:97
init
▸ init(name, validators?, fieldOptions?): FieldProps
Parameters
| Name | Type |
|---|---|
name | string |
validators? | Validator[] |
fieldOptions? | FieldOptions |
Returns
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:96
offSubmittingChange
▸ offSubmittingChange(listener): void
Parameters
| Name | Type |
|---|---|
listener | FormListener |
Returns
void
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:105
offValidationChange
▸ offValidationChange(listener, watchs): void
Parameters
| Name | Type |
|---|---|
listener | FormListener |
watchs | string | string[] |
Returns
void
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:106
offValueChange
▸ offValueChange(listener, watchs): void
Parameters
| Name | Type |
|---|---|
listener | FormListener |
watchs | string | string[] |
Returns
void
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:107
onSubmittingChange
▸ onSubmittingChange(listener, once?): void
Parameters
| Name | Type |
|---|---|
listener | FormListener |
once? | boolean |
Returns
void
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:108
onValidationChange
▸ onValidationChange(listener, watchs, once?): void
Parameters
| Name | Type |
|---|---|
listener | FormListener |
watchs | string | string[] |
once? | boolean |
Returns
void
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:109
onValueChange
▸ onValueChange(listener, watchs, once?): void
Parameters
| Name | Type |
|---|---|
listener | FormListener |
watchs | string | string[] |
once? | boolean |
Returns
void
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:110
remove
▸ remove(fieldArrayName, index): void
Parameters
| Name | Type |
|---|---|
fieldArrayName | string |
index | number |
Returns
void
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:111
reset
▸ reset(): void
Returns
void
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:112
setError
▸ setError(fieldName, validatorName, message?, match?): boolean
Parameters
| Name | Type |
|---|---|
fieldName | string |
validatorName | string |
message? | string |
match? | boolean |
Returns
boolean
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:113
setOK
▸ setOK(fieldName, validatorName): boolean
Parameters
| Name | Type |
|---|---|
fieldName | string |
validatorName | string |
Returns
boolean
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:114
setPendingValidation
▸ setPendingValidation(fieldName, validatorName, pending?): boolean
Parameters
| Name | Type |
|---|---|
fieldName | string |
validatorName | string |
pending? | any |
Returns
boolean
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:115
setValidation
▸ setValidation(fieldName, validatorName, code, message?): void
Parameters
| Name | Type |
|---|---|
fieldName | string |
validatorName | string |
code | ValidationCode |
message? | string |
Returns
void
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:116
setValue
▸ setValue(fieldName, value): void
Parameters
| Name | Type |
|---|---|
fieldName | string |
value | any |
Returns
void
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:117
setValues
▸ setValues(values): void
Parameters
| Name | Type |
|---|---|
values | AnonymousObject<any> |
Returns
void
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:118
setWarning
▸ setWarning(fieldName, validatorName, message?, match?): boolean
Parameters
| Name | Type |
|---|---|
fieldName | string |
validatorName | string |
message? | string |
match? | boolean |
Returns
boolean
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:119
submit
▸ submit(e?): void
Parameters
| Name | Type |
|---|---|
e? | SyntheticEvent<Element, Event> |
Returns
void
Defined in
onekijs/packages/onekijs-framework/src/form/typings.ts:120