input-props/dist/InputProps.d.ts

A React component that provides a two-way data-binding feel to your forms controlled by a mobx state.

import React from 'react';
import { OnValueChangeType, InputPropsVariant, InputPropsConfig, OnValueChangedType } from "./field-props";
import { FormErrorHandler } from "./form-error-handler";
/**
 * InputProps parameters
 */
export interface InputPropsProps<T extends Object, P extends Extract<keyof T, string>, A extends Object> {
    /**
     * the component that you want InputProps to control. InputProps will add the `value`
     * and `onChange` props to the component to automate the state update to
     * stateObject[propertyName]
     * @default mandatory
     */
    children: React.ReactElement;
    /**
     * object that holds the property that will be bound to this component. That property
     * has to be a mobx observable
     * @default mandatory
     */
    stateObject: T;
    /**
     * name of the property inside the stateObject that will be bound to this component.
     * That property has to be a mobx observable
     * @default mandatory
     */
    propertyName: P;
    /**
     * in case you want to be notified about when a change will take place. Your callback
     * can return a promise that, if fulfilled with a return of false, will preven the
     * update to happen.
     */
    onValueChange?: OnValueChangeType<A>;
    /**
     * in case you want to be notified about when a change has happened
     */
    onValueChanged?: OnValueChangedType<A>;
    /**
     * in case you are using a FormErrorHandler to handle the form errors
     */
    errorHandler?: FormErrorHandler<T>;
    /**
     * some built-in variants
     */
    variant?: InputPropsVariant;
    /**
     * some built-in configurations
     */
    config?: InputPropsConfig;
    /** additinal data that will be passed to onValueChange and onValueChanged */
    additionalChangeData?: A;
}
/**
 * A React component that provides a two-way data-binding feel to your forms controlled by a mobx state.
 * It works by creating the `onChange` and `value` props and passing then down to the children input automatically.
 * It also passes down the 'helperText' and 'error' props down if an error handler is being used
 */
export declare function InputProps<T extends Object, P extends Extract<keyof T, string>, A extends Object>({ config, ...props }: InputPropsProps<T, P, A>): React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>;