DataForm: Add customizable button text to panel modal#76099
Merged
Conversation
Adds optional applyButtonText and cancelButtonText properties to the PanelLayout configuration type, allowing consumers to customize the modal action button labels. This supports use cases like saving as the modal closes.
- Add type properties to PanelLayout and NormalizedPanelLayout
- Pass button text through normalization (defaults applied in component)
- Extract layout properties in PanelModal and pass to ModalContent
- Use custom text with i18n defaults (__('Apply') and __('Cancel'))
- Add storybook controls for testing both button label variations
- Set default openAs to 'modal' in LayoutPanel story
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Use || instead of ?? so empty strings fall back to default labels - Remove unnecessary `as NormalizedPanelLayout` cast since the discriminant check already narrows the type Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Size Change: +268 B (0%) Total Size: 6.87 MB
ℹ️ View Unchanged
|
Restructure the panel layout API so modal button labels are scoped
within the openAs configuration rather than being top-level properties.
openAs now accepts either a string ('dropdown' | 'modal') or an object
({ type: 'modal', applyLabel?, cancelLabel? }). Normalization flattens
the object form. Also adds unit tests and conditional storybook controls.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
oandregal
reviewed
Mar 3, 2026
…ption Restructure storybook so label controls are scoped to a dedicated 'modalConfig' openAs option. The component assembles the PanelOpenAsModal object from storybook args, keeping getPanelLayoutFromStoryArgs simple. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Flaky tests detected in a8fb533. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/22763961584
|
Instead of flattening PanelOpenAsModal into separate applyLabel/cancelLabel properties, keep openAs as 'dropdown' | 'modal' | PanelOpenAsModal on the normalized type. This scopes labels within the modal config consistently across both input and normalized types. Normalization becomes a simple passthrough with ?? 'dropdown' default. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
oandregal
reviewed
Mar 5, 2026
|
|
||
| export type EditVisibility = 'always' | 'on-hover'; | ||
|
|
||
| export type PanelOpenAsModal = { |
Member
There was a problem hiding this comment.
Does this need to be exported? Everything we export becomes public API for the types.
Contributor
Author
There was a problem hiding this comment.
It's being used in ModalContent now when destructuring the labels.
ntsekouras
reviewed
Mar 5, 2026
| onClose: () => void; | ||
| fieldLabel: string; | ||
| touched: boolean; | ||
| applyLabel?: string; |
Contributor
There was a problem hiding this comment.
Do we expect any other labels in DataForm components? I searched a bit and couldn't find any cases for labels right now, but that could affect the props (e.g. a labels object).
Contributor
Author
There was a problem hiding this comment.
Question for @oandregal perhaps. I've not come across more yet.
oandregal
reviewed
Mar 5, 2026
packages/dataviews/src/components/dataform-layouts/panel/modal.tsx
Outdated
Show resolved
Hide resolved
oandregal
reviewed
Mar 5, 2026
packages/dataviews/src/components/dataform-layouts/test/normalize-form.ts
Outdated
Show resolved
Hide resolved
oandregal
reviewed
Mar 5, 2026
packages/dataviews/src/components/dataform-layouts/panel/index.tsx
Outdated
Show resolved
Hide resolved
oandregal
reviewed
Mar 5, 2026
oandregal
reviewed
Mar 5, 2026
oandregal
added
the
[Feature] DataViews
Normalize openAs to objects (PanelOpenAsDropdown | PanelOpenAsModal) so consumers use openAs.type everywhere. ModalContent extracts labels from field.layout directly. Storybook simplified to default/dropdown/modal options with conditional label controls. Keep PanelOpenAsDropdown private, export PanelOpenAsModal for the modal component cast. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
oandregal
reviewed
Mar 6, 2026
| expect( result.layout ).toEqual( { | ||
| type: 'panel', | ||
| labelPosition: 'side', | ||
| openAs: { type: 'modal' }, |
Member
There was a problem hiding this comment.
Mentioned over at #76099 (comment) but this object should contain the default labels.
Member
There was a problem hiding this comment.
The idea of normalization is that this should not happen (incoming strings only contain empty characters, and the UI looks broken):
Contributor
Author
There was a problem hiding this comment.
🤔 I assumed it would be safer to have the defaults in the component rather than the normalization but missed the empty case. I believe the strings should be optional.
Contributor
Author
There was a problem hiding this comment.
Was on the fence whether to normalise the default strings, or leave in the modal component. I went with normalisation in a8fb533. Let me know if the previous way was preferred.
oandregal
reviewed
Mar 6, 2026
| export type PanelOpenAsModal = { | ||
| type: 'modal'; | ||
| applyLabel?: string; | ||
| cancelLabel?: string; |
Member
There was a problem hiding this comment.
What would you think of making the labels required?
Contributor
There was a problem hiding this comment.
Personally I think they are fine as optional.
…sent Normalization now trims whitespace and falls back to i18n defaults for applyLabel/cancelLabel, so buttons always have visible text. This makes PanelOpenAsModal labels required strings and simplifies modal rendering by removing runtime fallbacks. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
oandregal
approved these changes
Mar 6, 2026
Member
|
Thanks for the quick iterations, @mikejolley! |
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
3 participants
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.
What?
Adds optional
applyLabelandcancelLabelconfiguration to the DataForm panel modal layout'sopenAsconfig, allowing customization of modal action button labels.Why?
Some use cases need different button labels—for example, using "Save" instead of "Apply" when the modal closes after the action. This change enables that flexibility while maintaining backward compatibility with existing code that relies on the default "Apply" and "Cancel" labels.
How?
PanelOpenAsDropdownandPanelOpenAsModaltypes for the normalizedopenAsproperty — normalization always produces objects so consumers useopenAs.typeconsistentlyPanelLayout.openAs(input) still accepts strings ('dropdown' | 'modal') or an object ({ type: 'modal', applyLabel?, cancelLabel? })__('Apply')/__('Cancel')), ensuring labels are always present — consumers don't need runtime fallbacksPanelOpenAsModal.applyLabelandcancelLabelare required strings on the normalized typeModalContentextracts labels directly fromfield.layout— no prop drilling neededopenAsismodal)API example
Testing Instructions
npm run storybook:devmodalin the Controls panelTesting Instructions for Keyboard
Screenshots or screencast