Skip to content

Commit

Permalink
setting: refreshInterval
Browse files Browse the repository at this point in the history
  • Loading branch information
@SkepticMystic
SkepticMystic committed Jun 27, 2021
1 parent 6cf73b2 commit c5c46b1
Show file tree
Hide file tree
Showing 3 changed files with 95 additions and 45 deletions.
125 changes: 80 additions & 45 deletions src/BreadcrumbsSettingTab.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ export class BreadcrumbsSettingTab extends PluginSettingTab {
}

display(): void {
const plugin = this.plugin;
const { containerEl } = this;
containerEl.empty();
containerEl.createEl("h2", { text: "Settings for Breadcrumbs plugin." });
Expand All @@ -28,10 +29,10 @@ export class BreadcrumbsSettingTab extends PluginSettingTab {
.addText((text) =>
text
.setPlaceholder("Field name")
.setValue(this.plugin.settings.parentFieldName)
.setValue(plugin.settings.parentFieldName)
.onChange(async (value) => {
this.plugin.settings.parentFieldName = value;
await this.plugin.saveSettings();
plugin.settings.parentFieldName = value;
await plugin.saveSettings();
})
);

Expand All @@ -41,10 +42,10 @@ export class BreadcrumbsSettingTab extends PluginSettingTab {
.addText((text) =>
text
.setPlaceholder("Field name")
.setValue(this.plugin.settings.siblingFieldName)
.setValue(plugin.settings.siblingFieldName)
.onChange(async (value) => {
this.plugin.settings.siblingFieldName = value;
await this.plugin.saveSettings();
plugin.settings.siblingFieldName = value;
await plugin.saveSettings();
})
);

Expand All @@ -54,10 +55,10 @@ export class BreadcrumbsSettingTab extends PluginSettingTab {
.addText((text) =>
text
.setPlaceholder("Field name")
.setValue(this.plugin.settings.childFieldName)
.setValue(plugin.settings.childFieldName)
.onChange(async (value) => {
this.plugin.settings.childFieldName = value;
await this.plugin.saveSettings();
plugin.settings.childFieldName = value;
await plugin.saveSettings();
})
);

Expand All @@ -69,7 +70,7 @@ export class BreadcrumbsSettingTab extends PluginSettingTab {
.addText((text) =>
text
.setPlaceholder("Index Note")
.setValue(this.plugin.settings.indexNote)
.setValue(plugin.settings.indexNote)
.onChange(async (value) => {
if (
!this.app.metadataCache.getFirstLinkpathDest(
Expand All @@ -82,8 +83,44 @@ export class BreadcrumbsSettingTab extends PluginSettingTab {
1000
);
} else {
this.plugin.settings.indexNote = value;
await this.plugin.saveSettings();
plugin.settings.indexNote = value;
await plugin.saveSettings();
}
})
);

new Setting(containerEl)
.setName("Refresh Interval")
.setDesc(
"Enter an integer number of seconds to wait before Breadcrumbs auto-refreshes its data. This would update the matrix view and the trail if either are affected. (Set to 0 to disable autorefreshing)"
)
.addText((text) =>
text
.setPlaceholder("Seconds")
.setValue(plugin.settings.refreshIntervalTime.toString())
.onChange(async (value) => {
clearInterval(plugin.refreshIntervalID);
const num = Number(value);

if (num > 0) {
plugin.settings.refreshIntervalTime = num;
await plugin.saveSettings();

plugin.refreshIntervalID = window.setInterval(async () => {
if (plugin.trailDiv) {
await plugin.drawTrail();
}
if (plugin.matrixView) {
await plugin.matrixView.draw();
}
}, num * 1000);
plugin.registerInterval(plugin.refreshIntervalID);
} else if (num === 0) {
plugin.settings.refreshIntervalTime = num;
await plugin.saveSettings();
clearInterval(plugin.refreshIntervalID);
} else {
new Notice("The interval must be a non-negative number");
}
})
);
Expand All @@ -97,11 +134,11 @@ export class BreadcrumbsSettingTab extends PluginSettingTab {
)
.addToggle((toggle) =>
toggle
.setValue(this.plugin.settings.showNameOrType)
.setValue(plugin.settings.showNameOrType)
.onChange(async (value) => {
this.plugin.settings.showNameOrType = value;
await this.plugin.saveSettings();
await this.plugin.matrixView.draw();
plugin.settings.showNameOrType = value;
await plugin.saveSettings();
await plugin.matrixView.draw();
})
);

Expand All @@ -112,11 +149,11 @@ export class BreadcrumbsSettingTab extends PluginSettingTab {
)
.addToggle((toggle) =>
toggle
.setValue(this.plugin.settings.showRelationType)
.setValue(plugin.settings.showRelationType)
.onChange(async (value) => {
this.plugin.settings.showRelationType = value;
await this.plugin.saveSettings();
await this.plugin.matrixView.draw();
plugin.settings.showRelationType = value;
await plugin.saveSettings();
await plugin.matrixView.draw();
})
);

Expand All @@ -128,25 +165,23 @@ export class BreadcrumbsSettingTab extends PluginSettingTab {
"Show a trail of notes leading from your index note down to the current note you are in (if a path exists)"
)
.addToggle((toggle) =>
toggle
.setValue(this.plugin.settings.showTrail)
.onChange(async (value) => {
this.plugin.settings.showTrail = value;

await this.plugin.saveSettings();
if (value) {
this.plugin.trailDiv = createDiv({
cls: `breadcrumbs-trail is-readable-line-width${
this.plugin.settings.respectReadableLineLength
? " markdown-preview-sizer markdown-preview-section"
: ""
}`,
});
await this.plugin.drawTrail();
} else {
this.plugin.trailDiv.remove();
}
})
toggle.setValue(plugin.settings.showTrail).onChange(async (value) => {
plugin.settings.showTrail = value;

await plugin.saveSettings();
if (value) {
plugin.trailDiv = createDiv({
cls: `breadcrumbs-trail is-readable-line-width${
plugin.settings.respectReadableLineLength
? " markdown-preview-sizer markdown-preview-section"
: ""
}`,
});
await plugin.drawTrail();
} else {
plugin.trailDiv.remove();
}
})
);

new Setting(containerEl)
Expand All @@ -157,10 +192,10 @@ export class BreadcrumbsSettingTab extends PluginSettingTab {
.addText((text) =>
text
.setPlaceholder("→")
.setValue(this.plugin.settings.trailSeperator)
.setValue(plugin.settings.trailSeperator)
.onChange(async (value) => {
this.plugin.settings.trailSeperator = value;
await this.plugin.saveSettings();
plugin.settings.trailSeperator = value;
await plugin.saveSettings();
})
);

Expand All @@ -171,10 +206,10 @@ export class BreadcrumbsSettingTab extends PluginSettingTab {
)
.addToggle((toggle) =>
toggle
.setValue(this.plugin.settings.respectReadableLineLength)
.setValue(plugin.settings.respectReadableLineLength)
.onChange(async (value) => {
this.plugin.settings.respectReadableLineLength = value;
await this.plugin.saveSettings();
plugin.settings.respectReadableLineLength = value;
await plugin.saveSettings();
})
);
}
Expand Down
1 change: 1 addition & 0 deletions src/interfaces.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export interface BreadcrumbsSettings {
siblingFieldName: string;
childFieldName: string;
indexNote: string;
refreshIntervalTime: number;
showNameOrType: boolean;
showRelationType: boolean;
showTrail: boolean;
Expand Down
14 changes: 14 additions & 0 deletions src/main.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ const DEFAULT_SETTINGS: BreadcrumbsSettings = {
siblingFieldName: "sibling",
childFieldName: "child",
indexNote: "Index",
refreshIntervalTime: 0,
showNameOrType: true,
showRelationType: true,
showTrail: true,
Expand All @@ -28,6 +29,7 @@ export default class BreadcrumbsPlugin extends Plugin {
matrixView: MatrixView;
trailDiv: HTMLDivElement;
previewView: HTMLDivElement;
refreshIntervalID: number;

async onload(): Promise<void> {
console.log("loading breadcrumbs plugin");
Expand Down Expand Up @@ -64,6 +66,18 @@ export default class BreadcrumbsPlugin extends Plugin {
})
);

if (this.settings.refreshIntervalTime) {
this.refreshIntervalID = window.setInterval(async () => {
if (this.trailDiv) {
await this.drawTrail();
}
if (this.matrixView) {
await this.matrixView.draw();
}
}, this.settings.refreshIntervalTime * 1000);
this.registerInterval(this.refreshIntervalID);
}

this.addCommand({
id: "show-breadcrumb-matrix-view",
name: "Open Matrix View",
Expand Down

0 comments on commit c5c46b1

Please sign in to comment.