[PR #4548] [MERGED] feat(sh-admin): introducing user guidance and error management helpers in admin dashboard #4848

Closed
opened 2026-03-17 02:20:51 +03:00 by kerem · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/hoppscotch/hoppscotch/pull/4548
Author: @joeljstephen
Created: 11/18/2024
Status: Merged
Merged: 11/22/2024
Merged by: @jamesgeorge007

Base: nextHead: feat/dashboard-error-management


📝 Commits (9)

  • 82b432e refactor: updated fallback component and main to handle backend network error
  • 8d074bd fix: resolved issue where logging out shows splash screen instead of login screen
  • eddee2c refactor: updated icon for header documentation button
  • 26cc4c9 feat: added new helpers in data sharing, smtp configs and pending invite sections
  • 98862b2 refactor: updated documentation links and subtitles to various helpers across the dashboard
  • 15af622 chore: improvements across various changes made in different components
  • 9b92612 chore: code improvements
  • e9c94ed refactor: better subtitles for different sections
  • 5890d45 fix: missing i18n titles

📊 Changes

12 files changed (+209 additions, -106 deletions)

View changed files

📝 packages/hoppscotch-sh-admin/locales/en.json (+8 -1)
📝 packages/hoppscotch-sh-admin/src/components.d.ts (+2 -0)
📝 packages/hoppscotch-sh-admin/src/components/app/Header.vue (+11 -0)
📝 packages/hoppscotch-sh-admin/src/components/settings/AuthProvider.vue (+10 -1)
📝 packages/hoppscotch-sh-admin/src/components/settings/DataSharing.vue (+20 -6)
📝 packages/hoppscotch-sh-admin/src/components/settings/SmtpConfiguration.vue (+17 -6)
📝 packages/hoppscotch-sh-admin/src/components/tokens/Overview.vue (+12 -3)
📝 packages/hoppscotch-sh-admin/src/components/users/InviteModal.vue (+29 -12)
📝 packages/hoppscotch-sh-admin/src/helpers/errors.ts (+9 -1)
📝 packages/hoppscotch-sh-admin/src/main.ts (+50 -41)
📝 packages/hoppscotch-sh-admin/src/pages/_.vue (+33 -32)
📝 packages/hoppscotch-sh-admin/src/pages/users/invited.vue (+8 -3)

📄 Description

Ticket

  • Closes HFE-662

Description

This PR enhances the error management and user guidance experience in the admin dashboard. It introduces multiple error management helpers to improve navigation and issue resolution. The improvements include an error splash screen when the dashboard is unable to connect to the backend, contextual helper bubbles in various sections, and relevant subtitles to describe features that may be unclear to users.

Objectives

  1. Implement an error splash screen on dashboard startup if the frontend is unable to connect to the backend

  2. Add helper bubbles in the following sections of the dashboard:

    • Header
    • Invite Modal in Users Section
    • Pending Invites
    • Auth provider configurations
    • Data sharing configurations
  3. Display informative subtitles in the following sections:

    • Pending Invites
    • Invite Modal
    • Infra Tokens

Screenshots

image

image

Checks

  • My pull request adheres to the code style of this project
  • My code requires changes to the documentation
  • I have updated the documentation as required
  • All tests have passed

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/hoppscotch/hoppscotch/pull/4548 **Author:** [@joeljstephen](https://github.com/joeljstephen) **Created:** 11/18/2024 **Status:** ✅ Merged **Merged:** 11/22/2024 **Merged by:** [@jamesgeorge007](https://github.com/jamesgeorge007) **Base:** `next` ← **Head:** `feat/dashboard-error-management` --- ### 📝 Commits (9) - [`82b432e`](https://github.com/hoppscotch/hoppscotch/commit/82b432e1fddbbe243bb8a056edafc145830986a5) refactor: updated fallback component and main to handle backend network error - [`8d074bd`](https://github.com/hoppscotch/hoppscotch/commit/8d074bdf095cc1798ec9fcc725a34e7ae73400a2) fix: resolved issue where logging out shows splash screen instead of login screen - [`eddee2c`](https://github.com/hoppscotch/hoppscotch/commit/eddee2c97cb3ca2919785b69c956bd1c862d4982) refactor: updated icon for header documentation button - [`26cc4c9`](https://github.com/hoppscotch/hoppscotch/commit/26cc4c9e9a80fe8650bee25b614c1c71395cc114) feat: added new helpers in data sharing, smtp configs and pending invite sections - [`98862b2`](https://github.com/hoppscotch/hoppscotch/commit/98862b2a2861e48b54ea977f5929bfb013a5b162) refactor: updated documentation links and subtitles to various helpers across the dashboard - [`15af622`](https://github.com/hoppscotch/hoppscotch/commit/15af6229688446d6cd89de669e2ddfacf29ca790) chore: improvements across various changes made in different components - [`9b92612`](https://github.com/hoppscotch/hoppscotch/commit/9b92612d3b28a6aeb9667dd0daf471e0dd8c22b8) chore: code improvements - [`e9c94ed`](https://github.com/hoppscotch/hoppscotch/commit/e9c94ed5e126dafafd75a79292b3da6eab6b910c) refactor: better subtitles for different sections - [`5890d45`](https://github.com/hoppscotch/hoppscotch/commit/5890d45ed1243ca44825f2d4f43b9f802928ce7e) fix: missing i18n titles ### 📊 Changes **12 files changed** (+209 additions, -106 deletions) <details> <summary>View changed files</summary> 📝 `packages/hoppscotch-sh-admin/locales/en.json` (+8 -1) 📝 `packages/hoppscotch-sh-admin/src/components.d.ts` (+2 -0) 📝 `packages/hoppscotch-sh-admin/src/components/app/Header.vue` (+11 -0) 📝 `packages/hoppscotch-sh-admin/src/components/settings/AuthProvider.vue` (+10 -1) 📝 `packages/hoppscotch-sh-admin/src/components/settings/DataSharing.vue` (+20 -6) 📝 `packages/hoppscotch-sh-admin/src/components/settings/SmtpConfiguration.vue` (+17 -6) 📝 `packages/hoppscotch-sh-admin/src/components/tokens/Overview.vue` (+12 -3) 📝 `packages/hoppscotch-sh-admin/src/components/users/InviteModal.vue` (+29 -12) 📝 `packages/hoppscotch-sh-admin/src/helpers/errors.ts` (+9 -1) 📝 `packages/hoppscotch-sh-admin/src/main.ts` (+50 -41) 📝 `packages/hoppscotch-sh-admin/src/pages/_.vue` (+33 -32) 📝 `packages/hoppscotch-sh-admin/src/pages/users/invited.vue` (+8 -3) </details> ### 📄 Description ### Ticket - Closes HFE-662 ### Description This PR enhances the error management and user guidance experience in the admin dashboard. It introduces multiple error management helpers to improve navigation and issue resolution. The improvements include an error splash screen when the dashboard is unable to connect to the backend, contextual helper bubbles in various sections, and relevant subtitles to describe features that may be unclear to users. ### Objectives 1. Implement an error splash screen on dashboard startup if the frontend is unable to connect to the backend 2. Add helper bubbles in the following sections of the dashboard: - [x] Header - [x] Invite Modal in Users Section - [x] Pending Invites - [x] Auth provider configurations - [x] Data sharing configurations 3. Display informative subtitles in the following sections: - [x] Pending Invites - [x] Invite Modal - [x] Infra Tokens ### Screenshots ![image](https://github.com/user-attachments/assets/e41b7375-88c8-4819-a140-0368c16422ea) ![image](https://github.com/user-attachments/assets/4801ff80-0145-44d2-be66-bf759ec08ae2) ### Checks <!-- Ensure your pull request passes the CI checks and complete the following fields as needed --> - [x] My pull request adheres to the code style of this project - [ ] My code requires changes to the documentation - [ ] I have updated the documentation as required - [x] All tests have passed --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
kerem 2026-03-17 02:20:51 +03:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/hoppscotch#4848
No description provided.