rsuite/src/Form/Form.d.ts

A suite of react components

import * as React from 'react';

import { StandardProps, TypeAttributes } from '../@types/common';
import { Schema } from '../Schema/Schema.d';
import { CheckResult } from '../Schema/Type';

export interface FormProps<
  T = Record<string, any>,
  errorMsgType = string,
  E = { [P in keyof T]?: errorMsgType }
> extends StandardProps {
  /** Set the left and right columns of the layout of the elements within the form */
  layout?: 'horizontal' | 'vertical' | 'inline';

  /** The fluid property allows the Input 100% of the form to fill the container, valid only in vertical layouts. */
  fluid?: boolean;

  /** Current value of the input. Creates a controlled component */
  formValue?: T;

  /** Initial value */
  formDefaultValue?: T;

  /** Error message of form */
  formError?: E;

  /** Delayed processing when data check, unit: millisecond */
  checkDelay?: number;

  /** Trigger the type of form validation */
  checkTrigger?: TypeAttributes.CheckTrigger;

  /** SchemaModel object */
  model?: Schema;

  /** Make the form readonly */
  readOnly?: boolean;

  /** Render the form as plain text */
  plaintext?: boolean;

  /** Callback fired when data changing */
  onChange?: (formValue: T, event: React.SyntheticEvent<HTMLElement>) => void;

  /** Callback fired when error checking */
  onError?: (formError: E) => void;

  /** Callback fired when data cheking */
  onCheck?: (formError: E) => void;
}

export interface FormInstance<
  T = Record<string, any>,
  errorMsg = string,
  E = { [P in keyof T]?: errorMsg }
> extends React.Component<FormProps<T, E>> {
  check: (callback?: (formError: E) => void) => boolean;
  checkAsync: () => Promise<any>;
  checkForField: (
    fieldName: keyof T,
    callback?: (checkResult: CheckResult<errorMsg>) => void
  ) => boolean;
  checkForFieldAsync: (fieldName: keyof T) => Promise<CheckResult>;
  cleanErrors: (callback?: () => void) => void;
  cleanErrorForFiled: (fieldName: keyof E, callback?: () => void) => void;
  resetErrors: (formError: E, callback?: () => void) => void;
}

declare const Form: React.ComponentType<FormProps>;

export default Form;