@syncfusion/ej2-inplace-editor/src/inplace-editor/base/interface.d.ts

A package of Essential JS 2 Inplace editor components, which is used to edit and update the value dynamically in server.

import { ButtonModel } from '@syncfusion/ej2-buttons';
import { ColorPicker, Slider } from '@syncfusion/ej2-inputs';
import { RichTextEditor } from '@syncfusion/ej2-richtexteditor';
import { DateRangePicker, TimePicker, DateRange } from '@syncfusion/ej2-calendars';
import { AutoComplete, ComboBox, MultiSelect, FieldSettingsModel } from '@syncfusion/ej2-dropdowns';
import { RenderMode } from './inplace-editor';
/**
 * Defines component types that can be used in the In-place Editor.
 *
 * @hidden
 */
export declare type Component = AutoComplete | ColorPicker | ComboBox | DateRangePicker | MultiSelect | RichTextEditor | Slider | TimePicker;
/**
 * Provides information about a Notify.
 */
export interface NotifyParams {
    type?: string;
    module: string;
    target?: HTMLElement | HTMLInputElement;
}
/**
 * Provides information about a Component.
 */
export interface IComponent {
    showPopup?(): void;
    compObj: Component;
    render(e: NotifyParams): void;
    focus(): void;
    updateValue(e: NotifyParams): void;
    refresh?(): void;
    getRenderValue?(): void;
}
/**
 * Provides information about a Button.
 */
export interface IButton {
    type: string;
    constant: string;
    title: object;
    className: string;
    model: ButtonModel;
    container: HTMLElement;
}
/**
 * Provides information about a ActionBegin event.
 */
export interface ActionBeginEventArgs {
    /** Defines the name of the field */
    data: {
        [key: string]: string | number;
    };
    /** Prevent the submit action. */
    cancel?: boolean;
}
/**
 * Provides information about a Action event.
 */
export interface ActionEventArgs {
    /** Prevents the current value render in the editor. */
    cancel?: boolean;
    /** Defines the data manager action result. */
    data: object;
    /** Defines the current editor value */
    value: string;
}
/**
 * Provides information about a Form event.
 */
export interface FormEventArgs {
    inputName: string;
    message: string;
    element: HTMLInputElement;
    status?: string;
    errorElement?: HTMLElement;
}
/**
 * Provides information about a Validate event.
 */
export interface ValidateEventArgs extends ActionBeginEventArgs {
    /** Defines form validation error message. */
    errorMessage: string;
}
/**
 * Provides information about a BeginEdit event.
 */
export interface BeginEditEventArgs {
    /** Specifies whether to cancel the open action of the editor. */
    cancel?: boolean;
    /** Specifies whether to cancel the focus action, before open a editor. */
    cancelFocus?: boolean;
    /** Defines the current editor mode. */
    mode?: RenderMode;
}
/**
 * Provides information about the EndEdit event.
 */
export interface EndEditEventArgs {
    /** Defines the type of action ends the edit. */
    action?: string;
    /** Specifies whether to cancel the end edit action. */
    cancel?: boolean;
    /** Defines the current editor mode. */
    mode?: RenderMode;
}
/**
 * Provides information about the Change event.
 */
export interface ChangeEventArgs {
    /** Returns the selected item as JSON Object from the AutoComplete/ComboBox/DropDownList data source. */
    itemData?: FieldSettingsModel;
    /** Returns the previous selected item as JSON Object from the AutoComplete/ComboBox/DropDownList data source. */
    previousItemData?: FieldSettingsModel;
    /** Returns the previous value of integrated component that renders based on the `type` property in the In-place editor. */
    previousValue: string | string[] | number | number[] | boolean[] | Date | Date[] | DateRange;
    /** Returns the value of integrated component that renders based on the `type` property in the In-place editor. */
    value: string | string[] | number | number[] | boolean[] | Date | Date[] | DateRange;
}