Skip to content

Commit

Permalink
add suggest text field
Browse files Browse the repository at this point in the history
  • Loading branch information
Vinzent03 committed Mar 31, 2021
1 parent 4450397 commit ebbf044
Show file tree
Hide file tree
Showing 5 changed files with 270 additions and 12 deletions.
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"typescript": "^4.0.3"
},
"dependencies": {
"@popperjs/core": "^2.9.1",
"pdfjs-dist": "^2.5.207"
}
}
8 changes: 4 additions & 4 deletions rollup.config.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import typescript from '@rollup/plugin-typescript';
import {nodeResolve} from '@rollup/plugin-node-resolve';
import commonjs from '@rollup/plugin-commonjs';
import { nodeResolve } from '@rollup/plugin-node-resolve';
import typescript from '@rollup/plugin-typescript';

export default {
input: 'main.ts',
input: 'src/main.ts',
output: {
dir: '.',
sourcemap: 'inline',
Expand All @@ -13,7 +13,7 @@ export default {
external: ['obsidian'],
plugins: [
typescript(),
nodeResolve({browser: true}),
nodeResolve({ browser: true }),
commonjs(),
]
};
62 changes: 62 additions & 0 deletions src/file-suggest.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
import { TAbstractFile, TFile, TFolder } from "obsidian";
import { TextInputSuggest } from "./suggest";


export class FileSuggest extends TextInputSuggest<TFile> {
getSuggestions(inputStr: string): TFile[] {
const abstractFiles = this.app.vault.getAllLoadedFiles();
const files: TFile[] = [];
const lowerCaseInputStr = inputStr.toLowerCase();

abstractFiles.forEach((file: TAbstractFile) => {
if (
file instanceof TFile &&
file.extension === "md" &&
file.path.toLowerCase().contains(lowerCaseInputStr)
) {
files.push(file);
}
});

return files;
}

renderSuggestion(file: TFile, el: HTMLElement): void {
el.setText(file.path);
}

selectSuggestion(file: TFile): void {
this.inputEl.value = file.path;
this.inputEl.trigger("input");
this.close();
}
}

export class FolderSuggest extends TextInputSuggest<TFolder> {
getSuggestions(inputStr: string): TFolder[] {
const abstractFiles = this.app.vault.getAllLoadedFiles();
const folders: TFolder[] = [];
const lowerCaseInputStr = inputStr.toLowerCase();

abstractFiles.forEach((folder: TAbstractFile) => {
if (
folder instanceof TFolder &&
folder.path.toLowerCase().contains(lowerCaseInputStr)
) {
folders.push(folder);
}
});

return folders;
}

renderSuggestion(file: TFolder, el: HTMLElement): void {
el.setText(file.path);
}

selectSuggestion(file: TFolder): void {
this.inputEl.value = file.path;
this.inputEl.trigger("input");
this.close();
}
}
22 changes: 14 additions & 8 deletions main.ts → src/main.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { App, Plugin, PluginSettingTab, Setting } from 'obsidian';
import { FileSuggest } from './file-suggest';
interface MyPluginSettings {
files: string[];
}
Expand Down Expand Up @@ -69,18 +70,23 @@ class SettingsTab extends PluginSettingTab {
this.addTextField(index, this.plugin.settings.files[index]);
index++;
}

}
addTextField(index: number, text: string = "") {
new Setting(this.containerEl)
.setName("File to open with command")
.setDesc("With file extension!")
.addText(cb => cb
.setPlaceholder("Directory/file.md")
.setValue(this.plugin.settings.files[index])
.setValue(text)
.onChange((value) => {
this.plugin.settings.files[index] = value;
this.plugin.saveSettings();
}));
.addText(cb => {
new FileSuggest(this.app, cb.inputEl);
cb
.setPlaceholder("Directory/file.md")
.setValue(this.plugin.settings.files[index])
.setValue(text)
.onChange((value) => {
this.plugin.settings.files[index] = value;
this.plugin.saveSettings();
});
});

}
}
189 changes: 189 additions & 0 deletions src/suggest.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@

import { createPopper, Instance as PopperInstance } from "@popperjs/core";
import { App, ISuggestOwner, Scope } from "obsidian";


class Suggest<T> {
private owner: ISuggestOwner<T>;
private values: T[];
private suggestions: HTMLDivElement[];
private selectedItem: number;
private containerEl: HTMLElement;

constructor(owner: ISuggestOwner<T>, containerEl: HTMLElement, scope: Scope) {
this.owner = owner;
this.containerEl = containerEl;

containerEl.on(
"click",
".suggestion-item",
this.onSuggestionClick.bind(this)
);
containerEl.on(
"mousemove",
".suggestion-item",
this.onSuggestionMouseover.bind(this)
);

scope.register([], "ArrowUp", (event) => {
if (!event.isComposing) {
this.setSelectedItem(this.selectedItem - 1, true);
return false;
}
});

scope.register([], "ArrowDown", (event) => {
if (!event.isComposing) {
this.setSelectedItem(this.selectedItem + 1, true);
return false;
}
});

scope.register([], "Enter", (event) => {
if (!event.isComposing) {
this.useSelectedItem(event);
return false;
}
});
}

onSuggestionClick(event: MouseEvent, el: HTMLDivElement): void {
event.preventDefault();

const item = this.suggestions.indexOf(el);
this.setSelectedItem(item, false);
this.useSelectedItem(event);
}

onSuggestionMouseover(_event: MouseEvent, el: HTMLDivElement): void {
const item = this.suggestions.indexOf(el);
this.setSelectedItem(item, false);
}

setSuggestions(values: T[]) {
this.containerEl.empty();
const suggestionEls: HTMLDivElement[] = [];

values.forEach((value) => {
const suggestionEl = this.containerEl.createDiv("suggestion-item");
this.owner.renderSuggestion(value, suggestionEl);
suggestionEls.push(suggestionEl);
});

this.values = values;
this.suggestions = suggestionEls;
this.setSelectedItem(0, false);
}

useSelectedItem(event: MouseEvent | KeyboardEvent) {
const currentValue = this.values[this.selectedItem];
if (currentValue) {
this.owner.selectSuggestion(currentValue, event);
}
}

setSelectedItem(selectedIndex: number, scrollIntoView: boolean) {
const normalizedIndex = this.wrapAround(selectedIndex, this.suggestions.length);
const prevSelectedSuggestion = this.suggestions[this.selectedItem];
const selectedSuggestion = this.suggestions[normalizedIndex];

prevSelectedSuggestion?.removeClass("is-selected");
selectedSuggestion?.addClass("is-selected");

this.selectedItem = normalizedIndex;

if (scrollIntoView) {
selectedSuggestion.scrollIntoView(false);
}
}
wrapAround = (value: number, size: number): number => {
return ((value % size) + size) % size;
};
}

export abstract class TextInputSuggest<T> implements ISuggestOwner<T> {
protected app: App;
protected inputEl: HTMLInputElement;

private popper: PopperInstance;
private scope: Scope;
private suggestEl: HTMLElement;
private suggest: Suggest<T>;

constructor(app: App, inputEl: HTMLInputElement) {
this.app = app;
this.inputEl = inputEl;
this.scope = new Scope();

this.suggestEl = createDiv("suggestion-container");
const suggestion = this.suggestEl.createDiv("suggestion");
this.suggest = new Suggest(this, suggestion, 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();
}
);
}

onInputChanged(): void {
const inputStr = this.inputEl.value;
const suggestions = this.getSuggestions(inputStr);

if (suggestions.length > 0) {
this.suggest.setSuggestions(suggestions);
// eslint-disable-next-line @typescript-eslint/no-explicit-any
this.open((<any>this.app).dom.appContainerEl, this.inputEl);
}
}

open(container: HTMLElement, inputEl: HTMLElement): void {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(<any>this.app).keymap.pushScope(this.scope);

container.appendChild(this.suggestEl);
this.popper = createPopper(inputEl, this.suggestEl, {
placement: "bottom-start",
modifiers: [
{
name: "sameWidth",
enabled: true,
fn: ({ state, instance }) => {
// Note: positioning needs to be calculated twice -
// first pass - positioning it according to the width of the popper
// second pass - position it with the width bound to the reference element
// we need to early exit to avoid an infinite loop
const targetWidth = `${state.rects.reference.width}px`;
if (state.styles.popper.width === targetWidth) {
return;
}
state.styles.popper.width = targetWidth;
instance.update();
},
phase: "beforeWrite",
requires: ["computeStyles"],
},
],
});
}

close(): void {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(<any>this.app).keymap.popScope(this.scope);

this.suggest.setSuggestions([]);
this.popper.destroy();
this.suggestEl.detach();
}

abstract getSuggestions(inputStr: string): T[];
abstract renderSuggestion(item: T, el: HTMLElement): void;
abstract selectSuggestion(item: T): void;
}

0 comments on commit ebbf044

Please sign in to comment.