Skip to content

[Embeddable Rebuild] Fix panel title sync with saved object when using defaultTitle #225237

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.

Sign up for GitHub

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

Merged
olapawlus merged 2 commits into from
Jun 26, 2025
Merged

[Embeddable Rebuild] Fix panel title sync with saved object when using defaultTitle #225237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd4b982
[Embeddable Rebuild] Fix panel title sync with saved object when usin…
olapawlus Jun 25, 2025
76b8a34
adding test case for panel title on apply matching default title
olapawlus Jun 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions ...ntation_panel/public/panel_actions/customize_panel_action/customize_panel_editor.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,17 @@ describe('customize panel editor', () => {
expect(titleInput).toHaveValue('Default title');
});

// Even if the input value matches defaultTitle on apply, we expect setTitle(undefined) to be called, meaning the title is treated as "not customized".
it('should not set panel custom title if it matches default title on apply', async () => {
api.defaultTitle$ = new BehaviorSubject<string | undefined>('Default title');
renderPanelEditor();
const titleInput = screen.getByTestId('customEmbeddablePanelTitleInput');
expect(titleInput).toHaveValue('Default title');
await userEvent.click(screen.getByTestId('saveCustomizePanelButton'));
expect(setTitle).toHaveBeenCalledWith(undefined);
expect(api.title$?.getValue()).toBeUndefined();
});

it('should use title even when empty string', () => {
api.defaultTitle$ = new BehaviorSubject<string | undefined>('Default title');
setTitle('');
Expand Down
8 changes: 7 additions & 1 deletion ...presentation_panel/public/panel_actions/customize_panel_action/customize_panel_editor.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,13 @@ export const CustomizePanelEditor = ({
const dateFormat = useMemo(() => core.uiSettings.get<string>(UI_SETTINGS.DATE_FORMAT), []);

const save = () => {
if (panelTitle !== api.title$?.value) api.setTitle?.(panelTitle);
// If the panel title matches the default title, we set api.title to undefined to indicate there's no custom title.
// This ensures the panel stays in sync with the centrally saved object's title and reflects any updates to its title.
if (panelTitle === api?.defaultTitle$?.value) {
Copy link
Copy Markdown
Contributor

@nreese nreese Jun 25, 2025

Choose a reason for hiding this comment

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

Can you add a test case to src/platform/plugins/private/presentation_panel/public/panel_actions/customize_panel_action/customize_panel_editor.test.tsx for this case?

Copy link
Copy Markdown
Member Author

@olapawlus olapawlus Jun 25, 2025

Choose a reason for hiding this comment

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

Of course, thanks for catching that!

api.setTitle?.(undefined);
} else if (panelTitle !== api.title$?.value) {
api.setTitle?.(panelTitle);
}
if (hideTitle !== api.hideTitle$?.value) api.setHideTitle?.(hideTitle);
if (panelDescription !== api.description$?.value) api.setDescription?.(panelDescription);

Expand Down