Skip to content

fix: attach "always" renderer panels to DOM during fromJSON #1109

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
mathuo merged 2 commits into from
Feb 16, 2026
Merged

fix: attach "always" renderer panels to DOM during fromJSON #1109

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
6691485
fix: attach "always" renderer panels to DOM during fromJSON
mathuo Feb 16, 2026
883d488
fix: use panel.api.renderer instead of panel.renderer
mathuo Feb 16, 2026
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
124 changes: 124 additions & 0 deletions packages/dockview-core/src/__tests__/dockview/dockviewComponent.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8326,4 +8326,128 @@ describe('dockviewComponent', () => {
expect(panel1.group.api.width).toBe(400);
});
});

describe('renderer: always with fromJSON', () => {
test('inactive panel with defaultRenderer="always" is attached to DOM after fromJSON', () => {
dockview = new DockviewComponent(container, {
createComponent(options) {
switch (options.name) {
case 'default':
return new PanelContentPartTest(
options.id,
options.name
);
default:
throw new Error(`unsupported`);
}
},
defaultRenderer: 'always',
});
dockview.layout(1000, 1000);

dockview.fromJSON({
activeGroup: 'group-1',
grid: {
root: {
type: 'branch',
data: [
{
type: 'leaf',
data: {
views: ['panel1', 'panel2'],
id: 'group-1',
activeView: 'panel1',
},
size: 1000,
},
],
size: 1000,
},
height: 1000,
width: 1000,
orientation: Orientation.HORIZONTAL,
},
panels: {
panel1: {
id: 'panel1',
contentComponent: 'default',
title: 'panel1',
},
panel2: {
id: 'panel2',
contentComponent: 'default',
title: 'panel2',
},
},
});

const panel1 = dockview.getGroupPanel('panel1')!;
const panel2 = dockview.getGroupPanel('panel2')!;

expect(panel1.api.isActive).toBe(true);
expect(panel2.api.isActive).toBe(false);

// Both panels should use "always" renderer via defaultRenderer
expect(panel1.api.renderer).toBe('always');
expect(panel2.api.renderer).toBe('always');

// The inactive panel's content should be attached to the DOM
// (via the overlay render container)
expect(panel2.view.content.element.parentElement).toBeTruthy();
});

test('inactive panel with per-panel renderer="always" is attached to DOM after fromJSON', () => {
dockview.layout(1000, 1000);

dockview.fromJSON({
activeGroup: 'group-1',
grid: {
root: {
type: 'branch',
data: [
{
type: 'leaf',
data: {
views: ['panel1', 'panel2'],
id: 'group-1',
activeView: 'panel1',
},
size: 1000,
},
],
size: 1000,
},
height: 1000,
width: 1000,
orientation: Orientation.HORIZONTAL,
},
panels: {
panel1: {
id: 'panel1',
contentComponent: 'default',
title: 'panel1',
renderer: 'onlyWhenVisible',
},
panel2: {
id: 'panel2',
contentComponent: 'default',
title: 'panel2',
renderer: 'always',
},
},
});

const panel1 = dockview.getGroupPanel('panel1')!;
const panel2 = dockview.getGroupPanel('panel2')!;

expect(panel1.api.isActive).toBe(true);
expect(panel2.api.isActive).toBe(false);

expect(panel1.api.renderer).toBe('onlyWhenVisible');
expect(panel2.api.renderer).toBe('always');

// The inactive "always" panel's content should be attached to the DOM
expect(panel2.view.content.element.parentElement).toBeTruthy();
});
});
});
2 changes: 2 additions & 0 deletions packages/dockview-core/src/dockview/dockviewGroupPanelModel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -873,6 +873,8 @@ export class DockviewGroupPanelModel

if (!options.skipSetActive) {
this.contentContainer.openPanel(panel);
} else if (panel.api.renderer === 'always') {
this.contentContainer.renderPanel(panel, { asActive: false });
}

if (hasExistingPanel) {
Expand Down
Loading