9 | {#each $router.path as crumb, i}
10 | {@const crumbsSoFar = $router.path.slice(0, i + 1)}
11 |
12 |
router.navigate(crumbsSoFar)}
15 | in:fly={{ x: -6, duration: 250 }}
16 | out:fly={{ x: -6, duration: 250 }}
17 | >
18 | {crumb}
19 |
20 | {#if i < $router.path.length - 1}
21 |
22 | {/if}
23 | {/each}
24 |
onChange(!isEnabled)}
10 | />
11 |
--------------------------------------------------------------------------------
/src/settings/index.ts:
--------------------------------------------------------------------------------
1 | import { App, PluginSettingTab } from "obsidian";
2 | import { DEFAULT_CALENDARSET_ID } from "src/calendarSetManager";
3 | import type { CalendarSet, PeriodicConfig } from "src/types";
4 | import type { SvelteComponent } from "svelte";
5 |
6 | import type WeeklyNotesPlugin from "../main";
7 | import SettingsRouter from "./pages/Router.svelte";
8 |
9 | export type ILocaleOverride = "system-default" | string;
10 | export type IWeekStartOption =
11 | | "sunday"
12 | | "monday"
13 | | "tuesday"
14 | | "wednesday"
15 | | "thursday"
16 | | "friday"
17 | | "saturday"
18 | | "locale";
19 |
20 | export interface ISettings {
21 | showGettingStartedBanner: boolean;
22 | hasMigratedDailyNoteSettings: boolean;
23 | hasMigratedWeeklyNoteSettings: boolean;
24 | installedVersion: string;
25 |
26 | activeCalendarSet: string;
27 | calendarSets: CalendarSet[];
28 |
29 | enableTimelineComplication: boolean;
30 | }
31 |
32 | export const DEFAULT_SETTINGS: ISettings = {
33 | // Onboarding
34 | installedVersion: "1.0.0-beta3",
35 | showGettingStartedBanner: true,
36 | hasMigratedDailyNoteSettings: false,
37 | hasMigratedWeeklyNoteSettings: false,
38 |
39 | // Configuration / Preferences
40 | activeCalendarSet: DEFAULT_CALENDARSET_ID,
41 | calendarSets: [],
42 | enableTimelineComplication: true,
43 |
44 | // Localization
45 | localeOverride: "system-default",
46 | weekStart: "locale" as IWeekStartOption,
47 | };
48 |
49 | export const DEFAULT_PERIODIC_CONFIG: PeriodicConfig = Object.freeze({
50 | enabled: false,
51 | openAtStartup: false,
52 |
53 | format: "",
54 | templatePath: "",
55 | folder: "",
56 | });
57 |
58 | export class PeriodicNotesSettingsTab extends PluginSettingTab {
59 | private view: SvelteComponent;
60 |
61 | constructor(readonly app: App, readonly plugin: WeeklyNotesPlugin) {
62 | super(app, plugin);
63 | this.plugin = plugin;
64 | }
65 |
66 | display(): void {
67 | this.containerEl.empty();
68 |
69 | this.view = new SettingsRouter({
70 | target: this.containerEl,
71 | props: {
72 | app: this.app,
73 | manager: this.plugin.calendarSetManager,
74 | settings: this.plugin.settings,
75 | },
76 | });
77 | }
78 |
79 | hide() {
80 | super.hide();
81 | this.view.$destroy();
82 | }
83 | }
84 |
--------------------------------------------------------------------------------
/src/settings/pages/Router.svelte:
--------------------------------------------------------------------------------
1 |
28 |
29 |
30 |
31 | {#if $router.path.length > 1}
32 | {#key $router.path[1]}
33 |
34 | {/key}
35 | {:else}
36 |
37 | {/if}
38 |
--------------------------------------------------------------------------------
/src/settings/pages/dashboard/GettingStartedBanner.svelte:
--------------------------------------------------------------------------------
1 |
21 |
22 |
23 |
Getting Started
24 |
25 | {#if hasDailyNotesEnabled}
26 |
27 |
28 |
Daily Notes plugin enabled
29 |
30 | You are currently using the core Daily Notes plugin. You can migrate
31 | your existing settings for a seamless transition to Periodic Notes.
32 |
33 |
34 | If you have an custom hotkeys for daily notes, make sure to update
35 | them to use the corresponding "Periodic Notes" commands.
36 |
37 |
38 |
39 | disableDailyNotesPlugin(app)}>
40 | Disable
41 |
42 |
43 |
44 | {/if}
45 |
46 | {#if !hasDailyNoteSettings}
47 |
48 | With this plugin, you can quickly create and navigate to daily, weekly,
49 | and monthly notes. Enable them below to get started.
50 |
51 | {/if}
52 |
53 |
Dismiss
54 |
55 |
56 |
62 |
--------------------------------------------------------------------------------
/src/settings/stores.ts:
--------------------------------------------------------------------------------
1 | import { writable } from "svelte/store";
2 |
3 | interface IRouter {
4 | path: string[];
5 | eState: Record
;
6 | }
7 |
8 | function createRouter() {
9 | const { subscribe, set, update } = writable({
10 | path: ["Periodic Notes"],
11 | eState: {},
12 | });
13 | return {
14 | subscribe,
15 | set,
16 | navigate: (path: string[], eState?: Record) =>
17 | set({
18 | path,
19 | eState: eState ?? {},
20 | }),
21 | update,
22 | reset: () =>
23 | set({
24 | path: ["Periodic Notes"],
25 | eState: {},
26 | }),
27 | };
28 | }
29 |
30 | export const router = createRouter();
31 |
--------------------------------------------------------------------------------
/src/styles.css:
--------------------------------------------------------------------------------
1 | .periodic-modal {
2 | min-width: 40vw;
3 | }
4 |
5 | .settings-banner {
6 | background-color: var(--background-primary-alt);
7 | border-radius: 8px;
8 | border: 1px solid var(--background-modifier-border);
9 | margin-bottom: 1em;
10 | margin-top: 1em;
11 | padding: 1.5em;
12 | text-align: left;
13 | }
14 |
15 | .settings-banner h3 {
16 | margin-top: 0;
17 | }
18 |
19 | .settings-banner h4 {
20 | margin-bottom: 0.25em;
21 | }
22 |
23 | .has-error {
24 | color: var(--text-error);
25 | }
26 |
27 | input.has-error {
28 | color: var(--text-error);
29 | border-color: var(--text-error);
30 | }
31 |
32 | .periodic-notes-switcher-input-container {
33 | position: relative;
34 | }
35 |
36 | .related-notes-mode-indicator {
37 | color: var(--text-muted);
38 | position: absolute;
39 | top: 10px;
40 | right: 10px;
41 | font-size: 70%;
42 | }
43 |
44 | .suggestion-badge {
45 | background: var(--text-selection);
46 | border-radius: 6px;
47 | color: var(--interactive-accent);
48 | display: inline-block;
49 | font-size: 65%;
50 | font-weight: 500;
51 | line-height: 1.5;
52 | padding: 0.2em 0.6em;
53 | position: absolute;
54 | right: 10px;
55 | top: 6px;
56 | }
57 |
58 | .minimal-theme .suggestion-badge {
59 | padding: 0.1em 0.5em;
60 | right: 36px;
61 | }
62 |
63 | .minimal-theme .related-notes-mode-indicator {
64 | top: 12px;
65 | right: 16px;
66 | }
67 |
--------------------------------------------------------------------------------
/src/switcher/calendarSetSwitcher.ts:
--------------------------------------------------------------------------------
1 | import { App, type FuzzyMatch, FuzzySuggestModal } from "obsidian";
2 | import PeriodicNotesPlugin from "src/main";
3 | import { setActiveSet } from "src/settings/utils";
4 | import type { CalendarSet } from "src/types";
5 |
6 | export class CalendarSetSuggestModal extends FuzzySuggestModal {
7 | constructor(app: App, readonly plugin: PeriodicNotesPlugin) {
8 | super(app);
9 | }
10 |
11 | getItemText(item: CalendarSet): string {
12 | return item.toString();
13 | }
14 |
15 | getItems(): CalendarSet[] {
16 | return this.plugin.calendarSetManager.getCalendarSets();
17 | }
18 |
19 | renderSuggestion(calendarSet: FuzzyMatch, el: HTMLElement) {
20 | el.createDiv({ text: calendarSet.item.id });
21 | }
22 |
23 | async onChooseItem(item: CalendarSet, _evt: MouseEvent | KeyboardEvent): Promise {
24 | this.plugin.settings.update(setActiveSet(item.id));
25 | }
26 | }
27 |
--------------------------------------------------------------------------------
/src/switcher/fileOptionsSwitcher.ts:
--------------------------------------------------------------------------------
1 | import { App, type NLDatesPlugin, Scope, SuggestModal, TFile } from "obsidian";
2 |
3 | interface FileCommandItem {
4 | label: string;
5 | }
6 |
7 | const DEFAULT_INSTRUCTIONS = [
8 | { command: "↑↓", purpose: "to navigate" },
9 | { command: "↵", purpose: "to open" },
10 | { command: "ctrl ↵", purpose: "to open in a new pane" },
11 | { command: "esc", purpose: "to dismiss" },
12 | ];
13 |
14 | interface FileOptionsItem {
15 | label: string;
16 | }
17 |
18 | export class FileOptionsSwitcher extends SuggestModal {
19 | nlDatesPlugin: NLDatesPlugin;
20 |
21 | granularityLabel: HTMLElement;
22 | dailyNotes: Record;
23 | scope: Scope;
24 |
25 | constructor(app: App) {
26 | super(app);
27 |
28 | this.setInstructions(DEFAULT_INSTRUCTIONS);
29 | this.setPlaceholder("Type date to find daily note");
30 |
31 | this.nlDatesPlugin = app.plugins.getPlugin("nldates-obsidian") as NLDatesPlugin;
32 | }
33 |
34 | getSuggestions(query: string): FileCommandItem[] {
35 | return [
36 | {
37 | label: "Delete file",
38 | },
39 | ].filter((item) => item.label.contains(query));
40 | }
41 |
42 | renderSuggestion(value: FileCommandItem, el: HTMLElement) {
43 | el.setText(value.label);
44 | }
45 |
46 | async onChooseSuggestion(_item: FileCommandItem, _evt: MouseEvent | KeyboardEvent) {
47 | // run command
48 | }
49 | }
50 |
--------------------------------------------------------------------------------
/src/switcher/relatedFilesSwitcher.ts:
--------------------------------------------------------------------------------
1 | import { setIcon, App, SuggestModal, TFile } from "obsidian";
2 | import { DEFAULT_FORMAT } from "src/constants";
3 | import type PeriodicNotesPlugin from "src/main";
4 |
5 | import { NLDNavigator, type DateNavigationItem } from "./switcher";
6 |
7 | const DEFAULT_INSTRUCTIONS = [
8 | { command: "*", purpose: "show all notes within this period" },
9 | { command: "↵", purpose: "to open" },
10 | { command: "ctrl ↵", purpose: "to open in a new pane" },
11 | { command: "esc", purpose: "to dismiss" },
12 | ];
13 |
14 | export class RelatedFilesSwitcher extends SuggestModal {
15 | private inputLabel: HTMLElement;
16 | private includeFinerGranularities: boolean;
17 |
18 | constructor(
19 | readonly app: App,
20 | readonly plugin: PeriodicNotesPlugin,
21 | readonly selectedItem: DateNavigationItem,
22 | readonly oldQuery: string
23 | ) {
24 | super(app);
25 |
26 | this.includeFinerGranularities = false;
27 | this.setInstructions(DEFAULT_INSTRUCTIONS);
28 | this.setPlaceholder(`Search notes related to ${selectedItem.label}...`);
29 |
30 | this.inputEl.parentElement?.prepend(
31 | createDiv("periodic-notes-switcher-input-container", (inputContainer) => {
32 | inputContainer.appendChild(this.inputEl);
33 | this.inputLabel = inputContainer.createDiv({
34 | cls: "related-notes-mode-indicator",
35 | text: "Expanded",
36 | });
37 | this.inputLabel.toggleVisibility(false);
38 | })
39 | );
40 |
41 | this.scope.register([], "Tab", (evt: KeyboardEvent) => {
42 | evt.preventDefault();
43 | this.close();
44 | const nav = new NLDNavigator(this.app, this.plugin);
45 | nav.open();
46 |
47 | nav.inputEl.value = oldQuery;
48 | nav.inputEl.dispatchEvent(new Event("input"));
49 | });
50 |
51 | this.scope.register(["Shift"], "8", (evt: KeyboardEvent) => {
52 | evt.preventDefault();
53 | this.includeFinerGranularities = !this.includeFinerGranularities;
54 | this.inputLabel.style.visibility = this.includeFinerGranularities
55 | ? "visible"
56 | : "hidden";
57 | this.inputEl.dispatchEvent(new Event("input"));
58 | });
59 | }
60 |
61 | private getDatePrefixedNotes(
62 | item: DateNavigationItem,
63 | query: string
64 | ): DateNavigationItem[] {
65 | return this.plugin
66 | .getPeriodicNotes(item.granularity, item.date, this.includeFinerGranularities)
67 | .filter((e) => e.matchData.exact === false)
68 | .filter((e) => e.filePath.toLocaleLowerCase().includes(query.toLocaleLowerCase()))
69 | .map((e) => ({
70 | label: e.filePath,
71 | date: e.date,
72 | granularity: e.granularity,
73 | matchData: e.matchData,
74 | }));
75 | }
76 |
77 | getSuggestions(query: string): DateNavigationItem[] {
78 | return this.getDatePrefixedNotes(this.selectedItem, query);
79 | }
80 |
81 | renderSuggestion(value: DateNavigationItem, el: HTMLElement) {
82 | el.setText(value.label);
83 | el.createEl("div", {
84 | cls: "suggestion-note",
85 | text: value.date.format(DEFAULT_FORMAT[value.granularity]),
86 | });
87 | el.createEl("span", { cls: "suggestion-flair", prepend: true }, (el) => {
88 | setIcon(el, `calendar-${value.granularity}`, 16);
89 | });
90 | }
91 |
92 | async onChooseSuggestion(item: DateNavigationItem, evt: MouseEvent | KeyboardEvent) {
93 | const file = this.app.vault.getAbstractFileByPath(item.label);
94 | if (file && file instanceof TFile) {
95 | const inNewSplit = evt.shiftKey;
96 | const leaf = inNewSplit
97 | ? this.app.workspace.splitActiveLeaf()
98 | : this.app.workspace.getUnpinnedLeaf();
99 | await leaf.openFile(file, { active: true });
100 | }
101 | }
102 | }
103 |
--------------------------------------------------------------------------------
/src/timeline/RelativeIcon.svelte:
--------------------------------------------------------------------------------
1 |
11 |
12 | {
6 | getSuggestions(inputStr: string): TFile[] {
7 | const abstractFiles = this.app.vault.getAllLoadedFiles();
8 | const files: TFile[] = [];
9 | const lowerCaseInputStr = inputStr.toLowerCase();
10 |
11 | abstractFiles.forEach((file: TAbstractFile) => {
12 | if (
13 | file instanceof TFile &&
14 | file.extension === "md" &&
15 | file.path.toLowerCase().contains(lowerCaseInputStr)
16 | ) {
17 | files.push(file);
18 | }
19 | });
20 |
21 | return files;
22 | }
23 |
24 | renderSuggestion(file: TFile, el: HTMLElement): void {
25 | el.setText(file.path);
26 | }
27 |
28 | selectSuggestion(file: TFile): void {
29 | this.inputEl.value = file.path;
30 | this.inputEl.trigger("input");
31 | this.close();
32 | }
33 | }
34 |
35 | export class FolderSuggest extends TextInputSuggest {
36 | getSuggestions(inputStr: string): TFolder[] {
37 | const abstractFiles = this.app.vault.getAllLoadedFiles();
38 | const folders: TFolder[] = [];
39 | const lowerCaseInputStr = inputStr.toLowerCase();
40 |
41 | abstractFiles.forEach((folder: TAbstractFile) => {
42 | if (
43 | folder instanceof TFolder &&
44 | folder.path.toLowerCase().contains(lowerCaseInputStr)
45 | ) {
46 | folders.push(folder);
47 | }
48 | });
49 |
50 | return folders;
51 | }
52 |
53 | renderSuggestion(file: TFolder, el: HTMLElement): void {
54 | el.setText(file.path);
55 | }
56 |
57 | selectSuggestion(file: TFolder): void {
58 | this.inputEl.value = file.path;
59 | this.inputEl.trigger("input");
60 | this.close();
61 | }
62 | }
63 |
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "@tsconfig/svelte/tsconfig.json",
3 | "compilerOptions": {
4 | "allowSyntheticDefaultImports": true,
5 | "baseUrl": ".",
6 | "module": "ESNext",
7 | "target": "es6",
8 | "allowJs": true,
9 | "noImplicitAny": true,
10 | "strictNullChecks": true,
11 | "moduleResolution": "node",
12 | "importHelpers": true,
13 | "importsNotUsedAsValues": "remove",
14 | "lib": ["dom", "es5", "scripthost", "es2015"]
15 | },
16 | "include": ["**/*.ts"]
17 | }
18 |
--------------------------------------------------------------------------------
9 |
10 |