@data-driven-forms/react-form-renderer
Advanced tools
Comparing version 3.20.2 to 3.20.3
@@ -1,8 +0,8 @@ | ||
import { Validator } from "../validators"; | ||
import { Validator } from '../validators'; | ||
import { ConditionDefinition } from '../condition'; | ||
import { DataType } from "../data-types"; | ||
import { AnyObject } from "../common-types/any-object"; | ||
import { FieldInputProps } from "react-final-form"; | ||
import { FormOptions } from "../renderer-context"; | ||
import { Meta } from "../use-field-api"; | ||
import { DataType } from '../data-types'; | ||
import { AnyObject } from '../common-types/any-object'; | ||
import { FieldInputProps } from 'react-final-form'; | ||
import { FormOptions } from '../renderer-context'; | ||
import { Meta } from '../use-field-api'; | ||
@@ -20,5 +20,9 @@ export type FieldAction = [string, ...any[]]; | ||
export type ResolvePropsFunction = (props: AnyObject, fieldApi: FieldApi<any>, formOptions: FormOptions) => AnyObject; | ||
export type ResolvePropsFunction<FormValues = Record<string, any>, FieldValue = FormValues[keyof FormValues]> = ( | ||
props: AnyObject, | ||
fieldApi: FieldApi<FieldValue>, | ||
formOptions: FormOptions<FormValues> | ||
) => AnyObject; | ||
interface Field extends AnyObject { | ||
interface Field<FormValues = Record<string, any>, FieldValue = FormValues[keyof FormValues]> extends AnyObject { | ||
name: string; | ||
@@ -30,9 +34,9 @@ component: string; | ||
dataType?: DataType; | ||
initialValue?: any; | ||
clearedValue?: any; | ||
initialValue?: FieldValue; | ||
clearedValue?: FieldValue; | ||
clearOnUnmount?: boolean; | ||
actions?: FieldActions; | ||
resolveProps?: ResolvePropsFunction; | ||
resolveProps?: ResolvePropsFunction<FormValues, FieldValue>; | ||
} | ||
export default Field; |
@@ -1,6 +0,6 @@ | ||
import { ComponentType, FunctionComponent, ReactNode } from 'react'; | ||
import { ComponentType, ReactElement, FunctionComponent, ReactNode } from 'react'; | ||
import { FormProps } from 'react-final-form'; | ||
import Schema from '../common-types/schema'; | ||
import ComponentMapper from '../common-types/component-mapper'; | ||
import { ValidatorMapper} from '../validator-mapper'; | ||
import { ValidatorMapper } from '../validator-mapper'; | ||
import { ActionMapper } from './action-mapper'; | ||
@@ -11,8 +11,12 @@ import SchemaValidatorMapper from '../common-types/schema-validator-mapper'; | ||
export interface FormRendererProps extends Omit<FormProps, 'onSubmit'> { | ||
initialValues?: object; | ||
onCancel?: (values: AnyObject, ...args: any[]) => void; | ||
export interface FormRendererProps< | ||
FormValues = Record<string, any>, | ||
InitialFormValues = Partial<FormValues>, | ||
FormTemplateProps extends FormTemplateRenderProps = FormTemplateRenderProps | ||
> extends Omit<FormProps<FormValues, InitialFormValues>, 'onSubmit'> { | ||
initialValues?: InitialFormValues; | ||
onCancel?: (values: FormValues, ...args: any[]) => void; | ||
onReset?: () => void; | ||
onError?: (...args: any[]) => void; | ||
onSubmit?: FormProps['onSubmit'] | ||
onSubmit?: FormProps<FormValues, InitialFormValues>['onSubmit']; | ||
schema: Schema; | ||
@@ -22,12 +26,16 @@ clearOnUnmount?: boolean; | ||
componentMapper: ComponentMapper; | ||
FormTemplate?: ComponentType<FormTemplateRenderProps> | FunctionComponent<FormTemplateRenderProps>; | ||
FormTemplate?: ComponentType<FormTemplateProps> | FunctionComponent<FormTemplateProps>; | ||
validatorMapper?: ValidatorMapper; | ||
actionMapper?: ActionMapper; | ||
schemaValidatorMapper?: SchemaValidatorMapper; | ||
FormTemplateProps?: AnyObject; | ||
children?: ReactNode | ((props: FormTemplateRenderProps) => ReactNode) | ||
FormTemplateProps?: Partial<FormTemplateProps>; | ||
children?: ReactNode | ((props: FormTemplateRenderProps) => ReactNode); | ||
} | ||
declare const FormRenderer: React.ComponentType<FormRendererProps>; | ||
declare function FormRenderer< | ||
FormValues = Record<string, any>, | ||
InitialFormValues = Partial<FormValues>, | ||
FormTemplateProps extends FormTemplateRenderProps = FormTemplateRenderProps | ||
>(props: FormRendererProps<FormValues, InitialFormValues, FormTemplateProps>): ReactElement<any, any>; | ||
export default FormRenderer; |
{ | ||
"name": "@data-driven-forms/react-form-renderer", | ||
"version": "3.20.2", | ||
"version": "3.20.3", | ||
"description": "React Form Renderer. Data Driven Forms converts JSON form definitions into fully functional React forms.", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -10,16 +10,17 @@ import React, { ReactNode } from 'react'; | ||
export interface FormOptions extends FormApi { | ||
registerInputFile?: (name: string) => void; | ||
unRegisterInputFile?: (name: string) => void; | ||
onCancel?: (values: object, ...args: any[]) => void; | ||
export interface FormOptions<FormValues = Record<string, any>, InitialFormValues = Partial<FormValues>> | ||
extends FormApi<FormValues, InitialFormValues> { | ||
registerInputFile?: (name: keyof FormValues) => void; | ||
unRegisterInputFile?: (name: keyof FormValues) => void; | ||
onCancel?: (values: FormValues, ...args: any[]) => void; | ||
onReset?: () => void; | ||
handleSubmit: () => Promise<AnyObject | undefined> | undefined; | ||
handleSubmit: () => Promise<FormValues | undefined> | undefined; | ||
clearedValue?: any; | ||
renderForm: (fields: Field[]) => ReactNode[]; | ||
internalRegisterField: (name: string) => void; | ||
internalUnregisterField: (name: string) => void; | ||
internalRegisterField: (name: keyof FormValues) => void; | ||
internalUnregisterField: (name: keyof FormValues) => void; | ||
getRegisteredFields: () => string[]; | ||
ffGetRegisteredFields: () => string[]; | ||
initialValues: AnyObject; | ||
schema: Schema, | ||
initialValues: InitialFormValues; | ||
schema: Schema; | ||
} | ||
@@ -26,0 +27,0 @@ |
import { FormOptions } from '../renderer-context'; | ||
export default function(): FormOptions; | ||
export default function useFormApi<FormValues = Record<string, any>, InitialFormValues = Partial<FormValues>>(): FormOptions< | ||
FormValues, | ||
InitialFormValues | ||
>; |
296696
6036