Skip to content

SmythOS Studio: Open-Source Visual AI Agent Builder and deployable runtime stack from SmythOS. Start with an intuitive drag-and-drop workspace, extend with custom code, and deploy your agents anywhere — local, cloud, or edge — with full governance and control.

Refactor component settings handling to improve unsaved changes prompt and button visibility. Replace 'save-btn' with 'action-save' across various components for consistency. Enhance settings change detection using lodash's isEqual for better comparison accuracy.

Muhammad Hamza Khan9cbf7f2e92c2
diff --git a/packages/app/src/builder-ui/components/Component.class/index.ts b/packages/app/src/builder-ui/components/Component.class/index.ts
index add89691..27f22bba 100644
--- a/packages/app/src/builder-ui/components/Component.class/index.ts
+++ b/packages/app/src/builder-ui/components/Component.class/index.ts
@@ -12,6 +12,7 @@ import { ComponentDocLinks } from '@src/builder-ui/enums/doc-links.enum';
import { errorToast, successToast } from '@src/shared/components/toast';
import { SMYTHOS_DOCS_URL } from '@src/shared/constants/general';
import { jsonrepair } from 'jsonrepair';
+import { isEqual } from 'lodash-es';
import { TooltipV2 } from '../../../react/shared/components/_legacy/ui/tooltip/tooltipV2';
import config, { COMP_NAMES } from '../../config';
import { BINARY_INPUT_TYPES } from '../../constants';
@@ -1770,16 +1771,23 @@ export class Component extends EventEmitter {
const form = document.querySelector(`#right-sidebar form.Settings`);
if (!form) return false;
const values = readFormValues(form, entries);
- console.log('settingsChanged()', values, entries);
if (this.properties.template) {
const templateData = this.data._templateVars;
for (let name in entries) {
- if (templateData[name] !== undefined && templateData[name] != values[name]) return true;
+ if (
+ Object.prototype.hasOwnProperty.call(templateData, name) &&
+ !isEqual(templateData[name], values[name])
+ )
+ return true;
}
} else {
for (let name in entries) {
- if (this.data[name] !== undefined && this.data[name] != values[name]) return true;
+ if (
+ Object.prototype.hasOwnProperty.call(this.data, name) &&
+ !isEqual(this.data[name], values[name])
+ )
+ return true;
}
}
}
@@ -2387,11 +2395,26 @@ export class Component extends EventEmitter {
); // checkVisibility is not available in safari <= 17.3
if (dbgElements.length > 0) return;
- if (!this.settingsOpen && this.loadingIcon) this.loadingIcon?.classList?.remove('hidden');
-
if (Component.curComponentSettings && Component.curComponentSettings !== this) {
- await Component.curComponentSettings.confirmSaveSettings();
+ const hasChanges = Component.curComponentSettings.settingsChanged();
+ if (hasChanges) {
+ // If another component settings is open with changes, prompt to discard
+ const discard = await confirm(
+ 'You have unsaved changes',
+ 'Are you sure you want to close this without saving?',
+ {
+ btnNoLabel: 'Cancel',
+ btnYesLabel: 'Discard Changes',
+ btnNoClass: 'h-[48px] rounded-lg px-8',
+ btnYesClass: 'h-[48px] rounded-lg px-8',
+ },
+ );
+ if (!discard) return;
+ }
}
+
+ if (!this.settingsOpen && this.loadingIcon) this.loadingIcon?.classList?.remove('hidden');
+
if (this.settingsOpen) {
this.closeSettings();
} else {
diff --git a/packages/app/src/builder-ui/components/Component.class/settings-editor.ts b/packages/app/src/builder-ui/components/Component.class/settings-editor.ts
index 7de5fe29..cf328fa4 100644
--- a/packages/app/src/builder-ui/components/Component.class/settings-editor.ts
+++ b/packages/app/src/builder-ui/components/Component.class/settings-editor.ts
@@ -1,9 +1,14 @@
import { errorToast, successToast } from '@src/shared/components/toast';
import { Component } from '.';
-import { closeRightSidebar, readRightSidebarValues, sidebarEditValues } from '../../ui/dialogs';
+import {
+ closeRightSidebar,
+ confirm,
+ readRightSidebarValues,
+ sidebarEditValues,
+} from '../../ui/dialogs';
import { setReadonlyMode } from '../../ui/dom';
import { readFormValues, syncCompositeValues } from '../../ui/form';
-import { debounce, delay, dispatchSubmitEvent } from '../../utils';
+import { delay, dispatchSubmitEvent } from '../../utils';
async function onComponentLoad(sidebar) {
const component = this;
@@ -31,42 +36,31 @@ async function onComponentLoad(sidebar) {
if (component.workspace?.locked) {
setReadonlyMode(sidebar, ['close-btn', 'action-help']);
- sidebar.querySelector('.save-btn').classList.add('hidden');
+ sidebar.querySelector('.action-save').classList.add('hidden');
sidebar.querySelector('.del-btn').classList.add('hidden');
} else {
- sidebar.querySelector('.save-btn').classList.remove('hidden');
+ // Always hide the top save button for manual save/cancel flow
+ sidebar.querySelector('.action-save').classList.add('hidden');
sidebar.querySelector('.del-btn').classList.remove('hidden');
+ sidebar.querySelector('.close-btn').classList.remove('hidden');
}
const form = sidebar.querySelector('form');
- function handleChange(event) {
- //console.log('Value changed to:', event.target.value);
- writeSettings(component);
- }
+ // Helper: toggle bottom Save/Cancel visibility based on changes
+ const setBottomActionsVisibility = (visible: boolean) => {
+ const actionsRoot = sidebar.querySelector('.actions .action-content');
+ if (!actionsRoot) return;
+ const btnSave = actionsRoot.querySelector('.action-save') as HTMLElement;
+ const btnCancel = actionsRoot.querySelector('.action-cancel') as HTMLElement;
+ if (btnSave) btnSave.classList[visible ? 'remove' : 'add']('hidden');
+ if (btnCancel) btnCancel.classList[visible ? 'remove' : 'add']('hidden');
+ };
- // Debounced version of handleChange
- const debouncedHandleChange = debounce(handleChange, 500);
+ // Initialize bottom actions hidden until there is a change
+ setBottomActionsVisibility(false);
- // Event listener for dynamically loaded inputs and textareas
- form.addEventListener('input', function (event: any) {
- if (event.target.tagName === 'INPUT' || event.target.tagName === 'TEXTAREA') {
- debouncedHandleChange(event);
- //writeSettings(component);
- }
- });
-
- // Event listener for dynamically loaded checkboxes, radio buttons, and selects
- form.addEventListener('change', function (event: any) {
- if (
- event.target.tagName === 'SELECT' ||
- (event.target.tagName === 'INPUT' &&
- (event.target.type === 'checkbox' || event.target.type === 'radio'))
- ) {
- debouncedHandleChange(event);
- //writeSettings(component);
- }
- });
+ // Keep dynamic draft updates handled by sidebarEditValues(onDraft). Do not write to component data on input/change.
component.emit('settingsOpened', sidebar, this);
if (this.loadingIcon) {
@@ -93,7 +87,7 @@ function onTemplateCreateLoad(sidebar) {
const closeButton: HTMLButtonElement = titleRightActions.querySelector('button.close-btn');
closeButton.classList.remove('hidden');
- const saveButton: HTMLButtonElement = titleRightActions.querySelector('button.save-btn');
+ const saveButton: HTMLButtonElement = titleRightActions.querySelector('button.action-save');
saveButton.classList.add('hidden');
const deleteButton: HTMLButtonElement = actionElement.querySelector('button.del-btn');
@@ -283,9 +277,11 @@ async function onSave(values) {
component.emit('settingsSaved', settingsValues);
// Also dispatch a global event for tracking
- document.dispatchEvent(new CustomEvent('componentSettingsSaved', {
- detail: { componentId: component.uid, settings: settingsValues }
- }));
+ document.dispatchEvent(
+ new CustomEvent('componentSettingsSaved', {
+ detail: { componentId: component.uid, settings: settingsValues },
+ }),
+ );
component.emit('settingsClosed');
//component.redrawSettings();
@@ -375,15 +371,23 @@ export async function writeSettings(component: Component) {
export async function closeSettings(component: Component, force = false) {
const changed = component.settingsChanged();
if (!force && changed) {
- await component.confirmSaveSettings();
+ const discard = await confirm(
+ 'You have unsaved changes',
+ 'Are you sure you want to close this without saving?',
+ {
+ btnNoLabel: 'Cancel',
+ btnYesLabel: 'Discard Changes',
+ btnNoClass: 'h-[48px] rounded-lg px-8',
+ btnYesClass: 'h-[48px] rounded-lg px-8',
+ },
+ );
+ if (!discard) return;
await delay(100);
}
- //if (force || !this.settingsChanged()) {
await closeRightSidebar();
Component.curComponentSettings = null;
component.domElement.classList.remove('active');
- //}
}
export async function editSettings(component: Component) {
Component.curComponentSettings = component;
@@ -435,11 +439,50 @@ export async function editSettings(component: Component) {
//const displayName = component.properties?.template?.name || component.drawSettings.displayName;
const templateName = component.properties?.template?.templateInfo?.name || component.title || '';
- const onBeforeCancel = async () => {
- const saved = await component.confirmSaveSettings();
+ // Separate cancel handlers for template vs component settings flows
+ const onBeforeCancelTemplate = async (_sidebar?: any): Promise<boolean> => {
+ // Keep template flow as-is (legacy behavior)
+ const _ = await component.confirmSaveSettings();
return true;
};
+ const onBeforeCancelSettings = async (_sidebar?: any): Promise<boolean> => {
+ // Prompt to discard if there are unsaved changes
+ const changed = component.settingsChanged();
+ if (!changed) return true;
+ // Hide buttons if we are prompting
+ const sb = document.querySelector('#right-sidebar');
+ if (sb) {
+ const actionsRoot = sb.querySelector('.actions .action-content');
+ actionsRoot &&
+ actionsRoot
+ .querySelectorAll('.action-save, .action-cancel')
+ .forEach((e) => e.classList.add('hidden'));
+ }
+ const discard = await confirm(
+ 'You have unsaved changes',
+ 'Are you sure you want to close this without saving?',
+ {
+ btnNoLabel: 'Cancel',
+ btnYesLabel: 'Discard Changes',
+ btnNoClass: 'h-[48px] rounded-lg px-8',
+ btnYesClass: 'h-[48px] rounded-lg px-8',
+ },
+ );
+ // Re-evaluate visibility after prompt
+ if (sb) {
+ const actionsRoot = sb.querySelector('.actions .action-content');
+ const hasChanges = component.settingsChanged();
+ if (actionsRoot) {
+ const saveBtn = actionsRoot.querySelector('.action-save') as HTMLElement;
+ const cancelBtn = actionsRoot.querySelector('.action-cancel') as HTMLElement;
+ saveBtn && saveBtn.classList[hasChanges ? 'remove' : 'add']('hidden');
+ cancelBtn && cancelBtn.classList[hasChanges ? 'remove' : 'add']('hidden');
+ }
+ }
+ return !!discard;
+ };
+
const onCancel = () => {
Component.curComponentSettings = null;
component.emit('settingsClosed');
@@ -853,9 +896,8 @@ export async function editSettings(component: Component) {
component.title = templateData.templateInfo.name;
component.description = templateData.templateInfo.description;
- component.domElement.querySelector(
- '.internal-name',
- ).textContent = `T: ${templateData.templateInfo.name}`;
+ component.domElement.querySelector('.internal-name').textContent =
+ `T: ${templateData.templateInfo.name}`;
const titleBar = component.domElement.querySelector('.title-bar');
if (titleBar) {
titleBar.querySelector('.title .text').textContent =
@@ -931,7 +973,7 @@ export async function editSettings(component: Component) {
features: { templateVars: true },
actions: createTemplateActions,
onSave: onSave.bind(component),
- onBeforeCancel,
+ onBeforeCancel: onBeforeCancelTemplate,
onCancel,
onLoad: onTemplateCreateLoad.bind(component),
});
@@ -956,14 +998,54 @@ export async function editSettings(component: Component) {
helpTooltip = '';
}
//show settings
+ // Build bottom actions (Cancel/Save) for component settings
+ const bottomActions = {
+ cancel: {
+ type: 'button',
+ label: 'Cancel',
+ class:
+ 'action-cancel items-center ml-2 py-2 text-sm font-medium text-gray-500 bg-transparent hover:text-gray-900 hidden',
+ click: () => {
+ const closeBtn: HTMLButtonElement = document.querySelector(
+ '#right-sidebar .close-btn',
+ ) as HTMLButtonElement;
+ closeBtn && closeBtn.click();
+ },
+ },
+ save: {
+ type: 'button',
+ label: 'Save',
+ class:
+ 'action-save items-center py-2 text-sm font-medium bg-transparent text-blue-500 hover:text-blue-600 hidden',
+ click: () => {},
+ },
+ };
+
+ // Merge template action (if any) with bottom actions
+ const mergedActions = sidebarActions ? { ...sidebarActions, ...bottomActions } : bottomActions;
+
sidebarEditValues({
title: sidebarTitleHTML,
entriesObject: { Settings: component.settingsEntries },
features: { templateVars: true },
- actions: sidebarActions,
+ actions: mergedActions,
onSave: onSave.bind(component),
- onDraft: onDraft.bind(component),
- onBeforeCancel,
+ onDraft: async function (values) {
+ await onDraft.apply(component, [values]);
+ // Show/hide bottom Save/Cancel based on changes
+ const visible = component.settingsChanged();
+ const sb = document.querySelector('#right-sidebar');
+ if (sb) {
+ const actionsRoot = sb.querySelector('.actions .action-content');
+ if (actionsRoot) {
+ const saveBtn = actionsRoot.querySelector('.action-save') as HTMLElement;
+ const cancelBtn = actionsRoot.querySelector('.action-cancel') as HTMLElement;
+ saveBtn && saveBtn.classList[visible ? 'remove' : 'add']('hidden');
+ cancelBtn && cancelBtn.classList[visible ? 'remove' : 'add']('hidden');
+ }
+ }
+ },
+ onBeforeCancel: onBeforeCancelSettings,
onCancel,
onLoad: onComponentLoad.bind(component),
helpTooltip: helpTooltip,
diff --git a/packages/app/src/builder-ui/ui/dialogs.ts b/packages/app/src/builder-ui/ui/dialogs.ts
index fefd7869..246c928c 100644
--- a/packages/app/src/builder-ui/ui/dialogs.ts
+++ b/packages/app/src/builder-ui/ui/dialogs.ts
@@ -112,7 +112,7 @@ export async function createRightSidebar(title?, content?, actions?, trActions?,
const titleRightActions = rightSidebar.querySelector('.title-right-buttons');
const titleLeftActions = rightSidebar.querySelector('.title-left-buttons');
const closeBtn: HTMLButtonElement = rightSidebar.querySelector('.close-btn');
- const saveBtn: HTMLButtonElement = rightSidebar.querySelector('.save-btn');
+ const saveBtn: HTMLButtonElement = rightSidebar.querySelector('.action-save');
if (title) sidebarTitle.innerHTML = title;
if (content) sidebarContent.innerHTML = content;
@@ -597,7 +597,7 @@ export async function createEmbodimentSidebar(title?, content?, actions?, toolti
sidebarActions = sidebarTitle?.querySelector?.('.actions .action-content');
const closeBtn: HTMLButtonElement = sidebarTitle.querySelector('.close-btn');
- const saveBtn: HTMLButtonElement = embodimentSidebar.querySelector('.save-btn');
+ const saveBtn: HTMLButtonElement = embodimentSidebar.querySelector('.action-save');
if (content) sidebarContent.querySelector(`.${contentCls}`).innerHTML = content;
if (closeBtn) {
closeBtn.onclick = async () => {
@@ -1208,68 +1208,66 @@ export function sidebarEditValues({
handleTemplateVars(sidebarContent);
}
- const saveBtn: HTMLButtonElement = sidebar.querySelector('.save-btn');
- saveBtn.onclick = async (e) => {
- const result = {};
- let saveBeforeCloseState = 0;
+ const saveBtn: HTMLButtonElement = sidebar.querySelector('.action-save');
+ if (saveBtn) {
+ saveBtn.onclick = async (e) => {
+ const result = {};
+ let saveBeforeCloseState = 0;
+ let validationToastShown = false;
- for (let tab in forms) {
- const form = forms[tab].form;
- const formFields = forms[tab].fields;
+ for (let tab in forms) {
+ const form = forms[tab].form;
+ const formFields = forms[tab].fields;
- dispatchSubmitEvent(form); // to trigger validation
+ dispatchSubmitEvent(form); // to trigger validation
- await delay(30);
- const invalidElements = [...form.querySelectorAll('.invalid')] as HTMLElement[];
+ await delay(30);
+ const invalidElements = [...form.querySelectorAll('.invalid')] as HTMLElement[];
- const invalid = invalidElements[0];
- const closestScrollable = form.closest('.overflow-y-auto');
- if (invalid && closestScrollable) {
- closestScrollable.scrollTo({ top: invalid.offsetTop - 50, behavior: 'smooth' });
+ const invalid = invalidElements[0];
+ const closestScrollable = form.closest('.overflow-y-auto');
+ if (invalid && closestScrollable) {
+ closestScrollable.scrollTo({ top: invalid.offsetTop - 50, behavior: 'smooth' });
+ }
+ if (invalid) {
+ if (!validationToastShown) {
+ errorToast('Please fix the highlighted fields and try again.', 'Validation Error');
+ validationToastShown = true;
+ }
+ saveBeforeCloseState = 2;
+ }
+
+ const values = readFormValues(form, formFields);
+ result[tab] = values;
}
- if (invalid) {
- const saveBeforeClose = await confirm(
- // 'Configuration Error',
- null,
- 'You have validation errors. Are you sure you want to discard these changes?',
- {
- btnNoLabel: 'Discard Changes',
- btnYesLabel: 'Continue Editing',
- btnNoClass: 'h-[48px] rounded-lg px-8',
- btnYesClass: 'h-[48px] rounded-lg px-8',
- },
- );
- saveBeforeCloseState = !saveBeforeClose ? 1 : 2;
+ if (saveBeforeCloseState == 1) {
+ closeRightSidebar();
+ resolve(null);
+ e.stopPropagation();
+ return;
+ } else if (saveBeforeCloseState == 2) {
+ return false;
}
-
- const values = readFormValues(form, formFields);
- result[tab] = values;
- }
- if (saveBeforeCloseState == 1) {
+ if (typeof onSave === 'function') onSave.apply({ sidebar }, [result]);
closeRightSidebar();
- resolve(null);
- e.stopPropagation();
- return;
- } else if (saveBeforeCloseState == 2) {
- return false;
- }
- if (typeof onSave === 'function') onSave.apply({ sidebar }, [result]);
- closeRightSidebar();
- window['workspace']?.emit?.('componentUpdated', result);
- resolve(result);
- };
- saveBtn.classList.remove('hidden');
+ window['workspace']?.emit?.('componentUpdated', result);
+ resolve(result);
+ };
+ saveBtn.classList.remove('hidden');
+ }
const closeBtn: HTMLButtonElement = sidebar.querySelector('.close-btn');
- closeBtn.onclick = async () => {
- if (typeof onBeforeCancel === 'function') {
- const canClose = await onBeforeCancel.apply({ sidebar }, [sidebar]);
- if (!canClose) return;
- }
- closeRightSidebar();
- if (typeof onCancel === 'function') onCancel.apply({ sidebar }, [sidebar]);
- resolve(null);
- };
+ if (closeBtn) {
+ closeBtn.onclick = async () => {
+ if (typeof onBeforeCancel === 'function') {
+ const canClose = await onBeforeCancel.apply({ sidebar }, [sidebar]);
+ if (!canClose) return;
+ }
+ closeRightSidebar();
+ if (typeof onCancel === 'function') onCancel.apply({ sidebar }, [sidebar]);
+ resolve(null);
+ };
+ }
// closeBtn.classList.remove('hidden');
//sidebarActions.appendChild(saveBtn);
diff --git a/packages/app/src/builder-ui/utils/component.utils/index.ts b/packages/app/src/builder-ui/utils/component.utils/index.ts
index 7c98a14e..b1bcef0a 100644
--- a/packages/app/src/builder-ui/utils/component.utils/index.ts
+++ b/packages/app/src/builder-ui/utils/component.utils/index.ts
@@ -256,7 +256,7 @@ export async function promptVaultInfo(
target.setAttribute('data-waiting', 'true');
const sidebarContainer = target.closest('.sidebar-container');
- const saveBtn = sidebarContainer.querySelector('.save-btn') as HTMLButtonElement;
+ const saveBtn = sidebarContainer.querySelector('.action-save') as HTMLButtonElement;
const spinner = createSpinner('black', 'absolute top-[5px] right-[20px]');
const fieldActions = formGroup.querySelector('.smyth-field-actions');
@@ -1111,3 +1111,4 @@ export function addTooltipToLockBadge(element, tooltipText) {
export { default as PromptGeneratorUtils } from './PromptGenerator.utils';
export { default as VisionLLMUtils } from './VisionLLM.utils';
+
diff --git a/packages/app/src/builder-ui/utils/vault.utils.ts b/packages/app/src/builder-ui/utils/vault.utils.ts
index ebeae562..8baa5365 100644
--- a/packages/app/src/builder-ui/utils/vault.utils.ts
+++ b/packages/app/src/builder-ui/utils/vault.utils.ts
@@ -342,7 +342,7 @@ const _innerLink = (targetField: HTMLInputElement, message: string = '', keyName
const saveBtn = formGroup
.closest('#right-sidebar')
- ?.querySelector('.save-btn') as HTMLButtonElement;
+ ?.querySelector('.action-save') as HTMLButtonElement;
if (saveBtn) saveBtn.disabled = true;
diff --git a/packages/app/views/pages/partials/studio/right-sidebar.ejs b/packages/app/views/pages/partials/studio/right-sidebar.ejs
index 6be01536..36a3f4e1 100644
--- a/packages/app/views/pages/partials/studio/right-sidebar.ejs
+++ b/packages/app/views/pages/partials/studio/right-sidebar.ejs
@@ -25,22 +25,6 @@
</div>
<div class="title-right-buttons inline-flex" dir="rtl">
- <button
- type="button"
- class="save-btn h-10 items-center py-1 text-xs text-[#757575] bg-transparent focus:z-10"
- data-tooltip-target="tooltip-save-close"
- data-tooltip-placement="left"
- >
- <span class="mif-cross"></span>
- </button>
- <div
- id="tooltip-save-close"
- role="tooltip"
- class="tooltip absolute z-10 inline-block text-sm w-max bg-black shadow-lg text-white py-2 px-4 rounded-lg opacity-0 invisible"
- style="font-family: 'Inter', sans-serif"
- >
- Save&nbsp;and&nbsp;Close
- </div>
<button
type="button"
class="close-btn h-10 items-center py-1 text-xs text-[#757575] bg-transparent focus:z-10"
@@ -69,7 +53,7 @@
<div class="action-content w-full"></div>
<button
type="button"
- class="del-btn items-center h-12 p-3 text-sm font-medium bg-transparent hover:bg-red-200 focus:z-10 focus:ring-2 opacity-80 hover:opacity-100"
+ class="del-btn items-center h-12 p-3 text-sm font-medium bg-transparent focus:z-10 focus:ring-2"
>
<span class="svg-icon delete h-5 w-5"></span>
</button>