zeeguu / web

Frontend for the zeeguu web application.
https://www.zeeguu.org
5 stars 7 forks source link

Word review redesign #379

Closed tfnribeiro closed 4 months ago

tfnribeiro commented 4 months ago

Redesign of the Review Words page

Icons:

Introduced 5 new icons, one for the info boxes to make them slightly more distinct to incentivize reading them. The other 4 are two sets of + and - buttons to add and remove words.

Endpoints:

Added 2 endpoints to allow the frontend to update the bookmark fit for study flag: https://github.com/zeeguu/api/pull/150 (changes in the backend)

Review Words Screen

The review screen has been changed to more easily allow the user to review the words which will be added to the exercises. Currently, the user could get almost all the words they translated to be available to be added to the exercises, which can be somewhat overwhelming for a begginer.

To get around this, we have decided that in case there are more than 10 words translated, we will prioritize the ones that are the most common in target language (L2), as these are likely to be the ones the user will encounter most when reading texts.

The user can eventually add more words from the word list by toggling the Manage Words For Exercises. I decided to include this inside the Infobox to further bring focus to it. To ensure this is understandable for users, we include a clickable text that will make the Tell me why modal appear that explains how words are selected for studying.

I have also disabled the possibility of adding translations longer than 3 words, as these will not fit will with the current exercise selection.

All of these changes mean that we have moved away from using the Star to "prefer" words to study. Instead, now the star is used to indicate that a user wants to study that word but it's not show in the UI anymore, and it's only tracked on the backend. This means that each word preview is now composed of the Edit + Listen button, which should make the UI nicer to look at.

Less than 10 words review:

image

More than 10 words review

image

image

image

Tell me why modal

image

Edit Words Screen

Finally, since we have also removed the trashcan, we have now moved this functionality to be part of the Edit button. Now the form includes a Delete Word button, which will remove the translation for the user. I also include a checkbox that reveals the state of whether the word is being considered for exercises or not: Include Word in Exercises.

image

netlify[bot] commented 4 months ago

Deploy Preview for voluble-nougat-015dd1 ready!

Name Link
Latest commit 8682bff2b9e72388485adf958fdfe451631d7030
Latest deploy log https://app.netlify.com/sites/voluble-nougat-015dd1/deploys/66546d6d80d58200080607e2
Deploy Preview https://deploy-preview-379--voluble-nougat-015dd1.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

mircealungu commented 4 months ago

Ehi @tfnribeiro - I'm a bit lost in the state of the PRs. Please ping me explicitly when this needs to be reviewed again pls. Tak!

tfnribeiro commented 4 months ago

Ehi @tfnribeiro - I'm a bit lost in the state of the PRs. Please ping me explicitly when this needs to be reviewed again pls. Tak!

@mircealungu Maybe we should "close" this PR, as from the last conversation we considered using a new column in the back end to implement the user_preference (the star which would have 3 values: -1, 0, 1).

I will work on adding that field in backend and then re-open a PR aligned with that change?

mircealungu commented 4 months ago

Nice. Yes let's!

On Wed, 29 May 2024 at 09.26, Tiago Ribeiro @.***> wrote:

Ehi @tfnribeiro https://github.com/tfnribeiro - I'm a bit lost in the state of the PRs. Please ping me explicitly when this needs to be reviewed again pls. Tak!

@mircealungu https://github.com/mircealungu Maybe we should "close" this PR, as from the last conversation we considered using a new column in the back end to implement the user_preference (the star which would have 3 values: -1, 0, 1).

I will work on adding that field in backend and then re-open a PR aligned with that change?

— Reply to this email directly, view it on GitHub https://github.com/zeeguu/web/pull/379#issuecomment-2136632206, or unsubscribe https://github.com/notifications/unsubscribe-auth/AADRNBYLS2BT4O52CVZBXJ3ZEVYKJAVCNFSM6AAAAABIA7NQLOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMZWGYZTEMRQGY . You are receiving this because you were mentioned.Message ID: @.***>