Interface IParams<Data, Payload, Field, Param>

Interface for the Params class.

interface IParams<
    Data extends IAnything = IAnything,
    Payload extends IAnything = IAnything,
    Field = IField<Data>,
    Param = any,
> {
    AfterTitle?: any;
    apiRef?: any;
    BeforeTitle?: any;
    changeSubject?: TSubject<Data>;
    dirty?: boolean;
    fallback?: (e: Error) => void;
    features?:
        | string[]
        | Record<string, Value>
        | () => string[] | Record<string, Value>;
    fields: Field[];
    fullScreen?: boolean;
    handler?: OneHandler<Data, Payload>;
    hidden?: boolean;
    incomingTransform?: (data: any, payload: Payload) => Data;
    isBaseline?: (field: IField) => boolean;
    isBaselineForRoot?: (field: IField) => boolean;
    onChange?: (data: Data, initial: boolean) => void;
    onClose?: () => void;
    onInvalid?: (name: string, msg: string) => void;
    onLoadEnd?: (isOk: boolean) => void;
    onLoadStart?: () => void;
    onSubmit?: (
        data: null | Data,
        payload: Payload,
        param: Param,
    ) => boolean | Promise<boolean>;
    outgoingTransform?: (data: any, payload: Payload) => Data;
    outlinePaper?: boolean;
    param?: Param;
    payload?: Payload | () => Payload;
    readonly?: boolean;
    readTransform?: (
        value: string | string[],
        name: string,
        data: Data,
        payload: Payload,
    ) => Value;
    reloadSubject?: TSubject<void>;
    sizeRequest?: (size: ISize) => { height: number; sx?: any; width: number };
    submitIcon?: any;
    submitLabel?: string;
    throwError?: boolean;
    title?: string;
    transparentPaper?: boolean;
    waitForChangesDelay?: number;
    withActionButton?: boolean;
    withLoader?: boolean;
    withStaticAction?: boolean;
    writeTransform?: (
        value: string | string[],
        name: string,
        data: Data,
        payload: Payload,
    ) => Value;
}

Type Parameters

Hierarchy

Properties

AfterTitle?: any
apiRef?: any
BeforeTitle?: any
changeSubject?: TSubject<Data>
dirty?: boolean
fallback?: (e: Error) => void
features?:
    | string[]
    | Record<string, Value>
    | () => string[] | Record<string, Value>
fields: Field[]
fullScreen?: boolean
handler?: OneHandler<Data, Payload>
hidden?: boolean
incomingTransform?: (data: any, payload: Payload) => Data
isBaseline?: (field: IField) => boolean
isBaselineForRoot?: (field: IField) => boolean
onChange?: (data: Data, initial: boolean) => void
onClose?: () => void
onInvalid?: (name: string, msg: string) => void
onLoadEnd?: (isOk: boolean) => void
onLoadStart?: () => void
onSubmit?: (
    data: null | Data,
    payload: Payload,
    param: Param,
) => boolean | Promise<boolean>
outgoingTransform?: (data: any, payload: Payload) => Data
outlinePaper?: boolean
param?: Param
payload?: Payload | () => Payload
readonly?: boolean
readTransform?: (
    value: string | string[],
    name: string,
    data: Data,
    payload: Payload,
) => Value
reloadSubject?: TSubject<void>
sizeRequest?: (size: ISize) => { height: number; sx?: any; width: number }
submitIcon?: any
submitLabel?: string
throwError?: boolean
title?: string
transparentPaper?: boolean
waitForChangesDelay?: number
withActionButton?: boolean
withLoader?: boolean
withStaticAction?: boolean
writeTransform?: (
    value: string | string[],
    name: string,
    data: Data,
    payload: Payload,
) => Value