keystonejs/keystone-classic

Field Note Not Displaying

Open

#4327 opened on May 24, 2017

View on GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (14,656 stars) (2,288 forks)batch import
bughelp wantedneeds reproduction

Description

Expected behavior

Adding the "note" option to a field in a model results in that note being displayed near the field in the Admin UI.

Actual/Current behavior

Adding the "note" option to a field in a model does not do anything visible.

Steps to reproduce the actual/current behavior

Add a "note" to a field in a model and then go to the Admin UI and you will see that the note has not appeared.

Environment

Keystone is being run on the Powershell on a Windows 10 machine. Not sure what else you'd need to know.

Software Version
Keystone 4.0.0-beta.5
Node v7.4.0

Contributor guide

Tech stack
javascriptnodejs
Domain
frontend
Issue type
bug
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.
clear
Prerequisites
Understanding of Keystone field definitionsBasic JavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
Investigate the Admin UI field rendering code, likely in the `admin/` or `fields/` directories. The 'note' option should be passed to the field template and displayed near the field. Check if the note is being ignored in the render function or if there is a missing template variable. Look at the base field component or template for how notes are handled. Also check if the note option is documented correctly.