@axelor/aos-mobile-error
v8.2.5
Published
--- title: Error tags: Readme ---
Downloads
1,795
Readme
title: Error tags: Readme
Presentation
This package was developed for the Axelor Open Mobile application.
It only contains an ErrorBoundary component compatible with all React v18.2.x projects linked to an ERP based on Axelor Open Platform.
Usage
Install the library :
yarn add @axelor/aos-mobile-error
All you have to do here is to wrap your application component with the ErrorBoundary component. It will catch all render errors and display the errorScreen provided to allow user to reload the application.
The component needs the following props:
- errorScreen : screen to be displayed when an error is detected
errorScreen: ({errorMessage, onReloadPress}) => React.ReactNode;
- userIdfetcher : function to fetch user information
userIdfetcher: () => Promise<any>;
- putMethod : function to perform a PUT request to the server in order to inform it of the error
putMethod: (fetchOptions: {additionalURL: string; data: any}) => Promise<any>;
Developpment
This package is developed as part of the Axelor Open Mobile application. To contribute, please go to the Github project and follow the guidelines. You will also find an installation guide to help you configure your environment.