Skip to content

Feature/autocomplete debounce #503

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Feature/autocomplete debounce #503

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f38a827
Implement debouncing for update calls in TextAreaAutoComplete
Immac Sep 24, 2025
b2b658a
Add debounce configuration for TextAreaAutoComplete and adjust defaul…
Immac Sep 25, 2025
509cb0d
Change default debounceMs value from 150 to 75
Immac Sep 25, 2025
9c3a184
Refactor localStorage keys for AutoCompleter to improve consistency a…
Immac Oct 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 47 additions & 18 deletions web/js/autocompleter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,10 +270,13 @@ class CustomWordsDialog extends ComfyDialog {
}
}

const id = "pysssss.AutoCompleter";
// Base key used for all localStorage persisted options for backward compatibility
const baseKey = "pysssss.AutoCompleter";
// Distinct setting id for the enabled toggle to avoid clashes with other dynamic settings systems
const settingId = baseKey + ".Enabled";

app.registerExtension({
name: id,
name: baseKey,
init() {
const STRING = ComfyWidgets.STRING;
const SKIP_WIDGETS = new Set(["ttN xyPlot.x_values", "ttN xyPlot.y_values"]);
Expand Down Expand Up @@ -316,16 +319,16 @@ app.registerExtension({
return r;
};

TextAreaAutoComplete.globalSeparator = localStorage.getItem(id + ".AutoSeparate") ?? ", ";
TextAreaAutoComplete.globalSeparator = localStorage.getItem(baseKey + ".AutoSeparate") ?? ", ";
const enabledSetting = app.ui.settings.addSetting({
id,
id: settingId,
name: "🐍 Text Autocomplete",
defaultValue: true,
type: (name, setter, value) => {
return $el("tr", [
$el("td", [
$el("label", {
for: id.replaceAll(".", "-"),
for: settingId.replaceAll(".", "-"),
textContent: name,
}),
]),
Expand All @@ -340,7 +343,7 @@ app.registerExtension({
},
[
$el("input", {
id: id.replaceAll(".", "-"),
id: settingId.replaceAll(".", "-"),
type: "checkbox",
checked: value,
onchange: (event) => {
Expand Down Expand Up @@ -368,7 +371,7 @@ app.registerExtension({
const checked = !!event.target.checked;
TextAreaAutoComplete.lorasEnabled = checked;
toggleLoras();
localStorage.setItem(id + ".ShowLoras", TextAreaAutoComplete.lorasEnabled);
localStorage.setItem(baseKey + ".ShowLoras", TextAreaAutoComplete.lorasEnabled);
},
}),
]
Expand All @@ -388,7 +391,7 @@ app.registerExtension({
onchange: (event) => {
const checked = !!event.target.checked;
TextAreaAutoComplete.globalSeparator = checked ? ", " : "";
localStorage.setItem(id + ".AutoSeparate", TextAreaAutoComplete.globalSeparator);
localStorage.setItem(baseKey + ".AutoSeparate", TextAreaAutoComplete.globalSeparator);
},
}),
]
Expand All @@ -408,7 +411,7 @@ app.registerExtension({
onchange: (event) => {
const checked = !!event.target.checked;
TextAreaAutoComplete.replacer = checked ? (v) => v.replaceAll("_", " ") : undefined;
localStorage.setItem(id + ".ReplaceUnderscore", checked);
localStorage.setItem(baseKey + ".ReplaceUnderscore", checked);
},
}),
]
Expand Down Expand Up @@ -438,7 +441,7 @@ app.registerExtension({
onchange: (event) => {
const checked = !!event.target.checked;
TextAreaAutoComplete.insertOnTab = checked;
localStorage.setItem(id + ".InsertOnTab", checked);
localStorage.setItem(baseKey + ".InsertOnTab", checked);
},
}),
]
Expand All @@ -459,7 +462,7 @@ app.registerExtension({
onchange: (event) => {
const checked = !!event.target.checked;
TextAreaAutoComplete.insertOnEnter = checked;
localStorage.setItem(id + ".InsertOnEnter", checked);
localStorage.setItem(baseKey + ".InsertOnEnter", checked);
},
}),
]
Expand All @@ -484,7 +487,32 @@ app.registerExtension({
onchange: (event) => {
const value = +event.target.value;
TextAreaAutoComplete.suggestionCount = value;;
localStorage.setItem(id + ".SuggestionCount", TextAreaAutoComplete.suggestionCount);
localStorage.setItem(baseKey + ".SuggestionCount", TextAreaAutoComplete.suggestionCount);
},
}),
]
),
$el(
"label",
{
textContent: "Debounce in ms: ",
style: {
display: "block",
},
},
[
$el("input", {
type: "number",
value: +TextAreaAutoComplete.debounceMs || 75,
min: 0,
step: 10,
style: {
width: "80px"
},
onchange: (event) => {
const value = Math.max(0, +event.target.value || 0);
TextAreaAutoComplete.debounceMs = value;
localStorage.setItem(baseKey + ".DebounceMs", value);
},
}),
]
Expand Down Expand Up @@ -520,12 +548,13 @@ app.registerExtension({
},
});

TextAreaAutoComplete.enabled = enabledSetting.value;
TextAreaAutoComplete.replacer = localStorage.getItem(id + ".ReplaceUnderscore") === "true" ? (v) => v.replaceAll("_", " ") : undefined;
TextAreaAutoComplete.insertOnTab = localStorage.getItem(id + ".InsertOnTab") !== "false";
TextAreaAutoComplete.insertOnEnter = localStorage.getItem(id + ".InsertOnEnter") !== "false";
TextAreaAutoComplete.lorasEnabled = localStorage.getItem(id + ".ShowLoras") === "true";
TextAreaAutoComplete.suggestionCount = +localStorage.getItem(id + ".SuggestionCount") || 20;
TextAreaAutoComplete.enabled = enabledSetting?.value ?? true;
TextAreaAutoComplete.replacer = localStorage.getItem(baseKey + ".ReplaceUnderscore") === "true" ? (v) => v.replaceAll("_", " ") : undefined;
TextAreaAutoComplete.insertOnTab = localStorage.getItem(baseKey + ".InsertOnTab") !== "false";
TextAreaAutoComplete.insertOnEnter = localStorage.getItem(baseKey + ".InsertOnEnter") !== "false";
TextAreaAutoComplete.lorasEnabled = localStorage.getItem(baseKey + ".ShowLoras") === "true";
TextAreaAutoComplete.suggestionCount = +localStorage.getItem(baseKey + ".SuggestionCount") || 20;
TextAreaAutoComplete.debounceMs = +localStorage.getItem(baseKey + ".DebounceMs") || 75;
},
setup() {
async function addEmbeddings() {
Expand Down
13 changes: 11 additions & 2 deletions web/js/common/autocomplete.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,10 +390,19 @@ export class TextAreaAutoComplete {
this.dropdown = $el("div.pysssss-autocomplete");
this.overrideWords = words;
this.overrideSeparator = separator;
this.debouncedUpdate = this.#debounce(this.#update.bind(this), 75);

this.#setup();
}

#debounce(func, delay) {
let timeout;
return (...args) => {
clearTimeout(timeout);
timeout = setTimeout(() => func.apply(this, args), delay);
};
}

#setup() {
this.el.addEventListener("keydown", this.#keyDown.bind(this));
this.el.addEventListener("keypress", this.#keyPress.bind(this));
Expand Down Expand Up @@ -457,7 +466,7 @@ export class TextAreaAutoComplete {
}

if (!e.defaultPrevented) {
this.#update();
this.debouncedUpdate();
}
}

Expand All @@ -475,7 +484,7 @@ export class TextAreaAutoComplete {
return;
}
if (!e.defaultPrevented) {
this.#update();
this.debouncedUpdate();
}
}

Expand Down