Files
plainleaf/web/components/page_navigator.tsx
T
aa0b95b31d The one about refs (#1496)
* [Major] Introduce a new `Ref` and `Path` type

This introduces a new `Ref` and `Path` type, which try to be as lightweight and rigorous as possible. More description in the PR

* [Minor] Updated Syntax

* [Minor] Updated Type

* [Minor] Renamed file

* [Minor] Updated type

* [Minor] Updated Syntax

* [Major] Rename css classes for wiki links

Previously all the parts of a wiki link were tagged with `sb-wiki-link-page`. This didn't make a whole lot of sense. Also the tag `sb-wiki-link` was could never render, because of the way `HighlightStyle` works. Now every part of a wiki link will be tagged with `sb-wiki-link` (i.e. the link, the alias, the dimensions). Invalid and missing links will be styled separately in a later commit.

* [Minor] Adjust to new API

* [Minor] Small changes

* [Minor] Function and file renames

* [Major] Syscall adjusments

Change behavior of `getCurrentPath` to actually return what's now considered a `Path`. `getCurrentPage(Meta)` now also correctly returns for documents. We could consider a rename to get rid of the `page` association

* [Major] Rework `Client`

Mostly minor adjustments for the new API. Some major changes in `navigateWithinPage` and some unecessary checks removed now

* [Major] Errors on navigate

This now throws an error when the user tries to navigate to a link that is invalid

* [Major] Minor adjustments and remove some old bulk

This does the typicall adjustments to the new API. A thing to consider is that invalid links aren't indexed. Also removed old code about template and query stuff. And reused a regex instead of copy pasting it.

* [Minor] Cleanup editor ui

* [Minor] Adjust to new API

* [Minor] Adjust to new API and reduce ugly regex

* [Minor] New API

* [Minor] Rework link cm plugin

* [Major] Rework wiki links

A lot of code cleanup, reworked for new APIs and also introduces "invalid links"

* [Minor] Part of the editor ui rework

* [Major] Adjust to new API

This also removes the `looksLikePathWithExtension` check. I don't think it was necessary.

* [Minor] PArt of editor ui rewrite

* [Minor] Adjust to new API

* [Major] Adjust renderer to new API

Invalid links now link to `#`

* [Major] Rewrite navigator

This still needs major rework, currently in a "got it working" state

* [Minor] Adjust file name

* [Minor] Mistake during rebase

* [Minor] Navigate to end of header

* [Minor] Remove `tweakEditorDOM` and use proper CM extensions

* [Major] Heavily clean up the navigation code

* [Minor] Make `PageNavigator` closable again

* [Minor] Small fixes to reduce errors bubbling up

* [Minor] Show error message if navigate fails

* [Major] Remove legacy `navigate({ kind = ` syntax

This removes the old navigation syntax. It's still supported but the user will be warned then using it. I also added some validation to editor.navigate for user provided refs.

* [Minor] Make notifications errors

* [Minor] Don't fail if header isn't found

* [Minor] Typo

* [Major] Remove cleanPageRef

* [Minor] Small bug

* [Minor] Align behavior between render and editor

* [Major] Remove `PageRef`. Pretty sure it's obsolete

* [Major] Remove pos from header as it's an invalid ref

* [Minor] Align with original behavior

* [Minor] Get tests working again

* [Minor] check that indexPage is valid

* [Major] Rewrite `resolve.ts` file

* [Minor] More tests, more fixes

* [Minor] Don't just append .md this is weird

* [Minor] More edge cases

* [Minor] Version bumping hono somehow fixes the `/` case

* [Minor] Smaller TODOs

* [Major] We can be a littler looser on the restrictions

* [Major] Change header indexing, to index with pos

* [Minor] More fixes for headers

* [Minor] Rename for clarity

* [Minor] Change more regexes to named groups

* [Major] Inline content rewrite

* [Minor] Fix TODO

* [Minor] Bump index version

* [Major] New Space Primitive to check paths

* [Minor] Fix #1214

* [Minor] Fix #1169

* [Minor] Remove TODO

This check is probably not needed anymore. Unsure. May look into it later

* [Minor] small bug

* [Minor] Not a good rebase without me needing to fix it afterwards

* [Minor] Improve fallback for file upload

* [Minor] Some fixes on the for resolving

* [Minor] Removed doubled test case

* [Minor] Resolve #860

* [Minor] Turn flash notification into an error

* [Minor] Change handling of `.` paths

* [Minor] Show empty URL for index page

* [Minor] Push correct ref to history

* [Major] Capture mini editor events in capture phase

This fixes the issue were when pressing arrowup or arrowdown changed the cursor position inside the editor

* [Major] Add prefix to `FilterList`

This now fixes issues were if you had a prefixed page you  con't properly search for it, because the search considered the prefix as part of the name

* [Minor] A little rigor for empty headers

* [Major] Fix #1404

* [Minor] `parseInt` returns `NaN` handle that

* [Minor] Use `fileName`

* [Minor] Fix comment

* [Minor] Fixes

* [Major] disallow `foo.png.md` and `/../`, etc. cases

* [Major] Change name of conflicted pages

* [Minor] Remove unecessary check

* [Minor] Remove some split code

* [Minor] Allow deletion of invalid files

* [Minor] Bug in the regex

* [Minor] Give some possibility of fixing incorrect names

* [Minor] Tiny bug with header completion

* [Major] Docs

* [Minor] Ignore errors for navigation inside of a page

This could be a problem when SB e.g. cached a scrollTop for a page, which, because e.g. the file is now deleted, doesn't exist anymore and thus CM throws an error, when trying to navigate

* Update conflicted copy regex in Maintenance.md

---------

Co-authored-by: Zef Hemel <zef@zef.me>
2025-08-24 16:16:19 +02:00

264 lines
8.1 KiB
TypeScript

import { FilterList } from "./filter.tsx";
import type { FilterOption } from "@silverbulletmd/silverbullet/type/client";
import type {
CompletionContext,
CompletionResult,
} from "@codemirror/autocomplete";
import { tagRegex as mdTagRegex } from "../markdown_parser/constants.ts";
import { extractHashtag } from "@silverbulletmd/silverbullet/lib/tags";
import type { DocumentMeta, PageMeta } from "../../type/index.ts";
import {
getNameFromPath,
parseToRef,
type Path,
} from "@silverbulletmd/silverbullet/lib/ref";
import { folderName } from "@silverbulletmd/silverbullet/lib/resolve";
const tagRegex = new RegExp(mdTagRegex.source, "g");
export function PageNavigator({
allPages,
allDocuments,
extensions,
onNavigate,
onModeSwitch,
completer,
vimMode,
mode,
darkMode,
currentPath,
}: {
allDocuments: DocumentMeta[];
allPages: PageMeta[];
extensions: Set<string>;
vimMode: boolean;
darkMode?: boolean;
mode: "page" | "meta" | "document" | "all";
onNavigate: (name: string | null) => void;
onModeSwitch: (mode: "page" | "meta" | "document" | "all") => void;
completer: (context: CompletionContext) => Promise<CompletionResult | null>;
currentPath: Path;
}) {
const options: FilterOption[] = [];
if (mode === "document" || mode === "all") {
for (const documentMeta of allDocuments) {
const isViewable = extensions.has(documentMeta.extension);
let orderId = isViewable
? -new Date(documentMeta.lastModified).getTime()
: (Number.MAX_VALUE - new Date(documentMeta.lastModified).getTime());
if (currentPath === documentMeta.name) {
orderId = Infinity;
}
// Can't really add tags to document as of right now, but maybe in the future
let description: string | undefined;
if (documentMeta.tags) {
description = (description || "") +
documentMeta.tags.map((tag) => `#${tag}`).join(" ");
}
if (!isViewable && client.clientSystem.readOnlyMode) continue;
options.push({
type: "document",
meta: documentMeta,
name: documentMeta.name,
description,
orderId: orderId,
hint: documentMeta.name.split(".").pop()?.toUpperCase(),
hintInactive: !isViewable,
});
}
}
if (mode !== "document") {
for (const pageMeta of allPages) {
// Sanitize the page name
if (!pageMeta.name) {
pageMeta.name = pageMeta.ref;
}
// Order by last modified date in descending order
let orderId = -new Date(pageMeta.lastModified).getTime();
// Unless it was opened in this session
if (pageMeta.lastOpened) {
orderId = -pageMeta.lastOpened;
}
// Or it's the currently open page
if (
currentPath === `${pageMeta.name}.md` || pageMeta._isAspiring
) {
// ... then we put it all the way to the end
orderId = Infinity;
}
const cssClass = (pageMeta.pageDecoration?.cssClasses || []).join(" ")
.replaceAll(/[^a-zA-Z0-9-_ ]/g, "");
if (mode === "page") {
// Special behavior for regular pages
let description: string | undefined;
let aliases: string[] = [];
if (pageMeta.displayName) {
aliases.push(pageMeta.displayName);
}
if (Array.isArray(pageMeta.aliases)) {
aliases = aliases.concat(pageMeta.aliases);
}
if (aliases.length > 0) {
description = "(a.k.a. " + aliases.join(", ") + ") ";
}
if (pageMeta.tags) {
description = (description || "") +
pageMeta.tags.map((tag) => `#${tag}`).join(" ");
}
options.push({
type: "page",
meta: pageMeta,
name: pageMeta.name,
prefix: pageMeta.pageDecoration?.prefix,
description,
orderId: orderId,
hint: pageMeta._isAspiring ? "Create page" : undefined,
cssClass,
});
} else if (mode === "meta") {
// Special behavior for #meta pages
if (pageMeta._isAspiring) {
// Skip over broken links
continue;
}
options.push({
type: "page",
meta: pageMeta,
// Use the displayName or last bit of the path as the name
name: pageMeta.displayName || pageMeta.name.split("/").pop()!,
// And use the full path as the description
description: pageMeta.name,
hint: pageMeta.tags![0],
orderId: orderId,
cssClass,
});
} else { // all
// In mode "all" just show the full path and all tags
let description: string | undefined;
if (pageMeta.tags) {
description = (description || "") +
pageMeta.tags.map((tag) => `#${tag}`).join(" ");
}
options.push({
type: "page",
meta: pageMeta,
name: pageMeta.name,
description,
orderId: orderId,
cssClass,
});
}
}
}
const completePrefix =
(folderName(currentPath) || getNameFromPath(currentPath)) + "/";
const allowNew = mode !== "document";
const creatablePageNoun = mode !== "all" ? mode : "page";
const openablePageNoun = mode !== "all" ? mode : "page or document";
return (
<FilterList
placeholder={mode === "page"
? "Page"
: (mode === "meta"
? "#meta page"
: (mode === "document"
? "Document"
: "Any page or Document, also hidden"))}
label="Open"
options={options}
vimMode={vimMode}
darkMode={darkMode}
completer={completer}
phrasePreprocessor={(phrase) => {
phrase = phrase.replaceAll(tagRegex, "").trim();
return phrase;
}}
onKeyPress={(key, text) => {
// Pages cannot start with ^, as documented in Page Name Rules
if (key === "^" && text === "^") {
switch (mode) {
case "page":
onModeSwitch("meta");
break;
case "meta":
onModeSwitch("document");
break;
case "document":
onModeSwitch("all");
break;
case "all":
onModeSwitch("page");
break;
}
}
}}
preFilter={(options, phrase) => {
if (mode === "page") {
const allTags = phrase.match(tagRegex);
if (allTags) {
// Search phrase contains hash tags, let's pre-filter the results based on this
const filterTags = allTags.map((t) => extractHashtag(t));
options = options.filter((page) => {
if (!page.meta.tags) {
return false;
}
return filterTags.every((tag) =>
page.meta.tags.find((itemTag: string) =>
itemTag.startsWith(tag)
)
);
});
}
// Remove pages that are tagged as templates or meta
options = options.filter((page) => !isMetaPageOption(page));
} else if (mode === "meta") {
// Filter on pages tagged with "template" or "meta" prefix
options = options.filter(isMetaPageOption);
}
if (mode !== "all") {
// Filter out hidden pages
options = options.filter((page) =>
!(page.meta.pageDecoration?.hide === true)
);
}
return options;
}}
allowNew={allowNew}
helpText={`Press <code>Enter</code> to open the selected ${openablePageNoun}` +
(allowNew
? `, or <code>Shift-Enter</code> to create a new ${creatablePageNoun} with this exact name.`
: "")}
newHint={`Create ${creatablePageNoun}`}
completePrefix={completePrefix}
onSelect={(opt) => {
if (!opt) {
onNavigate(null);
return;
}
const ref: string | undefined = opt.meta?.ref;
const path = ref ? parseToRef(ref)?.path : null;
const name = path ? getNameFromPath(path) : opt.name;
onNavigate(name);
}}
/>
);
}
function isMetaPageOption(page: FilterOption) {
return page.meta.tags?.includes("template") ||
page.meta.tags?.find((tag: string) => tag.startsWith("meta"));
}