Skip to content

Allow for dynamic view switching #50

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

Open
Yahiewi wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Allow for dynamic view switching #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 9 additions & 4 deletions src/document/factory.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ export class NotebookGridWidgetFactory extends ABCWidgetFactory<
this._shell = options.shell;
this._themeManager = options.themeManager;
this._spectaTopbar = options.spectaTopbar;
this._layoutRegistry = options.spectaLayoutRegistry;
}

protected createNewWidget(
Expand All @@ -50,12 +51,19 @@ export class NotebookGridWidgetFactory extends ABCWidgetFactory<
nbPath: path
});
const isSpecta = isSpectaApp();

const spectaWidget = await this._spectaWidgetFactory.createNew({
context
});

if (!spectaConfig.hideTopbar) {
const title = <TitleComponent config={spectaConfig.topBar} />;
const menu = (
<MenuComponent
config={spectaConfig.topBar}
themeManager={this._themeManager}
layoutRegistry={this._layoutRegistry}
spectaWidget={spectaWidget}
/>
);
if (!isSpecta) {
Expand All @@ -76,10 +84,6 @@ export class NotebookGridWidgetFactory extends ABCWidgetFactory<
this._shell.hideTopBar();
}

const spectaWidget = await this._spectaWidgetFactory.createNew({
context
});

if (spectaWidget) {
content.addWidget(spectaWidget);
}
Expand All @@ -97,4 +101,5 @@ export class NotebookGridWidgetFactory extends ABCWidgetFactory<
private _shell: ISpectaShell;
private _themeManager?: IThemeManager;
private _spectaTopbar: ISpectaTopbarWidget;
private _layoutRegistry: ISpectaLayoutRegistry;
}
53 changes: 28 additions & 25 deletions src/specta_widget.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ export class AppWidget extends Panel {
this.addSpinner();
}

this._currentLayoutName = options.spectaConfig.defaultLayout ?? 'default';

this._model.initialize().then(async () => {
let waitTime = this._spectaAppConfig.executionDelay;
if (!waitTime) {
Expand All @@ -44,10 +46,6 @@ export class AppWidget extends Panel {
await this.render();
emitResizeEvent();
});
this._layoutRegistry.selectedLayoutChanged.connect(
this._onSelectedLayoutChanged,
this
);
this._model.fileChanged.connect((_, newCells) => {
this.rerender(newCells);
});
Expand Down Expand Up @@ -115,10 +113,32 @@ export class AppWidget extends Panel {
return outs;
}

get currentLayoutName(): string {
return this._currentLayoutName;
}

setCurrentLayout(name: string): void {
if (this._currentLayoutName === name) {
return;
}
this._currentLayoutName = name;
const spectaLayout = this.getLayout();
const currentEls = [...this._host.widgets];
currentEls.forEach(el => {
this._host.layout?.removeWidget(el);
});
spectaLayout.render({
host: this._host,
items: this._outputs,
notebook: this._model.context?.model.toJSON() as any,
readyCallback: async () => {},
spectaConfig: this._spectaAppConfig
});
}

getLayout(): ISpectaLayout {
const layout = this._spectaAppConfig?.defaultLayout ?? 'default';
const spectaLayout =
this._layoutRegistry.get(layout) ??
this._layoutRegistry.get(this._currentLayoutName) ??
this._layoutRegistry.getDefaultLayout();
return spectaLayout;
}
Expand Down Expand Up @@ -170,25 +190,6 @@ export class AppWidget extends Panel {
super.onCloseRequest(msg);
}

private _onSelectedLayoutChanged(

@trungleduc trungleduc Jun 5, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

IIRC, I removed the layout switch option because rerendering the view with a different layout on the fly is bugged. Could you double-check this on both Jupyter and the standalone app

sender: ISpectaLayoutRegistry,
args: { name: string; layout: ISpectaLayout; oldLayout?: ISpectaLayout }
): void {
const { layout } = args;

const currentEls = [...this._host.widgets];

currentEls.forEach(el => {
this._host.layout?.removeWidget(el);
});
layout.render({
host: this._host,
items: this._outputs,
notebook: this._model.context?.model.toJSON() as any,
readyCallback: async () => {},
spectaConfig: this._spectaAppConfig
});
}
private _model: AppModel;

private _ready = new PromiseDelegate<void>();
Expand All @@ -202,6 +203,8 @@ export class AppWidget extends Panel {
private _outputs: SpectaCellOutput[] = [];

private _spectaAppConfig: ISpectaAppConfig;

private _currentLayoutName: string;
}

export namespace AppWidget {
Expand Down
4 changes: 0 additions & 4 deletions src/specta_widget_factory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,6 @@ export class SpectaWidgetFactory {
nbMetadata: context.model.metadata,
nbPath: context.contentsModel?.path
});

const defaultLayout = spectaConfig.defaultLayout ?? 'default';
this._options.spectaLayoutRegistry.setSelectedLayout(defaultLayout);

const model = new AppModel({
context,
manager: this._options.manager,
Expand Down
6 changes: 5 additions & 1 deletion src/topbar/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,11 @@ export const topbarPlugin: JupyterFrontEndPlugin<
const title = <TitleComponent config={config.topBar} />;
widget.addReactWidget(title, 'left', 0);
const menu = (
<MenuComponent config={config.topBar} themeManager={themeManager} />
<MenuComponent
config={config.topBar}
themeManager={themeManager}
layoutRegistry={layoutRegistry}
/>
);
widget.addReactWidget(menu, 'right', 10000);

Expand Down
9 changes: 8 additions & 1 deletion src/topbar/menuComponent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,16 @@ import React, { useState, useRef, useEffect } from 'react';
import { GearIcon } from '../components/icon/gear';
import { IconButton } from '../components/iconButton';
import { SettingContent } from './settingDialog';
import { ITopbarConfig } from '../token';
import { ISpectaLayoutRegistry, ITopbarConfig } from '../token';

interface IProps {
config?: ITopbarConfig;
themeManager?: IThemeManager;
layoutRegistry?: ISpectaLayoutRegistry;
spectaWidget?: {
currentLayoutName: string;
setCurrentLayout(name: string): void;
};
}

export function MenuComponent(props: IProps): JSX.Element {
Expand Down Expand Up @@ -46,6 +51,8 @@ export function MenuComponent(props: IProps): JSX.Element {
<SettingContent
config={props.config}
themeManager={props.themeManager}
layoutRegistry={props.layoutRegistry}
spectaWidget={props.spectaWidget}
/>
</div>
)}
Expand Down
18 changes: 14 additions & 4 deletions src/topbar/settingDialog.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ export const SettingContent = (props: {
config?: ITopbarConfig;
themeManager?: IThemeManager;
layoutRegistry?: ISpectaLayoutRegistry;
spectaWidget?: {
currentLayoutName: string;
setCurrentLayout(name: string): void;
};
}) => {
const { themeManager, layoutRegistry } = props;
const [themeOptions, setThemeOptions] = useState<string[]>([
Expand All @@ -20,7 +24,9 @@ export const SettingContent = (props: {
layoutRegistry?.allLayouts() ?? []
);
const [selectedLayout, setSelectedLayout] = useState<string>(
layoutRegistry?.selectedLayout?.name ?? 'default'
props.spectaWidget?.currentLayoutName ??
layoutRegistry?.selectedLayout?.name ??
'default'
);
useEffect(() => {
let cb: any;
Expand Down Expand Up @@ -69,12 +75,16 @@ export const SettingContent = (props: {
const onLayoutChange = useCallback(
(e: React.ChangeEvent<HTMLSelectElement>) => {
const layout = e.currentTarget?.value;
if (layout && layoutRegistry) {
layoutRegistry.setSelectedLayout(layout);
if (layout) {
if (props.spectaWidget) {
props.spectaWidget.setCurrentLayout(layout);
} else if (layoutRegistry) {
layoutRegistry.setSelectedLayout(layout);
}
setSelectedLayout(layout);
}
},
[layoutRegistry]
[props.spectaWidget, layoutRegistry]
);
return (
<div style={{ padding: '0 10px' }}>
Expand Down
Loading