feat: added delay option for the review buttons (#1049)

4Source · web-flow · commit d28ae44967ff · 2024-09-25T12:17:46.000+03:00
* Added delay option for the review buttons

* Fix localization

* Revert indentation

* Fix local fr, tr

* Fix missing reviewButtonDelay
diff --git a/src/gui/flashcard-review-view.tsx b/src/gui/flashcard-review-view.tsx
@@ -1,3 +1,4 @@
+import { now } from "moment";
 import { App, Notice, Platform, setIcon } from "obsidian";
 
 import { RepItemScheduleInfo } from "src/algorithms/base/rep-item-schedule-info";
@@ -46,6 +47,7 @@ export class FlashcardReviewView {
     public goodButton: HTMLButtonElement;
     public easyButton: HTMLButtonElement;
     public answerButton: HTMLButtonElement;
+    public lastPressed: number;
 
     private chosenDeck: Deck | null;
     private reviewSequencer: IFlashcardReviewSequencer;
@@ -303,6 +305,15 @@ export class FlashcardReviewView {
     }
 
     private _showAnswer(): void {
+        const timeNow = now();
+        if (
+            this.lastPressed &&
+            timeNow - this.lastPressed < this.plugin.data.settings.reviewButtonDelay
+        ) {
+            return;
+        }
+        this.lastPressed = timeNow;
+
         this.mode = FlashcardModalMode.Back;
 
         this.resetButton.disabled = false;
@@ -357,6 +368,15 @@ export class FlashcardReviewView {
     }
 
     private async _processReview(response: ReviewResponse): Promise<void> {
+        const timeNow = now();
+        if (
+            this.lastPressed &&
+            timeNow - this.lastPressed < this.plugin.data.settings.reviewButtonDelay
+        ) {
+            return;
+        }
+        this.lastPressed = timeNow;
+
         await this.reviewSequencer.processReview(response);
         await this._handleSkipCard();
     }
diff --git a/src/lang/locale/ar.ts b/src/lang/locale/ar.ts
@@ -81,6 +81,9 @@ export default {
     FLASHCARD_EASY_DESC: '"تخصيص التسمية للزر "سهل',
     FLASHCARD_GOOD_DESC: '"تخصيص التسمية للزر "جيد',
     FLASHCARD_HARD_DESC: '"تخصيص التسمية للزر "صعب',
+    REVIEW_BUTTON_DELAY: "Button press delay (ms)",
+    REVIEW_BUTTON_DELAY_DESC:
+        "Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
     FLASHCARD_TAGS: "وُسوم البطاقات",
     FLASHCARD_TAGS_DESC: "#2أدخل الوُسوم مفصولة بمسافات أو أسطر جديدة ، أي بطاقات# رزمة3# رزمة",
     CONVERT_FOLDERS_TO_DECKS: "تحويل المجلدات إلى ملفات أصلية و ملفات الفرعية؟",
diff --git a/src/lang/locale/cz.ts b/src/lang/locale/cz.ts
@@ -81,6 +81,9 @@ export default {
     FLASHCARD_EASY_DESC: 'Customize the label for the "Easy" Button',
     FLASHCARD_GOOD_DESC: 'Customize the label for the "Good" Button',
     FLASHCARD_HARD_DESC: 'Customize the label for the "Hard" Button',
+    REVIEW_BUTTON_DELAY: "Button press delay (ms)",
+    REVIEW_BUTTON_DELAY_DESC:
+        "Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
     FLASHCARD_TAGS: "Tag pro kartičky",
     FLASHCARD_TAGS_DESC:
         "Zadete tagy oodělené mezerou nebo odřádkováním například. #kartičky #balíčke2 #balíček3.",
diff --git a/src/lang/locale/de.ts b/src/lang/locale/de.ts
@@ -87,6 +87,9 @@ export default {
     FLASHCARD_GOOD_DESC: 'Passe die Beschriftung für "Gut" Knopf an',
     FLASHCARD_EASY_DESC: 'Passe die Beschriftung für "Einfach" Knopf an',
     FLASHCARD_HARD_DESC: 'Passe die Beschriftung für "Schwer" Knopf an',
+    REVIEW_BUTTON_DELAY: "Druckknopfverzögerung (ms)",
+    REVIEW_BUTTON_DELAY_DESC:
+        "Fügt den Überprüfungsschaltflächen („Einfach“, „Gut“, „Schwer“, „Antwort anzeigen“) eine Verzögerung hinzu, bevor sie erneut gedrückt werden können.",
     FLASHCARD_TAGS: "Lernkarten Tags",
     FLASHCARD_TAGS_DESC:
         "Mehrere Tags mit Leerzeichen oder Zeilenumbrüchen getrennt angeben. Bsp. #karte #stapel2 #stapel3.",
diff --git a/src/lang/locale/en.ts b/src/lang/locale/en.ts
@@ -81,6 +81,9 @@ export default {
     FLASHCARD_EASY_DESC: 'Customize the label for the "Easy" Button',
     FLASHCARD_GOOD_DESC: 'Customize the label for the "Good" Button',
     FLASHCARD_HARD_DESC: 'Customize the label for the "Hard" Button',
+    REVIEW_BUTTON_DELAY: "Button press delay (ms)",
+    REVIEW_BUTTON_DELAY_DESC:
+        "Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
     FLASHCARD_TAGS: "Flashcard tags",
     FLASHCARD_TAGS_DESC:
         "Enter tags separated by spaces or newlines i.e. #flashcards #deck2 #deck3.",
diff --git a/src/lang/locale/es.ts b/src/lang/locale/es.ts
@@ -81,6 +81,9 @@ export default {
     FLASHCARD_EASY_DESC: "Personalize la etiqueta para el botón: Fácil",
     FLASHCARD_GOOD_DESC: "Personalize la etiqueta para el botón: Bien",
     FLASHCARD_HARD_DESC: "Personalize la etiqueta para el botón: Difícil",
+    REVIEW_BUTTON_DELAY: "Button press delay (ms)",
+    REVIEW_BUTTON_DELAY_DESC:
+        "Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
     FLASHCARD_TAGS: "Etiquetas de las Tarjetas de Memorización",
     FLASHCARD_TAGS_DESC:
         "Escriba las etiquetas separadas por espacios o saltos de línea, por ejemplo, #memorizar #mazo2 #mazo3",
diff --git a/src/lang/locale/fr.ts b/src/lang/locale/fr.ts
@@ -82,6 +82,9 @@ export default {
     FLASHCARD_EASY_DESC: "Changez le texte du bouton Facile",
     FLASHCARD_GOOD_DESC: "Changez le texte du bouton Correct",
     FLASHCARD_HARD_DESC: "Changez le texte du bouton Difficile",
+    REVIEW_BUTTON_DELAY: "Button press delay (ms)",
+    REVIEW_BUTTON_DELAY_DESC:
+        "Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
     FLASHCARD_TAGS: "Tags des flashcards",
     FLASHCARD_TAGS_DESC:
         "Entrez les tags séparés par un espace ou une ligne i.e. #flashcards #paquet2 #paquet3.",
diff --git a/src/lang/locale/it.ts b/src/lang/locale/it.ts
@@ -82,6 +82,9 @@ export default {
     FLASHCARD_EASY_DESC: 'Personalizza il testo per il pulsante "Facile"',
     FLASHCARD_GOOD_DESC: 'Personalizza il testo per il pulsante "Buono"',
     FLASHCARD_HARD_DESC: 'Personalizza il testo per il pulsante "Difficile"',
+    REVIEW_BUTTON_DELAY: "Button press delay (ms)",
+    REVIEW_BUTTON_DELAY_DESC:
+        "Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
     FLASHCARD_TAGS: "Etichette delle schede",
     FLASHCARD_TAGS_DESC:
         "Inserire etichette separate da spazi o a capi, per esempio #flashcards #deck2 #deck3.",
diff --git a/src/lang/locale/ja.ts b/src/lang/locale/ja.ts
@@ -82,6 +82,9 @@ export default {
     FLASHCARD_EASY_DESC: 'Customize the label for the "Easy" Button',
     FLASHCARD_GOOD_DESC: 'Customize the label for the "Good" Button',
     FLASHCARD_HARD_DESC: 'Customize the label for the "Hard" Button',
+    REVIEW_BUTTON_DELAY: "Button press delay (ms)",
+    REVIEW_BUTTON_DELAY_DESC:
+        "Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
     FLASHCARD_TAGS: "フラッシュカードに使用するタグ",
     FLASHCARD_TAGS_DESC:
         'タグをスペースまたは改行で区切って入力してください。例: "#flashcards #deck2 #deck3"',
diff --git a/src/lang/locale/ko.ts b/src/lang/locale/ko.ts
@@ -81,6 +81,9 @@ export default {
     FLASHCARD_EASY_DESC: 'Customize the label for the "Easy" Button',
     FLASHCARD_GOOD_DESC: 'Customize the label for the "Good" Button',
     FLASHCARD_HARD_DESC: 'Customize the label for the "Hard" Button',
+    REVIEW_BUTTON_DELAY: "Button press delay (ms)",
+    REVIEW_BUTTON_DELAY_DESC:
+        "Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
     FLASHCARD_TAGS: "플래시카드 태그",
     FLASHCARD_TAGS_DESC:
         "태그를 공백 또는 빈 줄로 구분해서 입력해주세요. 예) '#flashcards #deck2 #deck3'",
diff --git a/src/lang/locale/pl.ts b/src/lang/locale/pl.ts
@@ -81,6 +81,9 @@ export default {
     FLASHCARD_EASY_DESC: 'Dostosuj etykietę dla przycisku "Łatwe"',
     FLASHCARD_GOOD_DESC: 'Dostosuj etykietę dla przycisku "Średnio trudne"',
     FLASHCARD_HARD_DESC: 'Dostosuj etykietę dla przycisku "Trudne"',
+    REVIEW_BUTTON_DELAY: "Button press delay (ms)",
+    REVIEW_BUTTON_DELAY_DESC:
+        "Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
     FLASHCARD_TAGS: "Tagi fiszek",
     FLASHCARD_TAGS_DESC:
         "Wprowadź tagi oddzielone spacją lub nowymi liniami, np. #fiszki #talia2 #talia3.",
diff --git a/src/lang/locale/pt-br.ts b/src/lang/locale/pt-br.ts
@@ -83,6 +83,9 @@ export default {
     FLASHCARD_EASY_DESC: 'Customize o rótulo para o botão de "Fácil"',
     FLASHCARD_GOOD_DESC: 'Customize o rótulo para o botão de "OK"',
     FLASHCARD_HARD_DESC: 'Customize o rótulo para o botão de "Difícil"',
+    REVIEW_BUTTON_DELAY: "Button press delay (ms)",
+    REVIEW_BUTTON_DELAY_DESC:
+        "Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
     FLASHCARD_TAGS: "Etiquetas dos Flashcards",
     FLASHCARD_TAGS_DESC:
         "Insira etiquetas separadas por espaços ou quebras de linha ex: #flashcards #baralho2 #baralho3.",
diff --git a/src/lang/locale/ru.ts b/src/lang/locale/ru.ts
@@ -90,6 +90,9 @@ export default {
     FLASHCARD_EASY_DESC: 'Настроить ярлык для кнопки "Легко"',
     FLASHCARD_GOOD_DESC: 'Настроить ярлык для кнопки "Нормально"',
     FLASHCARD_HARD_DESC: 'Настроить ярлык для кнопки "Сложно"',
+    REVIEW_BUTTON_DELAY: "Button press delay (ms)",
+    REVIEW_BUTTON_DELAY_DESC:
+        "Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
     FLASHCARD_TAGS: "Теги карточек",
     FLASHCARD_TAGS_DESC:
         "Укажите теги разделенные Enter-ом или пробелом, например: #flashcards #deck2 #deck3.",
diff --git a/src/lang/locale/tr.ts b/src/lang/locale/tr.ts
@@ -81,6 +81,9 @@ export default {
     FLASHCARD_EASY_DESC: '"Kolay" butonunun metnini özelleştirin',
     FLASHCARD_GOOD_DESC: '"Orta" butonunun metnini özelleştirin',
     FLASHCARD_HARD_DESC: '"Zor" butonunun metnini özelleştirin',
+    REVIEW_BUTTON_DELAY: "Button press delay (ms)",
+    REVIEW_BUTTON_DELAY_DESC:
+        "Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
     FLASHCARD_TAGS: "Flash Kart Etiketleri",
     FLASHCARD_TAGS_DESC:
         "Etiketleri boşluklar veya yeni satırlarla ayırarak girin, örneğin: #flashcards #deck2 #deck3.",
diff --git a/src/lang/locale/zh-cn.ts b/src/lang/locale/zh-cn.ts
@@ -81,6 +81,9 @@ export default {
     FLASHCARD_EASY_DESC: "自定义“简单”按钮的标签",
     FLASHCARD_GOOD_DESC: "自定义“记得”按钮的标签",
     FLASHCARD_HARD_DESC: "自定义“较难”按钮的标签",
+    REVIEW_BUTTON_DELAY: "Button press delay (ms)",
+    REVIEW_BUTTON_DELAY_DESC:
+        "Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
     FLASHCARD_TAGS: "卡片标签",
     FLASHCARD_TAGS_DESC: "输入标签，用空格或新建行分隔，例如：#flashcards #deck2 #deck3.",
     CONVERT_FOLDERS_TO_DECKS: "是否将文件夹内容转换为卡片组和子卡片组？",
diff --git a/src/lang/locale/zh-tw.ts b/src/lang/locale/zh-tw.ts
@@ -81,6 +81,9 @@ export default {
     FLASHCARD_EASY_DESC: "自訂「簡單」按鈕的標籤",
     FLASHCARD_GOOD_DESC: "自訂「記得」按鈕的標籤",
     FLASHCARD_HARD_DESC: "自訂「較難」按鈕的標籤",
+    REVIEW_BUTTON_DELAY: "Button press delay (ms)",
+    REVIEW_BUTTON_DELAY_DESC:
+        "Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
     FLASHCARD_TAGS: "卡片標籤",
     FLASHCARD_TAGS_DESC: "輸入標籤（用空白或換行字元分隔），例如：#flashcards #deck2 #deck3.",
     CONVERT_FOLDERS_TO_DECKS: "是否將資料夾內容轉換為牌組和子牌組？",
diff --git a/src/settings.ts b/src/settings.ts
@@ -11,6 +11,7 @@ export interface SRSettings {
     flashcardEasyText: string;
     flashcardGoodText: string;
     flashcardHardText: string;
+    reviewButtonDelay: number;
     flashcardTags: string[];
     convertFoldersToDecks: boolean;
     cardCommentOnSameLine: boolean;
@@ -62,6 +63,7 @@ export const DEFAULT_SETTINGS: SRSettings = {
     flashcardEasyText: t("EASY"),
     flashcardGoodText: t("GOOD"),
     flashcardHardText: t("HARD"),
+    reviewButtonDelay: 0,
     flashcardTags: ["#flashcards"],
     convertFoldersToDecks: false,
     cardCommentOnSameLine: false,
@@ -818,6 +820,31 @@ export class SRSettingTab extends PluginSettingTab {
                         this.display();
                     });
             });
+
+        new Setting(containerEl)
+            .setName(t("REVIEW_BUTTON_DELAY"))
+            .setDesc(t("REVIEW_BUTTON_DELAY_DESC"))
+            .addSlider((slider) =>
+                slider
+                    .setLimits(0, 5000, 100)
+                    .setValue(this.plugin.data.settings.reviewButtonDelay)
+                    .setDynamicTooltip()
+                    .onChange(async (value) => {
+                        this.plugin.data.settings.reviewButtonDelay = value;
+                        await this.plugin.savePluginData();
+                    }),
+            )
+            .addExtraButton((button) => {
+                button
+                    .setIcon("reset")
+                    .setTooltip(t("RESET_DEFAULT"))
+                    .onClick(async () => {
+                        this.plugin.data.settings.reviewButtonDelay =
+                            DEFAULT_SETTINGS.reviewButtonDelay;
+                        await this.plugin.savePluginData();
+                        this.display();
+                    });
+            });
     }
 
     private async tabAlgorithm(containerEl: HTMLElement): Promise<void> {
