Skip to content

[No QA] Clarify pattern B errors behavior #47221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
trjExpensify merged 4 commits into from
Aug 14, 2024
Merged

[No QA] Clarify pattern B errors behavior #47221

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5b9806b
Clarify pattern B errors behavior
iwiznia Aug 12, 2024
ee22036
Update contributingGuides/OFFLINE_UX.md
iwiznia Aug 14, 2024
1c59e19
Update contributingGuides/OFFLINE_UX.md
iwiznia Aug 14, 2024
c967255
Update contributingGuides/OFFLINE_UX.md
iwiznia Aug 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion contributingGuides/OFFLINE_UX.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,12 @@ When the user is offline:

**Handling errors:**
- The [OfflineWithFeedback component](https://github.com/Expensify/App/blob/main/src/components/OfflineWithFeedback.js) already handles showing errors too, as long as you pass the error field in the [errors prop](https://github.com/Expensify/App/blob/128ea378f2e1418140325c02f0b894ee60a8e53f/src/components/OfflineWithFeedback.js#L29-L31)
- The behavior for when something fails is:
- If you were adding new data, the failed to add data is displayed greyed out and with the button to dismiss the error
- If you were deleting data, the failed data is displayed regularly with the button to dismiss the error
- If you are updating data, the original data is displayed regulary with the button to dismiss the error
- When dismissing the error, the `onClose` prop will be called, there we need to call an action that either:
- If the pendingAction was `delete`, it removes the data altogether
- If the pendingAction was `add`, it removes the data altogether
- Otherwise, it would clear the errors and `pendingAction` properties from the data
- We also need to show a Red Brick Road (RBR) guiding the user to the error. We need to manually do this for each piece of data using pattern B Optimistic WITH Feedback. Some common components like `MenuItem` already have a prop for it (`brickRoadIndicator`)
- A Brick Road is the pattern of guiding members towards places that require their attention by following a series of UI elements that have the same color
Expand Down