feat: add field description/help text support#94
Merged
ManukMinasyan merged 1 commit into3.xfrom Feb 27, 2026
Merged
Conversation
Add optional description property to custom field settings that renders as helper text below fields in end-user forms. Uses existing settings JSON column (no migration needed) and a FIELD_DESCRIPTION feature flag for consumers who don't want it. Closes #70
There was a problem hiding this comment.
Pull request overview
This PR adds support for optional description/help text on custom fields, addressing issue #70. The feature allows administrators to provide guidance to end users by adding descriptive text that appears below custom fields in forms. The implementation is feature-gated behind FIELD_DESCRIPTION (enabled by default) and leverages the existing JSON settings column to avoid database migrations.
Changes:
- Adds
FIELD_DESCRIPTIONfeature flag to control the availability of field descriptions - Extends
CustomFieldSettingsDatawith nullabledescriptionproperty - Adds Textarea input to field management form for admins to enter descriptions
- Renders descriptions as
helperTextin end-user forms when feature is enabled
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
src/Enums/CustomFieldsFeature.php |
Adds FIELD_DESCRIPTION enum case to feature system |
src/Data/CustomFieldSettingsData.php |
Adds nullable description property to settings DTO |
src/Filament/Management/Schemas/FieldForm.php |
Adds Textarea field for description input in admin management form with 255 char limit |
src/Filament/Integration/Base/AbstractFormComponent.php |
Conditionally renders description as helperText when feature enabled |
resources/lang/en/custom-fields.php |
Adds translation key for description label |
config/custom-fields.php |
Enables feature flag by default in config |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
descriptionproperty to custom field settings DTO (stored in existingsettingsJSON column -- no migration needed)helperTextbelow fields in end-user Filament formsTextareadescription input to the management form for adminsFIELD_DESCRIPTIONfeature flag (enabled by default)Closes #70
Test plan