TandoorRecipes/recipes

Ingredient Notes Rework

Open

#455 opened on Feb 24, 2021

View on GitHub
 (26 comments) (6 reactions) (0 assignees)HTML (4,470 stars) (500 forks)batch import
backendenhancementfrontendgood first issue

Description

Is your feature request related to a problem? Please describe. It's kind of a pain when cooking to hover over the comment icon to see the note.

Describe the solution you'd like It would be cool to have notes that are under x amount of characters just display text. For example, if you just want to specify "softened" for butter, then it would just show up as "butter, softened". But if you want to say something longer, like "Make sure the bananas are very ripe", then the current hover system would be used.

Describe alternatives you've considered Text wrapping could also be a viable solution. Maybe a user setting that will toggle between hovering and wrapping.

Additional context Mostly a QoL feature, but for me, the minimal amount of interaction I can make with the computer while cooking, the better.

Example: d2d313e58aee8b47f5c547dad01d1d28

Contributor guide

Tech stack
pythondjangohtmlcssjavascript
Domain
frontendbackend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic knowledge of Django templatesJavaScript for hover behaviorFamiliarity with the recipe detail view
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate how ingredient notes are currently stored in the model (likely in the Ingredient model) and rendered in the recipe detail template (e.g., templates/recipes/detail.html). The feature requires modifying the display logic to check note length and conditionally show inline text or hover. Consider implementing a user setting as mentioned in the comments. Look at the existing 'note' field and any related template tags or JavaScript functions that handle hover behavior. The PR or comments may contain further design suggestions.