Getting Started with Window Web Component
Smart UI Web Components work with current evergreen browsers and Node 18+ for local tooling; pin package versions to match your project policy.
Smart UI is distributed as the smart-webcomponents NPM package. You can also use the full download from the Download page.
Quick start
- Install the package:
npm install smart-webcomponents
- Load the Window module (ES module script):
<script type="module" src="node_modules/smart-webcomponents/source/modules/smart.window.js"></script>
- Add the default stylesheet (prefer angular.json / bundler entry in app codebases; for plain HTML use a link):
<link rel="stylesheet" type="text/css" href="node_modules/smart-webcomponents/source/styles/smart.default.css" />
- Add markup in one of two ways - semantic custom element (the component tag is in your HTML) or a host
div(you mount programmatically with appendTo):
Semantic element (id matches the selector in Smart()):
<smart-window id="window"></smart-window>
Host container (id matches appendTo on Smart.Window):
<div id="windowContainer"></div>
- Initialize after the module loads: define a const windowOptions object, then either bind with Smart('#window', ...) on the semantic tag or use new Smart.Window({ ...windowOptions, appendTo: '#windowContainer' }) on the host
div:
<script type="module"> import 'node_modules/smart-webcomponents/source/modules/smart.window.js'; const windowOptions = { opened: true }; // Option A - semantic <smart-window> with id="window" Smart('#window', class { get properties() { return windowOptions; } }); // Option B - host div id="windowContainer" // const windowInstance = new Smart.Window({ // ...windowOptions, // appendTo: '#windowContainer' // }); // Option C - constructor(selector, options), then append the returned element yourself // const myWindow = new Smart.Window('#window', windowOptions); // document.body.appendChild(myWindow); </script>
Uncomment Option B when you use the host
div; use Option A when you use the semantic element. The Runtime cookbook also documents new Smart.Window('#window', windowOptions) with appendChild, and document.createElement('smart-window') with .props or Object.assign (all are valid patterns; do not combine overlapping patterns for the same instance unless you intend multiple components). - Serve the folder over HTTP (or use your bundler dev server) and open the page.
Runtime cookbook
Alternative creation patterns and imperative APIs. These are all valid ways to create Smart UI components: semantic markup + Smart(); new Smart.Window({ ...options, appendTo: '#...' }); new Smart.Window('#window', windowOptions) plus appendChild on the returned element; and document.createElement('smart-window') then assigning options via .props or Object.assign on the element.
Constructor with a selector string and options, then append the returned element (for example const myWindow = new Smart.Window('#window', windowOptions)):
const windowOptions = { opened: true };
const myWindow = new Smart.Window('#window', windowOptions);
document.body.appendChild(myWindow);
Create with document.createElement('smart-window'), assign properties (same as any custom element), then append:
const windowOptions = { opened: true };
const window = document.createElement('smart-window');
Object.assign(window, windowOptions);
document.body.appendChild(window);
Host on a div with appendTo (import the module, then instantiate when the document is ready; the container id must match appendTo):
import "../../source/modules/smart.window.js";
document.readyState === 'complete' ? init() : window.addEventListener('load', init);
function init() {
const windowOptions = { opened: true };
const window = new Smart.Window({
...windowOptions,
appendTo: '#windowContainer'
});
}
Append to the DOM:
const container = document.getElementById('window-container');
container.appendChild(window);
Remove from the DOM:
window.remove();
Set a property:
window.disabled = true; window.theme = 'dark';
Get a property value:
const isDisabled = window.disabled; const currentTheme = window.theme;
Invoke a method:
window.refresh(); window.focus();
Add event listener:
window.addEventListener('open', (event) => {
console.log('open triggered:', event.detail);
});
Remove event listener:
const handleWindowEvent = (event) => {
console.log('open triggered:', event.detail);
};
window.addEventListener('open', handleWindowEvent);
window.removeEventListener('open', handleWindowEvent);
Common Use Cases
-
Open modal dialog
Show window as a modal overlay
window.modal = true; window.open();
-
Handle close event
Execute code when window closes
smartWindow.addEventListener('close', () => { console.log('Window closed'); });
Troubleshooting
- How do I center the window?
- Use windowParent = 'body' and set centered = true, or calculate position manually using viewport dimensions.
- How do I prevent the window from being closed?
- Handle the closing event and call e.preventDefault() to cancel the close action.
Accessibility
The Window component follows WAI-ARIA best practices:
- Keyboard navigation - Tab, Arrow keys, Enter, and Escape are supported
- ARIA roles - Appropriate roles and labels are applied automatically
- Focus management - Visible focus indicators for keyboard users
- Screen readers - State changes are announced to assistive technology
- High contrast - Supports Windows High Contrast Mode and forced colors
For custom labeling, set aria-label or aria-labelledby attributes on the component.
Supported stacks: Smart UI targets Angular 17+, React 18+, Vue 3+, Node 18 LTS, and evergreen browsers; pin exact package versions to your org policy.