Add RTL capabilities to the spotlight screens #4453
Assignees
Labels
Impact: Medium
Moderate perceived user impact (non-blocking bugs and general improvements).
Issue: Needs Clarification
Indicates that an issue needs more detail in order to be able to be acted upon.
Z-ibt
Temporary label for Ben to keep track of issues he's triaged.
Comments
Broppia
added
issue_type_infrastructure
Impact: Low
BenHenning
added
Impact: Medium
6 tasks
BenHenning
added a commit
that referenced
this issue
Nov 22, 2022
…nctionality (#4699) <!-- READ ME FIRST: Please fill in the explanation section below and check off every point from the Essential Checklist! --> ## Explanation <!-- - Explain what your PR does. If this PR fixes an existing bug, please include - "Fixes #bugnum:" in the explanation so that GitHub can auto-close the issue - when this PR is merged. --> fixes #4452 fixes #4453 fixes #4454 fixes #4455 fixes #4456 fixes #4457 fixes #4458 fixes #4459 This PR introduces the SpotlightFragment into the codebase, which is essentially a powerful, robust API that can highlight or 'spotlight' certain parts of the UI to create an onboarding experience for the same. We introduce the [Spotlight library](https://github.com/TakuSemba/Spotlight) into the codebase handles the highlighting of certain elements on screen. The work done in this PR augments the functionality of the library, by dynamically adding arrows and hints which create an over-all Spotlight onboarding experience to the app, beautifully surfacing some functionalities of the app to a new user. We also work on making sure that the spotlight is only shown to a user only once - the protocol buffers are used to save which spotlight has already been seen. The purpose of this PR is to introduce an API that the future contributors can use to seamlessly integrate spotlights onto UI elements as and when needed, with minimal coding. This PR also implements spotlights for the onboarding, home, topic and exploration screens that are required at this time. For accessibility, the content descriptions of all the elements on which spotlights are required today are updated. If talkback is turned on, the spotlights will not show up. The entire spotlight functionality is also gated behind a feature flag. This entire PR is backed by tests. ## Essential Checklist <!-- Please tick the relevant boxes by putting an "x" in them. --> - [x] The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of #bugnum: ...".) - [x] Any changes to [scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets) files have their rationale included in the PR explanation. - [x] The PR follows the [style guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide). - [x] The PR does not contain any unnecessary code changes from Android Studio ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)). - [x] The PR is made from a branch that's **not** called "develop" and is up-to-date with "develop". - [x] The PR is **assigned** to the appropriate reviewers ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)). ## For UI-specific PRs only <!-- Delete these section if this PR does not include UI-related changes. --> If your PR includes UI-related changes, then: - Add screenshots for portrait/landscape for both a tablet & phone of the before & after UI changes - For the screenshots above, include both English and pseudo-localized (RTL) screenshots (see [RTL guide](https://github.com/oppia/oppia-android/wiki/RTL-Guidelines)) - Add a video showing the full UX flow with a screen reader enabled (see [accessibility guide](https://github.com/oppia/oppia-android/wiki/Accessibility-(A11y)-Guide)) - Add a screenshot demonstrating that you ran affected Espresso tests locally & that they're passing Co-authored-by: Ben Henning <ben@oppia.org> Co-authored-by: madhurgera2 <76070586+madhurgera2@users.noreply.github.com> Co-authored-by: JishnuGoyal <jiahnugoyal007@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Is your feature request related to a problem? Please describe.
The spotlight screens do not properly handle RTL correctly. The arrow placement is not correct and the spotlight overlay hint overflows out of the screen.
The text was updated successfully, but these errors were encountered: