Skip to content

Show field caption in schema config field list #7093

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

mark-pitblado
Copy link
Collaborator

Implements the feature request in this forum post. I can create a corresponding feature issue on GitHub if this is something the team wants (and if this feature is accepted overall).

Shows the field caption beside the database name in the schema config field list. To help the user distinguish between the database field name, the caption, and the hidden indicator, the list uses the following formatting.

databaseFieldName caption (hidden)

The caption in the field name list will change in real-time as it is entered in the caption input box, so the user learns the link between the two. Below is an example of how this feature is helpful when using an attribute or properties table.

image

Checklist

  • Self-review the PR after opening it to make sure the changes look good and
    self-explanatory (or properly documented)
  • Add relevant issue to release milestone
  • Add pr to documentation list
  • Add automated tests

Testing instructions

  • Open the schema config tool and see that there are now captions displayed beside the field name.
  • Change the caption for a field, and verify that the caption updates in real-time for the corresponding field in the field list.

All frontend tests have passed. I am not super familiar with TypeScript, so while functional, perhaps the typing could be further improved. Tested with Firefox 128.12.0 ESR

Shows the localized caption for fields in the field list. The database
field name is bolded, and the caption is italicized to allow for easy
differentiation.
@specifysoftware
Copy link

This pull request has been mentioned on Specify Community Forum. There might be relevant details there:

https://discourse.specifysoftware.org/t/have-the-caption-display-beside-the-database-name-in-the-schema-config/2701/4

@grantfitzsimmons grantfitzsimmons self-requested a review July 17, 2025 04:46
Copy link
Member

@grantfitzsimmons grantfitzsimmons left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love the idea behind this change– it would really make customizing the schema much easier!


it looks good in Firefox, but in Chrome, the HTML styling inside <option> elements is not consistently supported.

Firefox:
Image

Chrome:
Image


I'll let the @specify/developers offer guidance on how to implement this in a way that ensures consistent support across all browsers. Thanks for openign a PR to address this!

@github-project-automation github-project-automation bot moved this from 📋Back Log to Dev Attention Needed in General Tester Board Jul 17, 2025
@grantfitzsimmons grantfitzsimmons modified the milestone: 7.11.2 Jul 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Dev Attention Needed
Development

Successfully merging this pull request may close these issues.

4 participants