Skip to content
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.

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

[Feature Request]: Remove all-caps for all buttons on Android app and change to sentence case #5136

Closed
jlevick opened this issue Aug 21, 2023 · 7 comments · Fixed by #5157
Closed
Assignees
Labels
enhancement End user-perceivable enhancements. good first issue This item is good for new contributors to make their pull request. Impact: Low Low perceived user impact (e.g. edge cases). Work: Low Solution is clear and broken into good-first-issue-sized chunks.

Comments

@jlevick
Copy link

jlevick commented Aug 21, 2023

Is your feature request related to a problem? Please describe.

We are currently using all-caps for buttons (ex: CONTINUE, CANCEL) and the UX writing team, with the approval of the Android design team leads, would like to move forward with changing to sentence case (ex: Continue, Cancel, Ok, Submit, Close, Skip). This is for all buttons on the app.
Please see the updated Android style guide:

https://www.figma.com/file/G0jHrMaopFzk2ZksuynBjS/Android-style-guide?type=design&node-id=2-8412&mode=design&t=7wp6FDWE94kPhUVw-0

Describe the solution you'd like

Changing all-caps buttons to sentence case for all buttons on the Android app. Thank you!

Describe alternatives you've considered

No response

Additional context

If there is confusion on a specific button, please reach out to @jlevick.

@jlevick jlevick added enhancement End user-perceivable enhancements. triage needed labels Aug 21, 2023
@AbhishekPSingh07
Copy link

Can I work on this Issue

@jlevick
Copy link
Author

jlevick commented Aug 25, 2023

Hi @seanlip! Just confirming if I need to do anything else for this? Thank you!

@seanlip
Copy link
Member

seanlip commented Sep 1, 2023

@jlevick No, I think what you've written is fine. Thanks!

@AbhishekPSingh07 (or anyone else who'd like to take this up) -- per the guidance at https://github.com/oppia/oppia-android/wiki/Contributing-to-Oppia-android#3-pick-your-first-starter-issue, please provide an explanation of what your PR will do (with names of files you're changing, what you plan to change in each file, etc.). If it looks good, we can assign you to this issue. Please also follow the other instructions on that wiki page if you have not yet done so. Thanks!

@adhiamboperes adhiamboperes added Impact: Low Low perceived user impact (e.g. edge cases). Work: Medium The means to find the solution is clear, but it isn't at good-first-issue level yet. labels Sep 6, 2023
@theMr17
Copy link
Collaborator

theMr17 commented Sep 22, 2023

Hi @seanlip, I'd like to tackle this issue. I'll search for all button elements in the codebase and update android:textAllCaps to false. Will work on files which contains the button layouts. Thanks!

@adhiamboperes
Copy link
Collaborator

Hi @seanlip, I'd like to tackle this issue. I'll search for all button elements in the codebase and update android:textAllCaps to false. Will work on files which contains the button layouts. Thanks!

Hi,
The first step in resolving this is to make a list of all the buttons that we have that arr in all caps.
Can you do that and add it as a comment here. Please Indicate the screen/dialog.

@theMr17
Copy link
Collaborator

theMr17 commented Sep 22, 2023

@adhiamboperes Here is the list of all buttons in the app that are currently in all caps.

layout

Screen / Dialog Button ID
activity_input_interaction_view_test.xml submit_button
add_profile_activity.xml add_profile_activity_create_button
admin_auth_activity.xml admin_auth_submit_button
admin_pin_activity.xml submit_button
concept_card_fragment_test_activity.xml open_dialog_0 open_dialog_1
exploration_test_activity.xml play_exploration_button
hint_summary.xml reveal_hint_button
math_expression_parser_fragment.xml parse_math_expression_button
onboarding_slide_final.xml get_started_button
profile_list_control_buttons.xml learner_analytics_share_ids_and_events_button learner_analytics_upload_logs_now_button
profile_rename_fragment.xml profile_rename_save_button
profile_reset_pin_fragment.xml profile_reset_save_button
replay_button_item.xml replay_button
return_to_lesson_button_item.xml return_to_lesson_button
return_to_topic_button_item.xml return_to_topic_button
solution_summary.xml show_solution_button
state_fragment_test_activity.xml play_test_exploration_button
submit_button_item.xml submit_answer_button
topic_practice_footer_view.xml topic_practice_start_button
walkthrough_welcome_fragment.xml walkthrough_welcome_next_button

layout-land

Screen / Dialog Button ID
onboarding_slide_final.xml get_started_button
walkthrough_welcome_fragment.xml walkthrough_welcome_next_button

layout-sw600dp-land

Screen / Dialog Button ID
onboarding_slide_final.xml get_started_button

layout-sw600dp-port

Screen / Dialog Button ID
onboarding_slide_final.xml get_started_button

@adhiamboperes
Copy link
Collaborator

Thanks @the-mr17. Looks good, you can put up a PR for this.

@adhiamboperes adhiamboperes added Work: Low Solution is clear and broken into good-first-issue-sized chunks. and removed Work: Medium The means to find the solution is clear, but it isn't at good-first-issue level yet. labels Sep 22, 2023
@adhiamboperes adhiamboperes added the good first issue This item is good for new contributors to make their pull request. label Sep 23, 2023
adhiamboperes added a commit that referenced this issue Sep 30, 2023
<!-- 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 #5136

This PR changes all caps buttons to sentence case. All buttons mentioned
in this
[comment](#5136 (comment))
are changed either by directly changing its `android:textAllCaps` to
`false` in the layout files or by changing its style in the `styles.xml`
file.

## 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

## Screenshots

### _layout_

|Screen / Dialog|Button ID|Screenshots|
|--|--|--|
|`activity_input_interaction_view_test.xml`|`submit_button`|
|`add_profile_activity.xml`|`add_profile_activity_create_button`|
|`admin_auth_activity.xml`|`admin_auth_submit_button`|
|`admin_pin_activity.xml`|`submit_button`|
|`concept_card_fragment_test_activity.xml`|`open_dialog_0`
`open_dialog_1`|
|`exploration_test_activity.xml`|`play_exploration_button`|

|`hint_summary.xml`|`reveal_hint_button`|![image](https://github.com/oppia/oppia-android/assets/84731134/fa55e84f-df00-47fc-9064-6ba57dc91337)|

|`math_expression_parser_fragment.xml`|`parse_math_expression_button`|![image](https://github.com/oppia/oppia-android/assets/84731134/97678f0a-294f-40e9-a057-cd59843a07c9)|

|`onboarding_slide_final.xml`|`get_started_button`|![image](https://github.com/oppia/oppia-android/assets/84731134/44dab2e5-af61-42b6-a9be-977f0c3487a3)|

|`profile_list_control_buttons.xml`|`learner_analytics_share_ids_and_events_button`
`learner_analytics_upload_logs_now_button`|

|`profile_rename_fragment.xml`|`profile_rename_save_button`|![image](https://github.com/oppia/oppia-android/assets/84731134/6834670a-6225-45a1-a845-f41bc464a711)|
|`profile_reset_pin_fragment.xml`|`profile_reset_save_button`|
|`replay_button_item.xml`|`replay_button`|

|`return_to_lesson_button_item.xml`|`return_to_lesson_button`|![image](https://github.com/oppia/oppia-android/assets/84731134/fa55e84f-df00-47fc-9064-6ba57dc91337)|
|`return_to_topic_button_item.xml`|`return_to_topic_button`|
|`solution_summary.xml`|`show_solution_button`|
|`state_fragment_test_activity.xml`|`play_test_exploration_button`|

|`submit_button_item.xml`|`submit_answer_button`|![image](https://github.com/oppia/oppia-android/assets/84731134/eed9fb84-b4d8-4d65-a665-813c641debc5)|
|`topic_practice_footer_view.xml`|`topic_practice_start_button`|
|`walkthrough_welcome_fragment.xml`|`walkthrough_welcome_next_button`|

### _layout-land_
|Screen / Dialog|Button ID|Screenshots|
|--|--|--|

|`onboarding_slide_final.xml`|`get_started_button`|![image](https://github.com/oppia/oppia-android/assets/84731134/ce6df192-62ee-481b-83ea-49a56a4dfbe3)|
|`walkthrough_welcome_fragment.xml`|`walkthrough_welcome_next_button`|

### _layout-sw600dp-land_
|Screen / Dialog|Button ID|
|--|--|
|`onboarding_slide_final.xml`|`get_started_button`|

### _layout-sw600dp-port_
|Screen / Dialog|Button ID|
|--|--|
|`onboarding_slide_final.xml`|`get_started_button`|

<img
src="https://github.com/oppia/oppia-android/assets/84731134/23e8ebbb-386d-4dfa-bf4a-6e8354734245"
width="300"/>
<img
src="https://github.com/oppia/oppia-android/assets/84731134/e1358ff6-9e5e-4ae6-a9bc-44490f48d022"
width="300"/>
<img
src="https://github.com/oppia/oppia-android/assets/84731134/10c06098-0e4a-47a5-b7c3-988fc97073f2"
width="300"/>
<img
src="https://github.com/oppia/oppia-android/assets/84731134/08d9c601-8c46-430c-ba17-f7dbcd131d4a"
width="300"/>

---------

Co-authored-by: Adhiambo Peres <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement End user-perceivable enhancements. good first issue This item is good for new contributors to make their pull request. Impact: Low Low perceived user impact (e.g. edge cases). Work: Low Solution is clear and broken into good-first-issue-sized chunks.
Development

Successfully merging a pull request may close this issue.

5 participants