Files
plainleaf/web/components/filter.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

306 lines
9.3 KiB
TypeScript

import type { FeatherProps } from "preact-feather/types";
import type {
CompletionContext,
CompletionResult,
} from "@codemirror/autocomplete";
import type { FunctionalComponent } from "preact";
import { useEffect, useRef, useState } from "preact/hooks";
import type { FilterOption } from "@silverbulletmd/silverbullet/type/client";
import { MiniEditor } from "./mini_editor.tsx";
import { fuzzySearchAndSort } from "../fuse_search.ts";
import { deepEqual } from "../../plug-api/lib/json.ts";
import { AlwaysShownModal } from "./basic_modals.tsx";
export function FilterList({
placeholder,
options,
label,
onSelect,
onKeyPress,
completer,
vimMode,
darkMode,
preFilter,
phrasePreprocessor,
allowNew = false,
helpText = "",
completePrefix,
icon: Icon,
newHint,
}: {
placeholder: string;
options: FilterOption[];
label: string;
onKeyPress?: (key: string, currentText: string) => void;
onSelect: (option: FilterOption | undefined) => void;
preFilter?: (options: FilterOption[], phrase: string) => FilterOption[];
phrasePreprocessor?: (phrase: string) => string;
vimMode: boolean;
darkMode?: boolean;
completer: (context: CompletionContext) => Promise<CompletionResult | null>;
allowNew?: boolean;
completePrefix?: string;
helpText: string;
newHint?: string;
icon?: FunctionalComponent<FeatherProps>;
}) {
const [text, setText] = useState("");
const [matchingOptions, setMatchingOptions] = useState(
fuzzySearchAndSort(
preFilter ? preFilter(options, "") : options,
"",
),
);
const [selectedOption, setSelectionOption] = useState(0);
// Group options by category while preserving Fuse.js order
function groupOptionsByCategory(
options: FilterOption[],
): Array<
{ type: "category"; name: string } | {
type: "option";
option: FilterOption;
originalIndex: number;
}
> {
const grouped: Array<
{ type: "category"; name: string } | {
type: "option";
option: FilterOption;
originalIndex: number;
}
> = [];
const seenCategories = new Set<string>();
let originalIndex = 0;
for (const option of options) {
if (option.category && !seenCategories.has(option.category)) {
seenCategories.add(option.category);
grouped.push({ type: "category", name: option.category });
}
grouped.push({ type: "option", option, originalIndex });
originalIndex++;
}
return grouped;
}
const selectedElementRef = useRef<HTMLDivElement>(null);
function updateFilter(originalPhrase: string) {
const prefilteredOptions = preFilter
? preFilter(options, originalPhrase)
: options;
if (phrasePreprocessor) {
originalPhrase = phrasePreprocessor(originalPhrase);
}
const results = fuzzySearchAndSort(prefilteredOptions, originalPhrase);
const foundExactMatch = !!results.find((result) =>
result.name === originalPhrase
);
if (allowNew && !foundExactMatch && originalPhrase) {
results.splice(1, 0, {
name: originalPhrase,
hint: newHint,
});
}
if (!deepEqual(matchingOptions, results)) {
// Only do this (=> rerender of UI) if the results have changed
setMatchingOptions(results);
setSelectionOption(0);
}
}
useEffect(() => {
updateFilter(text);
}, [options, text]);
useEffect(() => {
function closer() {
onSelect(undefined);
}
document.addEventListener("click", closer);
return () => {
document.removeEventListener("click", closer);
};
}, []);
const returnEl = (
<AlwaysShownModal
onCancel={() => {
onSelect(undefined);
}}
>
<div
className="sb-header"
onClick={(e) => {
// Allow tapping/clicking the header without closing it
e.stopPropagation();
}}
>
<label>{label}</label>
<MiniEditor
text={text}
vimMode={vimMode}
vimStartInInsertMode={true}
focus={true}
darkMode={darkMode}
completer={completer}
placeholderText={placeholder}
onEnter={(_newText, shiftDown) => {
onSelect(
shiftDown
? { name: text, type: "page" }
: matchingOptions[selectedOption],
);
return true;
}}
onEscape={() => {
onSelect(undefined);
}}
onChange={(text) => {
setText(text);
}}
onKeyUp={(view, e) => {
// This event is triggered after the key has been processed by CM already
if (onKeyPress) {
onKeyPress(e.key, view.state.sliceDoc());
}
return false;
}}
onKeyDown={(view, e) => {
if (
e.key === "ArrowUp" ||
e.ctrlKey && e.key === "p"
) {
setSelectionOption(Math.max(0, selectedOption - 1));
} else if (
e.key === "ArrowDown" ||
e.ctrlKey && e.key === "n"
) {
setSelectionOption(
Math.min(matchingOptions.length - 1, selectedOption + 1),
);
} else if (e.key === "PageUp") {
setSelectionOption(Math.max(0, selectedOption - 5));
} else if (e.key === "PageDown") {
setSelectionOption(
Math.min(matchingOptions.length - 1, selectedOption + 5),
);
} else if (e.key === "Home") {
setSelectionOption(0);
} else if (e.key === "End") {
setSelectionOption(matchingOptions.length - 1);
} else if (
(e.key === " ") && completePrefix &&
(view.state.sliceDoc() === "")
) {
setText(completePrefix);
} else {
return false;
}
setTimeout(() => {
selectedElementRef.current?.scrollIntoView({
block: "nearest",
});
});
return true;
}}
/>
</div>
<div
className="sb-help-text"
dangerouslySetInnerHTML={{ __html: helpText }}
>
</div>
<div className="sb-result-list" tabIndex={-1}>
{matchingOptions && matchingOptions.length > 0
? (() => {
const groupedItems = groupOptionsByCategory(matchingOptions);
let optionIndex = 0;
return groupedItems.map((item) => {
if (item.type === "category") {
return (
<div
key={`category-${item.name}`}
className="sb-category-header"
>
{item.name}
</div>
);
} else {
const currentOptionIndex = optionIndex;
optionIndex++;
return (
<div
key={`option-${currentOptionIndex}`}
ref={selectedOption === currentOptionIndex
? selectedElementRef
: undefined}
className={(selectedOption === currentOptionIndex
? "sb-option sb-selected-option"
: "sb-option") +
(item.option.cssClass
? " sb-decorated-object " + item.option.cssClass
: "")}
onMouseMove={() => {
if (selectedOption !== currentOptionIndex) {
setSelectionOption(currentOptionIndex);
}
}}
onClick={(e) => {
e.stopPropagation();
onSelect(item.option);
}}
>
{Icon && (
<span className="sb-icon">
<Icon width={16} height={16} />
</span>
)}
<span className="sb-name">
{(() => {
let displayName = item.option.name;
// Remove category prefix for display (e.g., "Block: Close Sidebar" -> "Close Sidebar")
if (
item.option.category &&
displayName.startsWith(item.option.category + ": ")
) {
displayName = displayName.substring(
item.option.category.length + 2,
);
}
return (item.option.prefix ?? "") + displayName;
})()}
</span>
{item.option.hint && (
<span
className={"sb-hint" +
(item.option.hintInactive ? " sb-hint-inactive" : "")}
>
{item.option.hint}
</span>
)}
<div className="sb-description">
{item.option.description}
</div>
</div>
);
}
});
})()
: null}
</div>
</AlwaysShownModal>
);
return returnEl;
}