Skip to content

Commit

Permalink
Merge pull request #409 from mathuo/397-gready-rendering-mode
Browse files Browse the repository at this point in the history 
feat: rename rendering modes
  • Loading branch information
@mathuo
mathuo authored Dec 26, 2023
2 parents 450e37f + 36dd190 commit 343d42c
Show file tree
Hide file tree
Showing 8 changed files with 45 additions and 45 deletions.
6 changes: 3 additions & 3 deletions packages/dockview-core/src/__tests__/dockview/components/panel/content.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ describe('contentContainer', () => {

const dockviewComponent = jest.fn<DockviewComponent, []>(() => {
return {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as DockviewComponent;
});

Expand All @@ -81,7 +81,7 @@ describe('contentContainer', () => {
view: {
content: contentRenderer,
} as Partial<IDockviewPanelModel>,
api: { renderer: 'destructive' },
api: { renderer: 'onlyWhenVisibile' },
} as Partial<IDockviewPanel>;

cut.openPanel(panel as IDockviewPanel);
Expand Down Expand Up @@ -116,7 +116,7 @@ describe('contentContainer', () => {
view: {
content: contentRenderer2,
} as Partial<IDockviewPanelModel>,
api: { renderer: 'destructive' },
api: { renderer: 'onlyWhenVisibile' },
} as Partial<IDockviewPanel>;

cut.openPanel(panel2 as IDockviewPanel);
Expand Down
46 changes: 23 additions & 23 deletions packages/dockview-core/src/__tests__/dockview/dockviewGroupPanelModel.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -258,13 +258,13 @@ describe('groupview', () => {

test('panel events are captured during de-serialization', () => {
const panel1 = new TestPanel('panel1', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any);
const panel2 = new TestPanel('panel2', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any);
const panel3 = new TestPanel('panel3', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any);

const groupview2 = new DockviewGroupPanel(dockview, 'groupview-2', {
Expand Down Expand Up @@ -350,13 +350,13 @@ describe('groupview', () => {
);

const panel1 = new TestPanel('panel1', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any);
const panel2 = new TestPanel('panel2', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any);
const panel3 = new TestPanel('panel3', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any);

expect(events.length).toBe(0);
Expand Down Expand Up @@ -436,13 +436,13 @@ describe('groupview', () => {

test('moveToPrevious and moveToNext', () => {
const panel1 = new TestPanel('panel1', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any);
const panel2 = new TestPanel('panel2', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any);
const panel3 = new TestPanel('panel3', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any);

groupview.model.openPanel(panel1);
Expand Down Expand Up @@ -488,13 +488,13 @@ describe('groupview', () => {

test('closeAllPanels with panels', () => {
const panel1 = new TestPanel('panel1', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any);
const panel2 = new TestPanel('panel2', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any);
const panel3 = new TestPanel('panel3', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any);

groupview.model.openPanel(panel1);
Expand Down Expand Up @@ -601,23 +601,23 @@ describe('groupview', () => {
.item(0)!.childNodes;

const panel1 = new TestPanel('id_1', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any);

cut.openPanel(panel1);
expect(contentContainer.length).toBe(1);
expect(contentContainer.item(0)).toBe(panel1.view.content.element);

const panel2 = new TestPanel('id_2', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any);

cut.openPanel(panel2);
expect(contentContainer.length).toBe(1);
expect(contentContainer.item(0)).toBe(panel2.view.content.element);

const panel3 = new TestPanel('id_2', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any);

cut.openPanel(panel3, { skipSetPanelActive: true });
Expand Down Expand Up @@ -822,7 +822,7 @@ describe('groupview', () => {

cut.openPanel(
new TestPanel('panel1', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any)
);

Expand Down Expand Up @@ -892,12 +892,12 @@ describe('groupview', () => {

cut.openPanel(
new TestPanel('panel1', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any)
);
cut.openPanel(
new TestPanel('panel2', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any)
);

Expand Down Expand Up @@ -967,12 +967,12 @@ describe('groupview', () => {

cut.openPanel(
new TestPanel('panel1', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any)
);
cut.openPanel(
new TestPanel('panel2', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any)
);

Expand Down Expand Up @@ -1077,7 +1077,7 @@ describe('groupview', () => {

cut.openPanel(
new TestPanel('panel1', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any)
);

Expand All @@ -1091,7 +1091,7 @@ describe('groupview', () => {

cut.openPanel(
new TestPanel('panel2', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any)
);

Expand All @@ -1113,7 +1113,7 @@ describe('groupview', () => {

cut.openPanel(
new TestPanel('panel1', {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
} as any)
);

Expand Down
12 changes: 6 additions & 6 deletions packages/dockview-core/src/__tests__/dockview/dockviewPanel.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ describe('dockviewPanel', () => {
const model = <IDockviewPanelModel>new panelModelMock();

const cut = new DockviewPanel('fake-id', accessor, api, group, model, {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
});

let latestTitle: string | undefined = undefined;
Expand Down Expand Up @@ -77,7 +77,7 @@ describe('dockviewPanel', () => {
const model = <IDockviewPanelModel>new panelModelMock();

const cut = new DockviewPanel('fake-id', accessor, api, group, model, {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
});

cut.init({ title: 'myTitle', params: {} });
Expand Down Expand Up @@ -114,7 +114,7 @@ describe('dockviewPanel', () => {
const model = <IDockviewPanelModel>new panelModelMock();

const cut = new DockviewPanel('fake-id', accessor, api, group, model, {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
});

cut.init({ params: {}, title: 'title' });
Expand Down Expand Up @@ -148,7 +148,7 @@ describe('dockviewPanel', () => {
const model = <IDockviewPanelModel>new panelModelMock();

const cut = new DockviewPanel('fake-id', accessor, api, group, model, {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
});

expect(cut.params).toEqual(undefined);
Expand Down Expand Up @@ -186,7 +186,7 @@ describe('dockviewPanel', () => {
const model = <IDockviewPanelModel>new panelModelMock();

const cut = new DockviewPanel('fake-id', accessor, api, group, model, {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
});

cut.api.setSize({ height: 123, width: 456 });
Expand Down Expand Up @@ -219,7 +219,7 @@ describe('dockviewPanel', () => {
const model = <IDockviewPanelModel>new panelModelMock();

const cut = new DockviewPanel('fake-id', accessor, api, group, model, {
renderer: 'destructive',
renderer: 'onlyWhenVisibile',
});

cut.init({ params: { a: '1', b: '2' }, title: 'A title' });
Expand Down
2 changes: 1 addition & 1 deletion packages/dockview-core/src/dockview/components/greadyRenderContainer.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { getDomNodePagePosition, toggleClass } from '../../dom';
import { CompositeDisposable, Disposable, IDisposable } from '../../lifecycle';
import { IDockviewPanel } from '../dockviewPanel';

export type DockviewPanelRenderer = 'destructive' | 'gready';
export type DockviewPanelRenderer = 'onlyWhenVisibile' | 'always';

export interface IRenderable {
readonly element: HTMLElement;
Expand Down
10 changes: 5 additions & 5 deletions packages/dockview-core/src/dockview/components/panel/content.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ export class ContentContainer
let container: HTMLElement;

switch (panel.api.renderer) {
case 'destructive':
case 'onlyWhenVisibile':
this.accessor.greadyRenderContainer.remove(panel);
if (isActive) {
if (this.panel) {
Expand All @@ -135,7 +135,7 @@ export class ContentContainer
}
container = this._element;
break;
case 'gready':
case 'always':
if (
panel.view.content.element.parentElement === this._element
) {
Expand Down Expand Up @@ -199,14 +199,14 @@ export class ContentContainer
let container: HTMLElement;

switch (renderer) {
case 'gready':
case 'always':
container =
this.accessor.greadyRenderContainer.setReferenceContentContainer(
panel,
this
);
break;
case 'destructive':
case 'onlyWhenVisibile':
this._element.appendChild(this.panel.view.content.element);
container = this._element;
break;
Expand Down Expand Up @@ -242,7 +242,7 @@ export class ContentContainer

public closePanel(): void {
if (this.panel) {
if (this.accessor.options.defaultRenderer === 'destructive') {
if (this.accessor.options.defaultRenderer === 'onlyWhenVisibile') {
this._element.removeChild(this.panel.view.content.element);
}
this.panel = undefined;
Expand Down
2 changes: 1 addition & 1 deletion packages/dockview-core/src/dockview/dockviewComponent.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ export class DockviewComponent
}

get renderer(): DockviewPanelRenderer {
return this.options.defaultRenderer ?? 'destructive';
return this.options.defaultRenderer ?? 'onlyWhenVisibile';
}

constructor(options: DockviewComponentOptions) {
Expand Down
6 changes: 3 additions & 3 deletions packages/docs/sandboxes/demo-dockview/src/app.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,9 @@ const components = {
<button
onClick={() => {
setMode(
mode === 'destructive'
? 'gready'
: 'destructive'
mode === 'onlyWhenVisibile'
? 'always'
: 'onlyWhenVisibile'
);
}}
>
Expand Down
6 changes: 3 additions & 3 deletions packages/docs/sandboxes/rendermode-dockview/src/app.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ const components = {
<button
onClick={() => {
setMode(
mode === 'destructive'
? 'gready'
: 'destructive'
mode === 'onlyWhenVisibile'
? 'always'
: 'onlyWhenVisibile'
);
}}
>
Expand Down

0 comments on commit 343d42c

Please sign in to comment.