Skip to content

Add the shareable ID to a notebook's URL on the first time it is shared #243

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
merged 2 commits into from
Sep 29, 2025
Merged

Add the shareable ID to a notebook's URL on the first time it is shared #243

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cef64e7
Set sharing URL in notebooks on first share
agriyakhetarpal Sep 29, 2025
f3c1b6e
Change variable name `newReadable` to `notebookID`
agriyakhetarpal Sep 29, 2025
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
24 changes: 24 additions & 0 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,19 @@ function generateShareURL(notebookID: string): string {
return `${baseUrl}?notebook=${notebookID}`;
}

/**
* Sets or updates the 'notebook' query parameter in the current URL to the given notebookID.
* If the parameter already exists with the same value, no change is made.
* @param notebookID - The ID of the notebook to set in the URL.
*/
function setNotebookParamInUrl(notebookID: string): void {
const url = new URL(window.location.href);
if (url.searchParams.get('notebook') !== notebookID) {
url.searchParams.set('notebook', notebookID);
window.history.replaceState({}, '', url.toString());
}
}

const manuallySharing = new WeakSet<NotebookPanel | ViewOnlyNotebookPanel>();

/**
Expand Down Expand Up @@ -134,6 +147,17 @@ async function handleNotebookSharing(

notebookPanel.context.model.fromJSON(notebookContent);
await notebookPanel.context.save();

try {
const notebookID =
(notebookContent.metadata?.readableId as string | undefined) ??
(notebookContent.metadata?.sharedId as string | undefined);
if (notebookID) {
setNotebookParamInUrl(notebookID);
}
} catch (e) {
console.warn('Failed to update URL with shareable notebook ID:', e);
}
}

if (manual) {
Expand Down
Loading