Managing Browser Window Actions in SuiteScript

Let’s explore the key differences and uses for window.onbeforeunload, window.location.href, window.open, and window.close.

window.onbeforeunload

The window.onbeforeunload event is triggered before the page is about to unload, such as when a user tries to close the tab or navigate away. It provides an opportunity to warn the user before they leave the page.

• Use Case: Preventing users from accidentally navigating away from a page with unsaved changes.
• Example:

window.onbeforeunload = function() {
   return "Are you sure you want to leave? You have unsaved changes.";
};

• Important Notes: Modern browsers limit the customization of the message in the prompt, but the event is still helpful in giving users a heads-up.

window.location.href

window.location.href is used to get or set the current page’s URL. By setting window.location.href to a new URL, you can navigate to a different page.

• Use Case: Redirecting the user to a different URL, whether it’s another page within NetSuite or an external link.
• Example:

let url = "https://www.example.com";
window.location.href = url;

• Important Notes: This will immediately change the browser’s URL and reload the page, which could result in the loss of unsaved data if not handled properly.

window.open

The window.open method allows you to open a new browser window or tab, usually for opening another URL or generating reports.

• Use Case: Opening a new page in a new tab or window (often used in SuiteScript when you need to display reports, Suitelet results, or external links).
• Example:

window.open('https://www.example.com', '_blank'); // Opens in a new tab

• Important Notes: You can specify parameters like _blank (new tab), _self (same tab), and more. You can also specify the size and features of the new window by passing a string with options.

window.close

window.close closes the current browser window or tab. However, modern browsers restrict scripts from closing windows that were not opened by the script itself for security reasons.

• Use Case: Automatically closing a window that was opened by a script, such as after submitting a form or completing an action.
• Example:

window.close();

• Important Notes: window.close() will only work on windows that were opened using window.open within the same session. Attempting to close the main window or a window that wasn’t opened by script will usually fail due to browser security policies.

When working with SuiteScript, particularly in Suitelets or client-side scripts, these methods can be very useful for controlling the flow of user interactions, like opening and closing forms or redirecting users after certain actions. Here are some common use cases:

• Redirecting Users after Form Submission: Use window.location.href to redirect users after they submit a form.

window.location.href = '/app/site/hosting/scriptlet.nl?script=123&deploy=1';

• Opening a New Window for Reports: Use window.open to open a Suitelet or a report in a new window.

window.open('/app/site/hosting/scriptlet.nl?script=123&deploy=1', '_blank');

• Handling Page Navigation with Warnings: Before the user leaves a page with unsaved data, use window.onbeforeunload to display a warning.

window.onbeforeunload = function() {
    return "You have unsaved changes. Are you sure you want to leave?";
};

• Closing a Custom Window: If you opened a custom window for a specific task, use window.close() to close it after the task is completed.

window.close();

Understanding these window management functions in SuiteScript can greatly improve user interaction and control within custom scripts. Whether you’re redirecting users, displaying reports in new windows, or preventing users from leaving the page without saving their data, these browser window controls offer a powerful way to guide user behavior.