useTrixtaAction

React hook used to interact with a Trixta action for a given roleName.

import { useTrixtaAction } from '@trixtateam/trixta-js-core';
const { 
hasRoleAccess,
isInProgress,
hasResponse,
loading,
latestInstance,
response,
submitTrixtaAction,
clearActionResponses,
} = useTrixtaAction<TSuccessType,TErrorType>({ roleName:"",
  actionName:"",
  actionParameters:{
    data:{},
    extraData:{},
    timeout:1500,
    timeoutEvent:"",
    loadingStatusRef:"",
    requestEvent:"",
    responseEvent:"",
    errorEvent:""
  },
  loadingStatusRef:"",
  options: {
    debugMode: false,
    autoSubmit: false,
    setTimeoutEventAsErrorEvent: false,
    clearResponsesOnCallback: false,
  },
  onSuccess:(success)=>{},
  onError:(errror)=>{}
   });

Options

• roleName : string

  • Required

  • Trixta role name

• actionName : string

  • Required

  • Trixta action name

• actionParameters: see related submitTrixtaActionResponse parameters

• loadingStatusRef: string

  • Optional

  • Optional value to change the default isInProgress behaviour for when submitting actions. If you plan to use the same action name for the same role, on the same screen, this is when you would make use of this * property

• options: { debugMode, autoSubmit, setTimeoutEventAsErrorEvent, clearResponsesOnCallback }

  • debugMode: boolean

    • Optional

    • Defaults to false.

    • If set to true, enables Trixta console debugging

  • autoSubmit: boolean

    • Optional

    • Defaults to false.

    • If set to true, hook will submit actionParameters to actionName when the component mounts.

  • setTimeoutEventAsErrorEvent: boolean

    • Optional

    • Defaults to false.

    • If set to true, will set the actionParameters timeoutEvent to be the same as the errorEvent

  • clearResponsesOnCallback: boolean

    • Optional

    • Defaults to false.

    • If set to true, will clear all responses when onSuccess or onError callbacks are called returning a value true.

• onSuccess : (success: TSuccessType) => void|boolean

  • Optional

  • This function will fire any time a successful response is received from Trixta.

  • If you return true and clearResponsesOnCallback is true, all responses will be cleared.

• onError : (error: TErrorType) => void|boolean

  • Optional

  • This function will fire any time an error response is received from Trixta.

  • If you return true and clearResponsesOnCallback is true, all responses will be cleared.

Returns

• hasRoleAccess : boolean

  • Will be true if the roleName has access for this user.

• isInProgress : boolean

  • Will be true if there is no response yet after calling submitTrixtaActionResponse or submitTrixtaAction.

  • Will be false if there is a response after calling submitTrixtaActionResponse or submitTrixtaAction

• hasResponse : boolean

  • Will be true if there is at least one Trixta Instance response.

• loading : boolean

  • Will be true if the action is waiting to be loaded.

• response : TrixtaInstanceResponse

  • First or most recent Trixta instance response

• latestInstance : TrixtaInstance

  • First or most recent Trixta instance

• submitTrixtaAction : (parameters: SubmitTrixtaFunctionParameters) => void

  • This function will submit a request for the given roleName and actionName

• clearActionResponses : () => void

  • This function will clear and reset responses for the given roleName and actionName.