Skip to content

Add warning message and change cell toolbar opacity on text overlap #18

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

Closed
Yahiewi wants to merge 1 commit into from
Closed

Add warning message and change cell toolbar opacity on text overlap #18

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
94 changes: 84 additions & 10 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,13 @@ import {
JupyterFrontEnd,
JupyterFrontEndPlugin
} from '@jupyterlab/application';
import { ICodeCellModel } from '@jupyterlab/cells';
import { Cell, ICodeCellModel } from '@jupyterlab/cells';
import { INotebookTracker, NotebookPanel } from '@jupyterlab/notebook';
import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
import { ISettingRegistry } from '@jupyterlab/settingregistry';
import { ITranslator, nullTranslator } from '@jupyterlab/translation';
import { infoIcon } from '@jupyterlab/ui-components';
import { Panel, Widget } from '@lumino/widgets';

import { clearItem, stopItem } from './components';
import { TUTOR_USER, TutorChatModel } from './model';
Expand Down Expand Up @@ -123,15 +124,83 @@ const plugin: JupyterFrontEndPlugin<void> = {
attachmentOpenerRegistry,
inputToolbarRegistry
});
chatWidget.id = 'jupyter-ai-tutor-panel';
chatWidget.title.label = trans.__('Tutor');
chatWidget.title.caption = trans.__('Tutor');
chatWidget.title.closable = true;
app.shell.add(chatWidget, 'right');
chatWidget.id = 'jupyter-ai-tutor-chat';

// Track cell currently being explained
let lastExplainedCellId: string | null = null;

// Create the warning banner element
const warningBanner = document.createElement('div');
warningBanner.className = 'jp-jupyter-ai-tutor-warning-banner';

const warningText = document.createElement('span');
warningText.className = 'jp-jupyter-ai-tutor-warning-text';
warningText.textContent = trans.__(
'Warning: You have moved away from the cell for which this feedback is generated.'
);
warningBanner.appendChild(warningText);

const warningButton = document.createElement('button');
warningButton.className = 'jp-jupyter-ai-tutor-warning-btn';
warningButton.textContent = trans.__('Go to Cell');
warningBanner.appendChild(warningButton);

// Create the warning banner widget wrapping the warningBanner node
const warningWidget = new Widget({ node: warningBanner });
warningWidget.id = 'jupyter-ai-tutor-warning-widget';

// Wrap the warning widget and chat widget in a main panel using Panel
const mainPanel = new Panel();
mainPanel.id = 'jupyter-ai-tutor-panel';
mainPanel.title.label = trans.__('Tutor');
mainPanel.title.caption = trans.__('Tutor');
mainPanel.title.closable = true;

// Add widgets to panel
mainPanel.addWidget(warningWidget);
mainPanel.addWidget(chatWidget);

warningWidget.hide();
app.shell.add(mainPanel, 'right');

// Handle "Go to Cell" click to scroll back to relevant cell
warningButton.addEventListener('click', () => {
if (!lastExplainedCellId || !notebookTracker) {
return;
}
const notebookPanel = notebookTracker.find((panel: NotebookPanel) =>
panel.content.widgets.some(
(widget: Cell) => widget.model.id === lastExplainedCellId
)
);
if (notebookPanel) {
app.shell.activateById(notebookPanel.id);
const index = notebookPanel.content.widgets.findIndex(
(widget: Cell) => widget.model.id === lastExplainedCellId
);
if (index !== -1) {
notebookPanel.content.activeCellIndex = index;
notebookPanel.content.widgets[index].node.scrollIntoView({
block: 'nearest'
});
}
}
});

// Keep the enabled state in sync when the active cell changes.
notebookTracker?.activeCellChanged.connect(() => {
commands.notifyCommandChanged(CommandIDs.explainCode);

const activeCell = notebookTracker?.activeCell;

if (lastExplainedCellId && activeCell) {
if (activeCell.model.id !== lastExplainedCellId) {
warningWidget.show();
} else {
warningWidget.hide();
}
} else {
warningWidget.hide();
}
});

// Listen for writers change to display the stop button.
Expand All @@ -155,6 +224,8 @@ const plugin: JupyterFrontEndPlugin<void> = {
inputToolbarRegistry?.show('clear');
} else {
inputToolbarRegistry?.hide('clear');
lastExplainedCellId = null;
warningWidget.hide();
}
}

Expand All @@ -174,6 +245,9 @@ const plugin: JupyterFrontEndPlugin<void> = {
const cell = notebookTracker?.activeCell;
if (!cell || cell.model.type !== 'code') return;

lastExplainedCellId = cell.model.id;
warningWidget.hide();

const source = cell.model.sharedModel.source.trim();
if (!source) return;

Expand Down Expand Up @@ -247,10 +321,10 @@ const plugin: JupyterFrontEndPlugin<void> = {
: 'Can you explain this code?';
const body = `${question}\n\n\`\`\`${language}\n${source}\n\`\`\`${errorSection}\n`;

if (!chatWidget.isAttached) {
app.shell.add(chatWidget, 'right');
if (!mainPanel.isAttached) {
app.shell.add(mainPanel, 'right');
}
app.shell.activateById(chatWidget.id);
app.shell.activateById(mainPanel.id);

await tutorModel.sendMessageToAI({
body,
Expand Down
65 changes: 65 additions & 0 deletions style/base.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,68 @@
#jupyter-ai-tutor-panel .jp-chat-input-container .jp-chat-input-toolbar {
border-top: none;
}

/* Flex layout for sidebar panel and chat */
/* stylelint-disable-next-line selector-class-pattern */
#jupyter-ai-tutor-panel {
display: flex;
flex-direction: column;
height: 100%;
}

/* stylelint-disable-next-line selector-class-pattern */
#jupyter-ai-tutor-chat {
flex: 1;
min-height: 0;
}

/* Warning banner for focus transitions */
/* stylelint-disable-next-line selector-class-pattern */
.jp-jupyter-ai-tutor-warning-banner {
display: flex;
align-items: center;
justify-content: space-between;
padding: 8px 12px;
background-color: var(--jp-warn-color3, #fffbeb);
border-bottom: 1px solid var(--jp-warn-color1, #f59e0b);
color: var(--jp-ui-font-color1, #78350f);
font-size: var(--jp-ui-font-size1, 13px);
}

/* stylelint-disable-next-line selector-class-pattern */
.jp-jupyter-ai-tutor-warning-text {
flex: 1;
margin-right: 8px;
}

/* stylelint-disable-next-line selector-class-pattern */
.jp-jupyter-ai-tutor-warning-btn {
background: var(--jp-brand-color1, #2196f3);
color: var(--jp-layout-color0, #ffffff);
border: none;
border-radius: 3px;
padding: 4px 8px;
cursor: pointer;
font-weight: 500;
font-size: var(--jp-ui-font-size0, 11px);
white-space: nowrap;
}

/* stylelint-disable-next-line selector-class-pattern */
.jp-jupyter-ai-tutor-warning-btn:hover {
background: var(--jp-brand-color0, #1976d2);
}

/* Override toolbar visibility on cell overlap */
/* stylelint-disable-next-line selector-class-pattern */
.jp-toolbar-overlap .jp-cell-toolbar {
display: flex !important;
opacity: 0.15;
}

/* stylelint-disable-next-line selector-class-pattern */
.jp-toolbar-overlap .jp-cell-toolbar:hover {
opacity: 1 !important;
background-color: var(--jp-layout-color1);
box-shadow: var(--jp-elevation-z2);
}
Loading