[PR #4637] [MERGED] PM-17650 Implement custom tool tip state to prevent tool tips from dismissing. #5090

Closed
opened 2025-11-26 23:53:52 -06:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/bitwarden/android/pull/4637
Author: @dseverns-livefront
Created: 1/28/2025
Status: Merged
Merged: 1/28/2025
Merged by: @dseverns-livefront

Base: mainHead: coachmark-improvements


📝 Commits (1)

  • 6c4e588 PM-17650 Implement custom tool tip state to prevent tool tips from being dismissed when user clicks outside.

📊 Changes

15 files changed (+224 additions, -25 deletions)

View changed files

📝 app/src/main/java/com/x8bit/bitwarden/data/platform/repository/DebugMenuRepository.kt (+5 -0)
📝 app/src/main/java/com/x8bit/bitwarden/data/platform/repository/DebugMenuRepositoryImpl.kt (+5 -0)
📝 app/src/main/java/com/x8bit/bitwarden/ui/platform/components/coachmark/CoachMarkContainer.kt (+2 -4)
📝 app/src/main/java/com/x8bit/bitwarden/ui/platform/components/coachmark/CoachMarkScopeInstance.kt (+4 -4)
📝 app/src/main/java/com/x8bit/bitwarden/ui/platform/components/coachmark/CoachMarkState.kt (+6 -6)
📝 app/src/main/java/com/x8bit/bitwarden/ui/platform/components/coachmark/LazyListCoachMarkState.kt (+2 -0)
📝 app/src/main/java/com/x8bit/bitwarden/ui/platform/components/coachmark/model/CoachMarkHighlightState.kt (+2 -4)
app/src/main/java/com/x8bit/bitwarden/ui/platform/components/tooltip/BitwardenToolTipState.kt (+17 -0)
app/src/main/java/com/x8bit/bitwarden/ui/platform/components/tooltip/BitwardenToolTipStateImpl.kt (+112 -0)
📝 app/src/main/java/com/x8bit/bitwarden/ui/platform/feature/debugmenu/DebugMenuScreen.kt (+13 -0)
📝 app/src/main/java/com/x8bit/bitwarden/ui/platform/feature/debugmenu/DebugMenuViewModel.kt (+10 -0)
📝 app/src/main/res/values/strings_non_localized.xml (+1 -0)
📝 app/src/test/java/com/x8bit/bitwarden/data/platform/repository/DebugMenuRepositoryTest.kt (+17 -0)
📝 app/src/test/java/com/x8bit/bitwarden/ui/platform/feature/debugmenu/DebugMenuScreenTest.kt (+14 -4)
📝 app/src/test/java/com/x8bit/bitwarden/ui/platform/feature/debugmenu/DebugMenuViewModelTest.kt (+14 -3)

📄 Description

🎟️ Tracking

PM-17650

📔 Objective

  • Prevent the tool tip from being dismissed at all when user clicks outside.
  • Previous behavior it disappears and returns.
  • Overrides the default dismiss function of the tool tip state which is what the Google api calls under the hood to dismiss the tooltip when there is a click outside.
  • Added way to reset coach mark related card show values to be able to test the tours easier.

📸 Screenshots

https://github.com/user-attachments/assets/79268afa-5ea0-41a7-9d10-89e414ecdb5d

Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation or informed the documentation team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed
    issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

🔄 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/bitwarden/android/pull/4637 **Author:** [@dseverns-livefront](https://github.com/dseverns-livefront) **Created:** 1/28/2025 **Status:** ✅ Merged **Merged:** 1/28/2025 **Merged by:** [@dseverns-livefront](https://github.com/dseverns-livefront) **Base:** `main` ← **Head:** `coachmark-improvements` --- ### 📝 Commits (1) - [`6c4e588`](https://github.com/bitwarden/android/commit/6c4e588d32bf930ad0bc0b4bec2fba8e8508e80c) PM-17650 Implement custom tool tip state to prevent tool tips from being dismissed when user clicks outside. ### 📊 Changes **15 files changed** (+224 additions, -25 deletions) <details> <summary>View changed files</summary> 📝 `app/src/main/java/com/x8bit/bitwarden/data/platform/repository/DebugMenuRepository.kt` (+5 -0) 📝 `app/src/main/java/com/x8bit/bitwarden/data/platform/repository/DebugMenuRepositoryImpl.kt` (+5 -0) 📝 `app/src/main/java/com/x8bit/bitwarden/ui/platform/components/coachmark/CoachMarkContainer.kt` (+2 -4) 📝 `app/src/main/java/com/x8bit/bitwarden/ui/platform/components/coachmark/CoachMarkScopeInstance.kt` (+4 -4) 📝 `app/src/main/java/com/x8bit/bitwarden/ui/platform/components/coachmark/CoachMarkState.kt` (+6 -6) 📝 `app/src/main/java/com/x8bit/bitwarden/ui/platform/components/coachmark/LazyListCoachMarkState.kt` (+2 -0) 📝 `app/src/main/java/com/x8bit/bitwarden/ui/platform/components/coachmark/model/CoachMarkHighlightState.kt` (+2 -4) ➕ `app/src/main/java/com/x8bit/bitwarden/ui/platform/components/tooltip/BitwardenToolTipState.kt` (+17 -0) ➕ `app/src/main/java/com/x8bit/bitwarden/ui/platform/components/tooltip/BitwardenToolTipStateImpl.kt` (+112 -0) 📝 `app/src/main/java/com/x8bit/bitwarden/ui/platform/feature/debugmenu/DebugMenuScreen.kt` (+13 -0) 📝 `app/src/main/java/com/x8bit/bitwarden/ui/platform/feature/debugmenu/DebugMenuViewModel.kt` (+10 -0) 📝 `app/src/main/res/values/strings_non_localized.xml` (+1 -0) 📝 `app/src/test/java/com/x8bit/bitwarden/data/platform/repository/DebugMenuRepositoryTest.kt` (+17 -0) 📝 `app/src/test/java/com/x8bit/bitwarden/ui/platform/feature/debugmenu/DebugMenuScreenTest.kt` (+14 -4) 📝 `app/src/test/java/com/x8bit/bitwarden/ui/platform/feature/debugmenu/DebugMenuViewModelTest.kt` (+14 -3) </details> ### 📄 Description ## 🎟️ Tracking [PM-17650](https://bitwarden.atlassian.net/browse/PM-17650) <!-- Paste the link to the Jira or GitHub issue or otherwise describe / point to where this change is coming from. --> ## 📔 Objective - Prevent the tool tip from being dismissed at all when user clicks outside. - Previous behavior it disappears and returns. - Overrides the default `dismiss` function of the tool tip state which is what the Google api calls under the hood to dismiss the tooltip when there is a click outside. - Added way to reset coach mark related card show values to be able to test the tours easier. <!-- Describe what the purpose of this PR is, for example what bug you're fixing or new feature you're adding. --> ## 📸 Screenshots https://github.com/user-attachments/assets/79268afa-5ea0-41a7-9d10-89e414ecdb5d <!-- Required for any UI changes; delete if not applicable. Use fixed width images for better display. --> ## ⏰ Reminders before review - Contributor guidelines followed - All formatters and local linters executed and passed - Written new unit and / or integration tests where applicable - Used internationalization (i18n) for all UI strings - CI builds passed - Communicated to DevOps any deployment requirements - Updated any necessary documentation or informed the documentation team ## 🦮 Reviewer guidelines <!-- Suggested interactions but feel free to use (or not) as you desire! --> - 👍 (`:+1:`) or similar for great changes - 📝 (`:memo:`) or ℹ️ (`:information_source:`) for notes or general info - ❓ (`:question:`) for questions - 🤔 (`:thinking:`) or 💭 (`:thought_balloon:`) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion - 🎨 (`:art:`) for suggestions / improvements - ❌ (`:x:`) or ⚠️ (`:warning:`) for more significant problems or concerns needing attention - 🌱 (`:seedling:`) or ♻️ (`:recycle:`) for future improvements or indications of technical debt - ⛏ (`:pick:`) for minor or nitpick changes [PM-17650]: https://bitwarden.atlassian.net/browse/PM-17650?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2025-11-26 23:53:52 -06:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/android#5090