-
-
Notifications
You must be signed in to change notification settings - Fork 76
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
9 changed files
with
346 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,17 @@ | ||
| import { fas } from "@fortawesome/free-solid-svg-icons"; | ||
| import { faCopy } from "@fortawesome/free-regular-svg-icons"; | ||
| import { fas } from "@fortawesome/free-solid-svg-icons"; | ||
| import { | ||
| IconDefinition, | ||
| IconName, | ||
| findIconDefinition, | ||
| icon, | ||
| library | ||
| } from "@fortawesome/fontawesome-svg-core"; | ||
|
|
||
| library.add(fas, faCopy); | ||
|
|
||
| export { icon, findIconDefinition }; | ||
| export const iconNames = Object.values(fas).map( | ||
| (i: IconDefinition) => i.iconName | ||
| ); | ||
|
|
||
| export { icon, findIconDefinition, IconName }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,306 @@ | ||
| import { | ||
| App, | ||
| FuzzyMatch, | ||
| FuzzySuggestModal, | ||
| Scope, | ||
| SuggestModal, | ||
| TextComponent | ||
| } from "obsidian"; | ||
| import { createPopper, Instance as PopperInstance } from "@popperjs/core"; | ||
| import { findIconDefinition, icon, IconName } from "./icons"; | ||
|
|
||
| class Suggester<T> { | ||
| owner: SuggestModal<T>; | ||
| items: T[]; | ||
| suggestions: HTMLDivElement[]; | ||
| selectedItem: number; | ||
| containerEl: HTMLElement; | ||
| constructor( | ||
| owner: SuggestModal<T>, | ||
| containerEl: HTMLElement, | ||
| scope: Scope | ||
| ) { | ||
| this.containerEl = containerEl; | ||
| this.owner = owner; | ||
| containerEl.on( | ||
| "click", | ||
| ".suggestion-item", | ||
| this.onSuggestionClick.bind(this) | ||
| ); | ||
| containerEl.on( | ||
| "mousemove", | ||
| ".suggestion-item", | ||
| this.onSuggestionMouseover.bind(this) | ||
| ); | ||
|
|
||
| scope.register([], "ArrowUp", () => { | ||
| this.setSelectedItem(this.selectedItem - 1, true); | ||
| return false; | ||
| }); | ||
|
|
||
| scope.register([], "ArrowDown", () => { | ||
| this.setSelectedItem(this.selectedItem + 1, true); | ||
| return false; | ||
| }); | ||
|
|
||
| scope.register([], "Enter", (evt) => { | ||
| this.useSelectedItem(evt); | ||
| return false; | ||
| }); | ||
|
|
||
| scope.register([], "Tab", (evt) => { | ||
| this.chooseSuggestion(evt); | ||
| return false; | ||
| }); | ||
| } | ||
| chooseSuggestion(evt: KeyboardEvent) { | ||
| if (!this.items || !this.items.length) return; | ||
| const currentValue = this.items[this.selectedItem]; | ||
| if (currentValue) { | ||
| this.owner.onChooseSuggestion(currentValue, evt); | ||
| } | ||
| } | ||
| onSuggestionClick(event: MouseEvent, el: HTMLDivElement): void { | ||
| event.preventDefault(); | ||
| if (!this.suggestions || !this.suggestions.length) return; | ||
|
|
||
| const item = this.suggestions.indexOf(el); | ||
| this.setSelectedItem(item, false); | ||
| this.useSelectedItem(event); | ||
| } | ||
|
|
||
| onSuggestionMouseover(event: MouseEvent, el: HTMLDivElement): void { | ||
| if (!this.suggestions || !this.suggestions.length) return; | ||
| const item = this.suggestions.indexOf(el); | ||
| this.setSelectedItem(item, false); | ||
| } | ||
| empty() { | ||
| this.containerEl.empty(); | ||
| } | ||
| setSuggestions(items: T[]) { | ||
| this.containerEl.empty(); | ||
| const els: HTMLDivElement[] = []; | ||
|
|
||
| items.forEach((item) => { | ||
| const suggestionEl = this.containerEl.createDiv("suggestion-item"); | ||
| this.owner.renderSuggestion(item, suggestionEl); | ||
| els.push(suggestionEl); | ||
| }); | ||
| this.items = items; | ||
| this.suggestions = els; | ||
| this.setSelectedItem(0, false); | ||
| } | ||
| useSelectedItem(event: MouseEvent | KeyboardEvent) { | ||
| if (!this.items || !this.items.length) return; | ||
| const currentValue = this.items[this.selectedItem]; | ||
| if (currentValue) { | ||
| this.owner.selectSuggestion(currentValue, event); | ||
| } | ||
| } | ||
| wrap(value: number, size: number): number { | ||
| return ((value % size) + size) % size; | ||
| } | ||
| setSelectedItem(index: number, scroll: boolean) { | ||
| const nIndex = this.wrap(index, this.suggestions.length); | ||
| const prev = this.suggestions[this.selectedItem]; | ||
| const next = this.suggestions[nIndex]; | ||
|
|
||
| if (prev) prev.removeClass("is-selected"); | ||
| if (next) next.addClass("is-selected"); | ||
|
|
||
| this.selectedItem = nIndex; | ||
|
|
||
| if (scroll) { | ||
| next.scrollIntoView(false); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| export abstract class SuggestionModal<T> extends FuzzySuggestModal<T> { | ||
| items: T[] = []; | ||
| suggestions: HTMLDivElement[]; | ||
| popper: PopperInstance; | ||
| scope: Scope = new Scope(); | ||
| suggester: Suggester<FuzzyMatch<T>>; | ||
| suggestEl: HTMLDivElement; | ||
| promptEl: HTMLDivElement; | ||
| emptyStateText: string = "No match found"; | ||
| limit: number = 100; | ||
| constructor(app: App, inputEl: HTMLInputElement, items: T[]) { | ||
| super(app); | ||
| this.inputEl = inputEl; | ||
| this.items = items; | ||
|
|
||
| this.suggestEl = createDiv("suggestion-container"); | ||
|
|
||
| this.contentEl = this.suggestEl.createDiv("suggestion"); | ||
|
|
||
| this.suggester = new Suggester(this, this.contentEl, this.scope); | ||
|
|
||
| this.scope.register([], "Escape", this.close.bind(this)); | ||
|
|
||
| this.inputEl.addEventListener("input", this.onInputChanged.bind(this)); | ||
| this.inputEl.addEventListener("focus", this.onInputChanged.bind(this)); | ||
| this.inputEl.addEventListener("blur", this.close.bind(this)); | ||
| this.suggestEl.on( | ||
| "mousedown", | ||
| ".suggestion-container", | ||
| (event: MouseEvent) => { | ||
| event.preventDefault(); | ||
| } | ||
| ); | ||
| } | ||
| empty() { | ||
| this.suggester.empty(); | ||
| } | ||
| onInputChanged(): void { | ||
| const inputStr = this.modifyInput(this.inputEl.value); | ||
| const suggestions = this.getSuggestions(inputStr); | ||
| if (suggestions.length > 0) { | ||
| this.suggester.setSuggestions(suggestions.slice(0, this.limit)); | ||
| } else { | ||
| this.onNoSuggestion(); | ||
| } | ||
| this.open(); | ||
| } | ||
|
|
||
| modifyInput(input: string): string { | ||
| return input; | ||
| } | ||
| onNoSuggestion() { | ||
| this.empty(); | ||
| this.renderSuggestion( | ||
| null, | ||
| this.contentEl.createDiv("suggestion-item") | ||
| ); | ||
| } | ||
| open(): void { | ||
| // TODO: Figure out a better way to do this. Idea from Periodic Notes plugin | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| (<any>this.app).keymap.pushScope(this.scope); | ||
|
|
||
| document.body.appendChild(this.suggestEl); | ||
| this.popper = createPopper(this.inputEl, this.suggestEl, { | ||
| placement: "bottom-start", | ||
| modifiers: [ | ||
| { | ||
| name: "offset", | ||
| options: { | ||
| offset: [0, 10] | ||
| } | ||
| }, | ||
| { | ||
| name: "flip", | ||
| options: { | ||
| fallbackPlacements: ["top"] | ||
| } | ||
| } | ||
| ] | ||
| }); | ||
| } | ||
|
|
||
| close(): void { | ||
| // TODO: Figure out a better way to do this. Idea from Periodic Notes plugin | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| (<any>this.app).keymap.popScope(this.scope); | ||
|
|
||
| this.suggester.setSuggestions([]); | ||
| if (this.popper) { | ||
| this.popper.destroy(); | ||
| } | ||
|
|
||
| this.suggestEl.detach(); | ||
| } | ||
| createPrompt(prompts: HTMLSpanElement[]) { | ||
| if (!this.promptEl) | ||
| this.promptEl = this.suggestEl.createDiv("prompt-instructions"); | ||
| let prompt = this.promptEl.createDiv("prompt-instruction"); | ||
| for (let p of prompts) { | ||
| prompt.appendChild(p); | ||
| } | ||
| } | ||
| abstract onChooseItem(item: T, evt: MouseEvent | KeyboardEvent): void; | ||
| abstract getItemText(arg: T): string; | ||
| abstract getItems(): T[]; | ||
| } | ||
|
|
||
| export class IconSuggestionModal extends SuggestionModal<IconName> { | ||
| icons: IconName[]; | ||
| icon: IconName; | ||
| text: TextComponent; | ||
| constructor(app: App, input: TextComponent, items: IconName[]) { | ||
| super(app, input.inputEl, items); | ||
| this.icons = [...items]; | ||
| this.text = input; | ||
|
|
||
| this.createPrompts(); | ||
|
|
||
| this.inputEl.addEventListener("input", this.getItem.bind(this)); | ||
| } | ||
| createPrompts() {} | ||
| getItem() { | ||
| const v = this.inputEl.value, | ||
| icon = this.icons.find((iconName) => iconName === v.trim()); | ||
| if (icon == this.icon) return; | ||
| this.icon = icon; | ||
| if (this.icons) this.onInputChanged(); | ||
| } | ||
| getItemText(item: IconName) { | ||
| return item; | ||
| } | ||
| onChooseItem(item: IconName) { | ||
| this.text.setValue(item); | ||
| this.icon = item; | ||
| } | ||
| selectSuggestion({ item }: FuzzyMatch<IconName>) { | ||
| this.text.setValue(item); | ||
| this.onClose(); | ||
|
|
||
| this.close(); | ||
| } | ||
| renderSuggestion(result: FuzzyMatch<IconName>, el: HTMLElement) { | ||
| let { item, match: matches } = result || {}; | ||
| let content = el.createDiv({ | ||
| cls: "suggestion-content icon" | ||
| }); | ||
| if (!item) { | ||
| content.setText(this.emptyStateText); | ||
| content.parentElement.addClass("is-selected"); | ||
| return; | ||
| } | ||
|
|
||
| const matchElements = matches.matches.map((m) => { | ||
| return createSpan("suggestion-highlight"); | ||
| }); | ||
| for (let i = 0; i < item.length; i++) { | ||
| let match = matches.matches.find((m) => m[0] === i); | ||
| if (match) { | ||
| let element = matchElements[matches.matches.indexOf(match)]; | ||
| content.appendChild(element); | ||
| element.appendText(item.substring(match[0], match[1])); | ||
|
|
||
| i += match[1] - match[0] - 1; | ||
| continue; | ||
| } | ||
|
|
||
| content.appendText(item[i]); | ||
| } | ||
|
|
||
| const iconDiv = createDiv({ | ||
| cls: "suggestion-flair" | ||
| }); | ||
| iconDiv.appendChild( | ||
| icon( | ||
| findIconDefinition({ | ||
| iconName: item, | ||
| prefix: "fas" | ||
| }) | ||
| ).node[0] | ||
| ); | ||
|
|
||
| content.prepend(iconDiv); | ||
| } | ||
| getItems() { | ||
| return this.icons; | ||
| } | ||
| } |
Oops, something went wrong.