Getting Started with Table 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 Table module (ES module script):
<script type="module" src="node_modules/smart-webcomponents/source/modules/smart.table.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-table id="table"></smart-table>
Host container (id matches appendTo on Smart.Table):
<div id="tableContainer"></div>
- Initialize after the module loads: define a const tableOptions object, then either bind with Smart('#table', ...) on the semantic tag or use new Smart.Table({ ...tableOptions, appendTo: '#tableContainer' }) on the host
div:
<script type="module"> import 'node_modules/smart-webcomponents/source/modules/smart.table.js'; const tableOptions = {}; // Option A - semantic <smart-table> with id="table" Smart('#table', class { get properties() { return tableOptions; } }); // Option B - host div id="tableContainer" // const tableInstance = new Smart.Table({ // ...tableOptions, // appendTo: '#tableContainer' // }); // Option C - constructor(selector, options), then append the returned element yourself // const myTable = new Smart.Table('#table', tableOptions); // document.body.appendChild(myTable); </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.Table('#table', tableOptions) with appendChild, and document.createElement('smart-table') 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.Table({ ...options, appendTo: '#...' }); new Smart.Table('#table', tableOptions) plus appendChild on the returned element; and document.createElement('smart-table') 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 myTable = new Smart.Table('#table', tableOptions)):
const tableOptions = {};
const myTable = new Smart.Table('#table', tableOptions);
document.body.appendChild(myTable);
Create with document.createElement('smart-table'), assign properties (same as any custom element), then append:
const tableOptions = {};
const table = document.createElement('smart-table');
Object.assign(table, tableOptions);
document.body.appendChild(table);
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.table.js";
document.readyState === 'complete' ? init() : window.addEventListener('load', init);
function init() {
const tableOptions = {};
const table = new Smart.Table({
...tableOptions,
appendTo: '#tableContainer'
});
}
Append to the DOM:
const container = document.getElementById('table-container');
container.appendChild(table);
Remove from the DOM:
table.remove();
Set a property:
table.disabled = true; table.theme = 'dark';
Get a property value:
const isDisabled = table.disabled; const currentTheme = table.theme;
Invoke a method:
table.refresh(); table.focus();
Add event listener:
table.addEventListener('change', (event) => {
console.log('change triggered:', event.detail.type);
});
Remove event listener:
const handleTableEvent = (event) => {
console.log('change triggered:', event.detail.type);
};
table.addEventListener('change', handleTableEvent);
table.removeEventListener('change', handleTableEvent);
Troubleshooting
- What is the difference between Grid and Table?
- Table is lighter-weight for simpler tabular data, while Grid provides advanced features like virtual scrolling, complex editing, and grouping.
Accessibility
The Table 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.