aws-northstar/esm/components/FormRenderer/index.d.ts

NorthStar Design System

/** *******************************************************************************************************************
  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  
  Licensed under the Apache License, Version 2.0 (the "License").
  You may not use this file except in compliance with the License.
  You may obtain a copy of the License at
  
      http://www.apache.org/licenses/LICENSE-2.0
  
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.                                                                              *
 ******************************************************************************************************************** */
import { FunctionComponent, ElementType } from 'react';
import { FormRendererProps as ReactFormRendererProps } from '@data-driven-forms/react-form-renderer';
import { FormSubscription as ReactFormSubscription } from 'final-form';
import validatorTypes from '@data-driven-forms/react-form-renderer/validator-types';
import { ValidatorMapper } from '@data-driven-forms/react-form-renderer/validator-mapper';
import { componentTypes, Schema, Option } from './types';
export interface FormRendererProps {
    /** A schema which defines structure of the form. */
    schema: Schema;
    /** An object of fields names as keys and values as their values. */
    initialValues?: object;
    /** A submit callback which receives two arguments: values and formApi. */
    onSubmit: ReactFormRendererProps['onSubmit'];
    /** A cancel callback, which receives values as the first argument. */
    onCancel?: () => void;
    /** When true, the submit button is disabled with a loading spinner */
    isSubmitting?: boolean;
    /** The subscription for the formstate change so the form is rerendered each time the subscription value changed*/
    subscription?: ReactFormSubscription;
    /** Custom component wrappers*/
    customComponentWrapper?: {
        [componentType: string]: ElementType;
    };
    /** Custom validator mapper */
    validatorMapper?: ValidatorMapper;
}
export interface FormRendererContextProps {
    isSubmitting?: boolean;
}
export declare const useFormRendererContext: () => FormRendererContextProps;
/**
 * FormRenderer converts JSON form definitions into fully functional React forms.
 *
 * It leverages [Data Driven Form](https://data-driven-forms.org/) with customer component mappings to use our own form controls.
 */
declare const FormRenderer: FunctionComponent<FormRendererProps>;
export default FormRenderer;
export { componentTypes, validatorTypes };
export type { ValidatorMapper, Schema, Option };
export type { Field } from '@data-driven-forms/react-form-renderer/common-types';