rei-mirrors/dockview
1
0
Fork 0
mirror of https://github.com/mathuo/dockview synced 2025-02-02 22:45:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(typo): onlyWhenVisibile -> onlyWhenVisible

Browse Source
This commit is contained in:
Floyd Wang 2024-02-27 19:29:54 +08:00
parent 9ee00ab423
commit 0d34d7285e
9 changed files with 186 additions and 779 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
packages/dockview-core/src/__tests__/dockview/components/panel/content.spec.ts
View File

@ -68,7 +68,7 @@ describe('contentContainer', () => {
const cut = new ContentContainer(
fromPartial<DockviewComponent>({
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
overlayRenderContainer,
}),
fromPartial<DockviewGroupPanelModel>({
@ -91,7 +91,7 @@ describe('contentContainer', () => {
view: {
content: contentRenderer,
},
api: { renderer: 'onlyWhenVisibile' },
api: { renderer: 'onlyWhenVisible' },
});
cut.openPanel(panel as IDockviewPanel);
@ -126,7 +126,7 @@ describe('contentContainer', () => {
view: {
content: contentRenderer2,
} as Partial<IDockviewPanelModel>,
api: { renderer: 'onlyWhenVisibile' },
api: { renderer: 'onlyWhenVisible' },
} as Partial<IDockviewPanel>;
cut.openPanel(panel2 as IDockviewPanel);
@ -153,7 +153,7 @@ describe('contentContainer', () => {
disposable.dispose();
});
test("that panels renderered as 'onlyWhenVisibile' are removed when closed", () => {
test("that panels renderered as 'onlyWhenVisible' are removed when closed", () => {
const overlayRenderContainer = fromPartial<OverlayRenderContainer>({
detatch: jest.fn(),
});
@ -169,14 +169,14 @@ describe('contentContainer', () => {
const panel1 = fromPartial<IDockviewPanel>({
api: {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
},
view: { content: new TestContentRenderer('panel_1') },
});
const panel2 = fromPartial<IDockviewPanel>({
api: {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
},
view: { content: new TestContentRenderer('panel_2') },
});

46
packages/dockview-core/src/__tests__/dockview/dockviewGroupPanelModel.spec.ts
View File

@ -266,13 +266,13 @@ describe('dockviewGroupPanelModel', () => {
test('panel events are captured during de-serialization', () => {
const panel1 = new TestPanel('panel1', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any);
const panel2 = new TestPanel('panel2', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any);
const panel3 = new TestPanel('panel3', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any);
const groupview2 = new DockviewGroupPanel(dockview, 'groupview-2', {
@ -358,13 +358,13 @@ describe('dockviewGroupPanelModel', () => {
);
const panel1 = new TestPanel('panel1', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any);
const panel2 = new TestPanel('panel2', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any);
const panel3 = new TestPanel('panel3', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any);
expect(events.length).toBe(0);
@ -444,13 +444,13 @@ describe('dockviewGroupPanelModel', () => {
test('moveToPrevious and moveToNext', () => {
const panel1 = new TestPanel('panel1', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any);
const panel2 = new TestPanel('panel2', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any);
const panel3 = new TestPanel('panel3', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any);
groupview.model.openPanel(panel1);
@ -496,13 +496,13 @@ describe('dockviewGroupPanelModel', () => {
test('closeAllPanels with panels', () => {
const panel1 = new TestPanel('panel1', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any);
const panel2 = new TestPanel('panel2', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any);
const panel3 = new TestPanel('panel3', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any);
groupview.model.openPanel(panel1);
@ -609,7 +609,7 @@ describe('dockviewGroupPanelModel', () => {
.item(0)!.childNodes;
const panel1 = new TestPanel('id_1', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any);
cut.openPanel(panel1);
@ -617,7 +617,7 @@ describe('dockviewGroupPanelModel', () => {
expect(contentContainer.item(0)).toBe(panel1.view.content.element);
const panel2 = new TestPanel('id_2', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any);
cut.openPanel(panel2);
@ -625,7 +625,7 @@ describe('dockviewGroupPanelModel', () => {
expect(contentContainer.item(0)).toBe(panel2.view.content.element);
const panel3 = new TestPanel('id_2', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any);
cut.openPanel(panel3, { skipSetActive: true });
@ -836,7 +836,7 @@ describe('dockviewGroupPanelModel', () => {
cut.openPanel(
new TestPanel('panel1', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any)
);
@ -910,12 +910,12 @@ describe('dockviewGroupPanelModel', () => {
cut.openPanel(
new TestPanel('panel1', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any)
);
cut.openPanel(
new TestPanel('panel2', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any)
);
@ -989,12 +989,12 @@ describe('dockviewGroupPanelModel', () => {
cut.openPanel(
new TestPanel('panel1', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any)
);
cut.openPanel(
new TestPanel('panel2', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any)
);
@ -1099,7 +1099,7 @@ describe('dockviewGroupPanelModel', () => {
cut.openPanel(
new TestPanel('panel1', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any)
);
@ -1113,7 +1113,7 @@ describe('dockviewGroupPanelModel', () => {
cut.openPanel(
new TestPanel('panel2', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any)
);
@ -1135,7 +1135,7 @@ describe('dockviewGroupPanelModel', () => {
cut.openPanel(
new TestPanel('panel1', {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
} as any)
);

12
packages/dockview-core/src/__tests__/dockview/dockviewPanel.spec.ts
View File

@ -30,7 +30,7 @@ describe('dockviewPanel', () => {
const model = <IDockviewPanelModel>new panelModelMock();
const cut = new DockviewPanel('fake-id', accessor, api, group, model, {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
});
let latestTitle: string | undefined = undefined;
@ -77,7 +77,7 @@ describe('dockviewPanel', () => {
const model = <IDockviewPanelModel>new panelModelMock();
const cut = new DockviewPanel('fake-id', accessor, api, group, model, {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
});
cut.init({ title: 'myTitle', params: {} });
@ -114,7 +114,7 @@ describe('dockviewPanel', () => {
const model = <IDockviewPanelModel>new panelModelMock();
const cut = new DockviewPanel('fake-id', accessor, api, group, model, {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
});
cut.init({ params: {}, title: 'title' });
@ -148,7 +148,7 @@ describe('dockviewPanel', () => {
const model = <IDockviewPanelModel>new panelModelMock();
const cut = new DockviewPanel('fake-id', accessor, api, group, model, {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
});
expect(cut.params).toEqual(undefined);
@ -186,7 +186,7 @@ describe('dockviewPanel', () => {
const model = <IDockviewPanelModel>new panelModelMock();
const cut = new DockviewPanel('fake-id', accessor, api, group, model, {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
});
cut.api.setSize({ height: 123, width: 456 });
@ -219,7 +219,7 @@ describe('dockviewPanel', () => {
const model = <IDockviewPanelModel>new panelModelMock();
const cut = new DockviewPanel('fake-id', accessor, api, group, model, {
renderer: 'onlyWhenVisibile',
renderer: 'onlyWhenVisible',
});
cut.init({ params: { a: '1', b: '2' }, title: 'A title' });

4
packages/dockview-core/src/dockview/components/panel/content.ts
View File

@ -132,7 +132,7 @@ export class ContentContainer
let container: HTMLElement;
switch (panel.api.renderer) {
case 'onlyWhenVisibile':
case 'onlyWhenVisible':
this.group.renderContainer.detatch(panel);
if (this.panel) {
if (doRender) {
@ -198,7 +198,7 @@ export class ContentContainer
public closePanel(): void {
if (this.panel) {
if (this.panel.api.renderer === 'onlyWhenVisibile') {
if (this.panel.api.renderer === 'onlyWhenVisible') {
this.panel.view.content.element.parentElement?.removeChild(
this.panel.view.content.element
);

2
packages/dockview-core/src/dockview/dockviewComponent.ts
View File

@ -425,7 +425,7 @@ export class DockviewComponent
}
get renderer(): DockviewPanelRenderer {
return this.options.defaultRenderer ?? 'onlyWhenVisibile';
return this.options.defaultRenderer ?? 'onlyWhenVisible';
}
constructor(options: DockviewComponentOptions) {

2
packages/dockview-core/src/overlayRenderContainer.ts
View File

@ -4,7 +4,7 @@ import { getDomNodePagePosition, toggleClass } from './dom';
import { CompositeDisposable, Disposable, IDisposable } from './lifecycle';
import { IDockviewPanel } from './dockview/dockviewPanel';
export type DockviewPanelRenderer = 'onlyWhenVisibile' | 'always';
export type DockviewPanelRenderer = 'onlyWhenVisible' | 'always';
export interface IRenderable {
readonly element: HTMLElement;

4
packages/docs/sandboxes/react/dockview/render-mode/src/app.tsx
View File

@ -55,9 +55,9 @@ const components = {
<button
onClick={() => {
setMode(
mode === 'onlyWhenVisibile'
mode === 'onlyWhenVisible'
? 'always'
: 'onlyWhenVisibile'
: 'onlyWhenVisible'
);
}}
>

136
packages/docs/src/generated/api.output.json
View File

@ -247,7 +247,7 @@
"pieces": []
},
{
"name": "onDidMaxmizedGroupChange",
"name": "onDidMaximizedGroupChange",
"code": "Event<void>",
"kind": "accessor",
"pieces": [
@ -858,7 +858,7 @@
]
},
{
"name": "onDidMaxmizedGroupChange",
"name": "onDidMaximizedGroupChange",
"code": "Event<void>",
"kind": "accessor",
"pieces": [
@ -1634,7 +1634,7 @@
"pieces": []
},
{
"name": "onDidMaxmizedGroupChange",
"name": "onDidMaximizedGroupChange",
"code": "Event<void>",
"kind": "accessor",
"pieces": [
@ -1770,7 +1770,7 @@
},
{
"name": "doRemoveGroup",
"code": "(group: DockviewGroupPanel, options?: { skipActive?: boolean, skipDispose?: boolean, skipPopoutAssociated?: boolean }): DockviewGroupPanel",
"code": "(group: DockviewGroupPanel, options?: { skipActive?: boolean, skipDispose?: boolean, skipPopoutAssociated?: boolean, skipPopoutReturn?: boolean }): DockviewGroupPanel",
"kind": "method",
"pieces": [
"DockviewGroupPanel"
@ -1898,7 +1898,7 @@
},
{
"name": "removeGroup",
"code": "(group: DockviewGroupPanel, options?: { skipActive?: boolean, skipDispose?: boolean }): void",
"code": "(group: DockviewGroupPanel, options?: { skipActive?: boolean, skipDispose?: boolean, skipPopoutAssociated?: boolean, skipPopoutReturn?: boolean }): void",
"kind": "method",
"pieces": [
"DockviewGroupPanel"
@ -2604,10 +2604,10 @@
},
{
"name": "canDisplayOverlay",
"code": "(event: DragEvent, position: Position, target: DockviewDropTargets): boolean",
"code": "(event: DragEvent, position: Position, target: DockviewGroupDropLocation): boolean",
"kind": "method",
"pieces": [
"DockviewDropTargets",
"DockviewGroupDropLocation",
"Position"
]
},
@ -3313,7 +3313,7 @@
]
},
{
"name": "onDidMaxmizedNodeChange",
"name": "onDidMaximizedNodeChange",
"code": "Event<void>",
"kind": "property",
"flags": {
@ -4137,7 +4137,7 @@
"pieces": []
},
{
"name": "onDidMaxmizedGroupChange",
"name": "onDidMaximizedGroupChange",
"code": "Event<void>",
"kind": "accessor",
"pieces": [
@ -7041,6 +7041,50 @@
}
]
},
"WillShowOverlayLocationEvent": {
"kind": "class",
"children": [
{
"name": "constructor",
"code": "",
"pieces": []
},
{
"name": "defaultPrevented",
"code": "boolean",
"kind": "accessor",
"pieces": []
},
{
"name": "kind",
"code": "DockviewGroupDropLocation",
"kind": "accessor",
"pieces": [
"DockviewGroupDropLocation"
]
},
{
"name": "nativeEvent",
"code": "DragEvent",
"kind": "accessor",
"pieces": []
},
{
"name": "position",
"code": "Position",
"kind": "accessor",
"pieces": [
"Position"
]
},
{
"name": "preventDefault",
"code": "(): void",
"kind": "method",
"pieces": []
}
]
},
"ActiveEvent": {
"kind": "interface",
"children": [
@ -7593,7 +7637,7 @@
},
{
"name": "defaultRenderer",
"code": "'always' | 'onlyWhenVisibile'",
"code": "'always' | 'onlyWhenVisible'",
"kind": "property",
"flags": {
"isOptional": true
@ -7818,11 +7862,11 @@
},
{
"name": "target",
"code": "DockviewDropTargets",
"code": "DockviewGroupDropLocation",
"kind": "property",
"flags": {},
"pieces": [
"DockviewDropTargets"
"DockviewGroupDropLocation"
]
}
]
@ -8064,6 +8108,12 @@
},
"pieces": []
},
{
"name": "close",
"code": "(): void",
"kind": "method",
"pieces": []
},
{
"name": "exitMaximized",
"code": "(): void",
@ -9474,7 +9524,7 @@
},
{
"name": "renderer",
"code": "'always' | 'onlyWhenVisibile'",
"code": "'always' | 'onlyWhenVisible'",
"kind": "property",
"flags": {
"isOptional": true
@ -9609,7 +9659,7 @@
]
},
{
"name": "onDidMaxmizedGroupChange",
"name": "onDidMaximizedGroupChange",
"code": "Event<void>",
"kind": "property",
"flags": {
@ -10111,7 +10161,7 @@
]
},
{
"name": "onDidMaxmizedGroupChange",
"name": "onDidMaximizedGroupChange",
"code": "Event<void>",
"kind": "property",
"flags": {
@ -10191,7 +10241,9 @@
"name": "options",
"code": "DockviewComponentOptions",
"kind": "property",
"flags": {},
"flags": {
"isReadonly": true
},
"pieces": [
"DockviewComponentOptions"
]
@ -10785,10 +10837,10 @@
},
{
"name": "canDisplayOverlay",
"code": "(event: DragEvent, position: Position, target: DockviewDropTargets): boolean",
"code": "(event: DragEvent, position: Position, target: DockviewGroupDropLocation): boolean",
"kind": "method",
"pieces": [
"DockviewDropTargets",
"DockviewGroupDropLocation",
"Position"
]
},
@ -11581,7 +11633,7 @@
]
},
{
"name": "onDidMaxmizedGroupChange",
"name": "onDidMaximizedGroupChange",
"code": "Event<void>",
"kind": "property",
"flags": {
@ -15228,29 +15280,6 @@
}
]
},
"WillShowOverlayLocationEvent": {
"kind": "interface",
"children": [
{
"name": "event",
"code": "WillShowOverlayEvent",
"kind": "property",
"flags": {},
"pieces": [
"WillShowOverlayEvent"
]
},
{
"name": "kind",
"code": "DockviewGroupDropLocation",
"kind": "property",
"flags": {},
"pieces": [
"DockviewGroupDropLocation"
]
}
]
},
"AddGroupOptions": {
"kind": "typeAlias",
"children": [],
@ -15328,23 +15357,12 @@
]
}
},
"DockviewDropTargets": {
"kind": "typeAlias",
"children": [],
"metadata": {
"name": "DockviewDropTargets",
"code": "'edge' | 'tabContainer' | 'panel' | 'tab'",
"pieces": [
null
]
}
},
"DockviewGroupDropLocation": {
"kind": "typeAlias",
"children": [],
"metadata": {
"name": "DockviewGroupDropLocation",
"code": "'content' | 'header_space' | 'tab'",
"code": "'edge' | 'content' | 'header_space' | 'tab'",
"pieces": [
null
]
@ -15377,7 +15395,7 @@
"children": [],
"metadata": {
"name": "DockviewPanelRenderer",
"code": "'always' | 'onlyWhenVisibile'",
"code": "'always' | 'onlyWhenVisible'",
"pieces": [
null
]
@ -15837,7 +15855,7 @@
},
{
"name": "defaultRenderer",
"code": "'always' | 'onlyWhenVisibile'",
"code": "'always' | 'onlyWhenVisible'",
"kind": "property",
"flags": {
"isOptional": true
@ -16695,12 +16713,12 @@
}
]
},
"isReactElement": {
"isReactComponent": {
"kind": "function",
"children": [],
"metadata": {
"name": "isReactElement",
"code": "(element: unknown): element is React.ReactElement<any, | (props: any, deprecatedLegacyContext?: any): React.ReactNode | string>",
"name": "isReactComponent",
"code": "(component: any): boolean",
"pieces": [
null,
null

747
yarn.lock
View File

File diff suppressed because it is too large Load Diff