Skip to content
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.

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

Pass query through viewer links between modes #879

Merged
merged 1 commit into from
Nov 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions src/lib/components/viewer/AnnotationLayer.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@ Assumes it's a child of a ViewerContext

import { invalidate, pushState } from "$app/navigation";

import { fly } from "svelte/transition";
import { _ } from "svelte-i18n";

import Note from "./Note.svelte";
import EditNote from "../forms/EditNote.svelte";
import NoteTab from "./NoteTab.svelte";

Expand All @@ -31,8 +33,6 @@ Assumes it's a child of a ViewerContext
isEmbedded,
} from "$lib/components/viewer/ViewerContext.svelte";
import { getNotes, getViewerHref } from "$lib/utils/viewer";
import Note from "./Note.svelte";
import { fly } from "svelte/transition";

export let scale = 1.5;
export let page_number: number; // zero-indexed
Expand Down
6 changes: 5 additions & 1 deletion src/lib/components/viewer/Page.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ Assumes it's a child of a ViewerContext
-->

<script lang="ts">
import { page } from "$app/stores";

import { createEventDispatcher, onMount } from "svelte";
import { _ } from "svelte-i18n";

Expand All @@ -17,6 +19,7 @@ Assumes it's a child of a ViewerContext
getDocument,
isEmbedded,
} from "$lib/components/viewer/ViewerContext.svelte";
import { getQuery } from "$lib/utils/search";
import { getViewerHref } from "$lib/utils/viewer";

export let page_number: number;
Expand Down Expand Up @@ -44,6 +47,7 @@ Assumes it's a child of a ViewerContext
mode: "document",
page: page_number,
embed,
query: getQuery($page.url, "q"),
});

function isDOMRectReadOnly(
Expand Down Expand Up @@ -121,7 +125,7 @@ Assumes it's a child of a ViewerContext
<div class="title"><slot name="title" /></div>
<header>
<h4 class="pageNumber">
<a {href}>
<a href={documentHref}>
{$_("documents.pageAbbrev")}
{page_number}
</a>
Expand Down
7 changes: 5 additions & 2 deletions src/lib/components/viewer/ReadingToolbar.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Assumes it's a child of a ViewerContext
{#each readModes.entries() as [value, name]}
<Tab
active={$mode === value}
href={getViewerHref({ document, mode: value, embed })}
href={getViewerHref({ document, mode: value, embed, query })}
>
<svelte:component this={icons[value]} />
{name}
Expand Down Expand Up @@ -127,7 +127,10 @@ Assumes it's a child of a ViewerContext
<Flex justify="end" slot="right">
{#if !BREAKPOINTS.WRITE_MENU && canWrite}
{#each writeModes as [value, name]}
<Button ghost href={getViewerHref({ document, mode: value, embed })}>
<Button
ghost
href={getViewerHref({ document, mode: value, embed, query })}
>
<span class="icon"><svelte:component this={icons[value]} /></span>
{name}
</Button>
Expand Down
4 changes: 2 additions & 2 deletions src/lib/utils/tests/viewer.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ import {
pageHashUrl,
READING_MODES,
WRITING_MODES,
} from "@/lib/api/documents";
import { noteHashUrl } from "@/lib/api/notes";
} from "$lib/api/documents";
import { noteHashUrl } from "$lib/api/notes";

describe("getViewerHref", () => {
const docUrl = canonicalUrl(document);
Expand Down
22 changes: 17 additions & 5 deletions src/lib/utils/viewer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,24 +17,36 @@ interface ViewerHrefOptions {
note?: Note;
mode?: ViewerMode;
embed?: boolean;
query?: string;
}

export function getViewerHref(options: ViewerHrefOptions = {}) {
const { document, page, note, mode = "document", embed = false } = options;
const {
document,
page,
note,
query,
mode = "document",
embed = false,
} = options;

let hash = "";
if (page) hash = pageHashUrl(page);
if (note) hash = noteHashUrl(note);

const params = { mode };
if (embed) params["embed"] = 1;
if (query) params["q"] = query;

if (document) {
// If we have the document, we can provide an absolute URL
let url = canonicalUrl(document);
url.searchParams.set("mode", mode);
if (embed) url.searchParams.set("embed", "1");
url.search = new URLSearchParams(params).toString();
if (hash) url.hash = hash;
return url.href;
} else {
// If we don't, we can provide a relative URL
let href = `?mode=${mode}`;
if (embed) href += "&embed=1";
let href = "?" + new URLSearchParams(params).toString();
if (hash) href += hash;
return href;
}
Expand Down