avo-hq/avo

Add a `reveal` field which can hide some text from the user until they hit the reveal button

Open

#2,168 opened on Dec 18, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Ruby (308 forks)user submission
FeatureGood first issueHelp wanted

Repository metrics

Stars
 (1,778 stars)
PR merge metrics
 (Avg merge 1d 6h) (67 merged PRs in 30d)

Description

This field would be rendered only on display fields (index and show).

My approach

It would show the value as a password and then have a button that would change the input type to text so the value becomes visible.

We need to ensure that the value is not clearly visible if the use inspects the DOM.

Contributor guide

Research direction
Study how Avo custom fields are implemented. Look at existing field components (e.g., password field) and how they render. Ensure the value is not exposed in DOM by using a placeholder or encrypted value and fetching the real value via AJAX on reveal. Consider using a stimulus controller or inline JavaScript to toggle the field type. Test the implementation in both index and show views.
Tech stack
rubyrails
Domain
backend
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitRubyRails
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70