@axelor/aos-mobile-error 6.4.0 → 6.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,3 +1,8 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Error
|
|
3
|
+
tags: Readme
|
|
4
|
+
---
|
|
5
|
+
|
|
1
6
|
<h1 align="center">@axelor/aos-mobile-error</h1>
|
|
2
7
|
|
|
3
8
|
<div align="center">
|
|
@@ -20,20 +25,26 @@ yarn add @axelor/aos-mobile-error
|
|
|
20
25
|
|
|
21
26
|
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.
|
|
22
27
|
|
|
23
|
-
The component needs the following props:
|
|
24
|
-
|
|
28
|
+
The component needs the following props:
|
|
29
|
+
|
|
30
|
+
- errorScreen : screen to be displayed when an error is detected
|
|
31
|
+
|
|
25
32
|
```typescript
|
|
26
33
|
errorScreen: ({errorMessage, onReloadPress}) => React.ReactNode;
|
|
27
34
|
```
|
|
28
|
-
|
|
35
|
+
|
|
36
|
+
- userIdfetcher : function to fetch user information
|
|
37
|
+
|
|
29
38
|
```typescript
|
|
30
39
|
userIdfetcher: () => Promise<any>;
|
|
31
40
|
```
|
|
32
|
-
|
|
41
|
+
|
|
42
|
+
- putMethod : function to perform a PUT request to the server in order to inform it of the error
|
|
43
|
+
|
|
33
44
|
```typescript
|
|
34
45
|
putMethod: (fetchOptions: {additionalURL: string; data: any}) => Promise<any>;
|
|
35
46
|
```
|
|
36
47
|
|
|
37
48
|
## Developpment
|
|
38
49
|
|
|
39
|
-
This package is developed as part of the Axelor Open Mobile application. To contribute, please go to the [Github project](https://github.com/axelor/axelor-mobile) and follow the guidelines. You will also find an installation guide to help you configure your environment.
|
|
50
|
+
This package is developed as part of the Axelor Open Mobile application. To contribute, please go to the [Github project](https://github.com/axelor/axelor-mobile) and follow the guidelines. You will also find an installation guide to help you configure your environment.
|