Function useActionModal

Creates a hook for managing an action modal.

  • useActionModal<
        Data extends unknown = any,
        Payload extends unknown = any,
        Field = IField<Data, any>,
        Param = any,
    >(
        params: IParams<Data, Payload, Field, Param>,
    ): {
        open: boolean;
        pickData: (param?: Param) => void;
        render: () => Element;
        setOpen: Dispatch<SetStateAction<boolean>>;
    }

    Type Parameters

    • Data extends unknown = any

      The type of data being submitted.

    • Payload extends unknown = any

      The type of payload data.

    • Field = IField<Data, any>

      The type of field data.

    • Param = any

      The type of param data.

    Parameters

    • params: IParams<Data, Payload, Field, Param>

      The parameters for configuring the action modal.

      Interface for the Params class.

      • OptionalAfterTitle?: any
      • OptionalapiRef?: any
      • OptionalBeforeTitle?: any
      • OptionalchangeSubject?: TSubject<Data>
      • Optionaldirty?: boolean
      • Optionalfallback?: (e: Error) => void
      • Optionalfeatures?: string[] | Record<string, Value> | () => string[] | Record<string, Value>
      • fields: Field[]
      • OptionalfullScreen?: boolean
      • Optionalhandler?: OneHandler<Data, Payload>
      • Optionalhidden?: boolean
      • OptionalincomingTransform?: (data: any, payload: Payload) => Data
      • OptionalisBaseline?: (field: IField) => boolean
      • OptionalisBaselineForRoot?: (field: IField) => boolean
      • OptionalonChange?: (data: Data, initial: boolean) => void
      • OptionalonClose?: () => void
      • OptionalonInvalid?: (name: string, msg: string) => void
      • OptionalonLoadEnd?: (isOk: boolean) => void
      • OptionalonLoadStart?: () => void
      • OptionalonSubmit?: (
            data: null | Data,
            payload: Payload,
            param: Param,
        ) => boolean | Promise<boolean>
      • OptionaloutgoingTransform?: (data: any, payload: Payload) => Data
      • OptionaloutlinePaper?: boolean
      • Optionalparam?: Param
      • Optionalpayload?: Payload | () => Payload
      • Optionalreadonly?: boolean
      • OptionalreadTransform?: (value: string | string[], name: string, data: Data, payload: Payload) => Value
      • OptionalreloadSubject?: TSubject<void>
      • OptionalsizeRequest?: (size: ISize) => { height: number; sx?: any; width: number }
      • OptionalsubmitIcon?: any
      • OptionalsubmitLabel?: string
      • OptionalthrowError?: boolean
      • Optionaltitle?: string
      • OptionaltransparentPaper?: boolean
      • OptionalwaitForChangesDelay?: number
      • OptionalwithActionButton?: boolean
      • OptionalwithLoader?: boolean
      • OptionalwithStaticAction?: boolean
      • OptionalwriteTransform?: (value: string | string[], name: string, data: Data, payload: Payload) => Value

    Returns {
        open: boolean;
        pickData: (param?: Param) => void;
        render: () => Element;
        setOpen: Dispatch<SetStateAction<boolean>>;
    }

    • The state and render functions.

Settings

Member Visibility