Desktop Widgets
Complete reference for all 73 desktop widgets
Desktop Widgets Reference
Desktop widgets are optimized for web browsers and provide full functionality for complex business applications. This reference documents all 73 desktop widgets with their properties, events, methods, and usage examples.
Input Widgets
TextField
Single-line text input for forms and data entry.
Properties
| Property | Type | Description |
|---|---|---|
attributeName | String | Model attribute to bind |
formName | String | Associated form ID |
maxLength | Integer | Maximum character limit |
placeHolder | String | Placeholder text |
validation | String | Validation pattern |
customValidation | String | Custom validation expression |
errorMessage | String | Validation error message |
requiredMessage | String | Required field message |
promptMessage | String | Helper prompt text |
hideInput | Boolean | Password mode (masks input) |
displayLimit | Boolean | Show character counter |
spellCheck | Boolean | Enable spell checking |
Events
| Event | Description |
|---|---|
Change | Value has changed |
Input | User is typing |
Focus | Field receives focus |
Blur | Field loses focus |
KeyPress | Key pressed |
KeyUp | Key released |
KeyDown | Key pressed down |
Methods
| Method | Description | Returns |
|---|---|---|
getValue() | Get current text value | String |
setValue(value) | Set text value | void |
focus() | Set keyboard focus | void |
blur() | Remove focus | void |
validate() | Validate field value | Boolean |
reset() | Reset to initial state | void |
Example
{
widgetType: "TextField",
id: "customerEmail",
attributeName: "email",
placeHolder: "Enter email address",
validation: "email",
errorMessage: "Please enter a valid email",
maxLength: 100
}
TextArea
Multi-line text input for longer content.
Properties
| Property | Type | Description |
|---|---|---|
rows | Integer | Number of visible rows |
cols | Integer | Number of columns |
wrap | String | Text wrapping mode |
resize | String | "none", "both", "horizontal", "vertical" |
Also includes all TextField properties.
Events
| Event | Description |
|---|---|
Change | Content changed |
Input | User typing |
Focus | Field focused |
Blur | Field blurred |
Methods
| Method | Description | Returns |
|---|---|---|
getValue() | Get textarea content | String |
setValue(value) | Set textarea content | void |
getSelectionRange() | Get selected text range | Object {start, end} |
setSelectionRange(start, end) | Set text selection | void |
insertText(text, position) | Insert text at position | void |
RichTextArea
WYSIWYG editor for formatted text content.
Properties
| Property | Type | Description |
|---|---|---|
toolbar | String | Available formatting tools |
height | Integer | Editor height in pixels |
allowHTML | Boolean | Allow HTML input |
formats | String | Allowed formatting options |
Events
| Event | Description |
|---|---|
Change | Content changed |
Focus | Editor focused |
Blur | Editor blurred |
Methods
| Method | Description | Returns |
|---|---|---|
getValue() | Get HTML content | String |
setValue(html) | Set HTML content | void |
getPlainText() | Get plain text without formatting | String |
format(command, value) | Apply formatting command | void |
insertImage(url) | Insert image at cursor | void |
clear() | Clear all content | void |
NumberField
Numeric input with validation and formatting.
Properties
| Property | Type | Description |
|---|---|---|
minValue | Number | Minimum allowed value |
maxValue | Number | Maximum allowed value |
decimal | Boolean | Allow decimal values |
decimalDigits | String | Decimal precision |
thousandsSeparator | Boolean | Format with thousands separator |
Events
| Event | Description |
|---|---|
Change | Value changed |
Input | User typing |
Focus | Field focused |
Blur | Field blurred |
Methods
| Method | Description | Returns |
|---|---|---|
getValue() | Get numeric value | Number |
setValue(value) | Set numeric value | void |
increment(step) | Increase value by step | void |
decrement(step) | Decrease value by step | void |
setRange(min, max) | Set value range | void |
NumberSpinner
Numeric input with increment/decrement buttons.
Properties
| Property | Type | Description |
|---|---|---|
step | Number | Increment/decrement step |
showButtons | Boolean | Show spinner buttons |
Also includes all NumberField properties.
CurrencyField
Monetary value input with currency formatting.
Properties
| Property | Type | Description |
|---|---|---|
currency | String | Currency code (USD, EUR, etc.) |
currencySymbol | String | Currency symbol to display |
symbolPosition | String | "before" or "after" |
Events
| Event | Description |
|---|---|
Change | Value changed |
Focus | Field focused |
Blur | Field blurred |
Methods
| Method | Description | Returns |
|---|---|---|
formatCurrency(value) | Format value as currency | String |
setCurrency(currency) | Set currency symbol | void |
parseCurrency(text) | Parse currency string to number | Number |
Also includes all NumberField methods.
DateField
Date selection with calendar picker.
Properties
| Property | Type | Description |
|---|---|---|
dateFormat | String | Display format pattern |
minDate | Date | Earliest selectable date |
maxDate | Date | Latest selectable date |
showWeeks | Boolean | Show week numbers |
firstDayOfWeek | Integer | 0=Sunday, 1=Monday |
Events
| Event | Description |
|---|---|
Change | Date changed |
Select | Date selected |
Methods
| Method | Description | Returns |
|---|---|---|
getValue() | Get selected date | Date |
setValue(date) | Set selected date | void |
setMinDate(date) | Set minimum selectable date | void |
setMaxDate(date) | Set maximum selectable date | void |
showCalendar() | Show date picker calendar | void |
hideCalendar() | Hide date picker calendar | void |
TimeField
Time selection input.
Properties
| Property | Type | Description |
|---|---|---|
timeFormat | String | 12 or 24 hour format |
minuteStep | Integer | Minute increment |
showSeconds | Boolean | Include seconds |
Events
| Event | Description |
|---|---|
Change | Time changed |
Select | Time selected |
Methods
| Method | Description | Returns |
|---|---|---|
getValue() | Get selected time | String |
setValue(time) | Set time value | void |
getHours() | Get hour component | Number (0-23) |
getMinutes() | Get minute component | Number (0-59) |
setTime(hours, minutes) | Set time components | void |
CheckBox
Boolean toggle input.
Properties
| Property | Type | Description |
|---|---|---|
label | String | Checkbox label text |
checked | Boolean | Initial checked state |
indeterminate | Boolean | Three-state mode |
Events: Change, Click
Select
Dropdown selection from predefined options or dynamic data.
Properties
| Property | Type | Description |
|---|---|---|
options | Option | Available choices |
emptyOption | String | Default empty option text |
multiple | Boolean | Allow multiple selection |
searchable | Boolean | Enable search filter |
modelName | String | Model for dynamic options |
query | String | Query for options |
labelAttribute | String | Attribute for display |
valueAttribute | String | Attribute for value |
sort | String | Sort order |
Events
| Event | Description |
|---|---|
Change | Selection changed |
Select | Item selected |
Focus | Widget focused |
Blur | Widget blurred |
Methods
| Method | Description | Returns |
|---|---|---|
getValue() | Get selected value(s) | Any |
setValue(value) | Set selected value(s) | void |
getSelectedRecord() | Get selected record object | Record |
isEmpty() | Check if selection is empty | Boolean |
getDisplayValue() | Get displayed text value | String |
setDisplayValue(text) | Set by display text | void |
reload() | Reload options from source | void |
setValueAndReload(value) | Set value and reload options | void |
getOptions() | Get all available options | Array |
setOptions(options) | Set available options | void |
addRecord(record) | Add a new option record | void |
getEnumValue() | Get enum constant value | String |
ComboBox
Dropdown with text input capability.
Properties
| Property | Type | Description |
|---|---|---|
allowCreate | Boolean | Allow custom values |
filterMode | String | "contains", "starts", "exact" |
Also includes all Select properties.
MultiSelect
Multiple selection from list.
Properties
| Property | Type | Description |
|---|---|---|
minSelection | Integer | Minimum required selections |
maxSelection | Integer | Maximum allowed selections |
showCheckboxes | Boolean | Display checkboxes |
Events: Change, Selection
HorizontalSlider / VerticalSlider
Value selection via sliding control.
Properties
| Property | Type | Description |
|---|---|---|
min | Number | Minimum value |
max | Number | Maximum value |
step | Number | Step increment |
showLabels | Boolean | Display value labels |
showTicks | Boolean | Show tick marks |
Events: Change, Slide
Display Widgets
Label
Static text display for forms and UI labeling.
Properties
| Property | Type | Description |
|---|---|---|
text | String | Display text |
forWidget | String | Associated input widget ID |
wrap | Boolean | Enable text wrapping |
html | Boolean | Render as HTML |
Events: Click
Methods
| Method | Description | Returns |
|---|---|---|
setText(text) | Set label text content | void |
getText() | Get current label text | String |
setHTML(html) | Set HTML content | void |
DisplayLabel
Dynamic data-bound text display.
Properties
| Property | Type | Description |
|---|---|---|
attributeName | String | Model attribute to display |
format | String | Display format pattern |
prefix | String | Text prefix |
suffix | String | Text suffix |
Image
Image display with optional interactions.
Properties
| Property | Type | Description |
|---|---|---|
src | String | Image URL or path |
alt | String | Alternative text |
width | Integer | Display width |
height | Integer | Display height |
fit | String | "cover", "contain", "fill" |
lazy | Boolean | Lazy load image |
Events: Click, Load, Error
Video
Video player with controls.
Properties
| Property | Type | Description |
|---|---|---|
src | String | Video URL |
autoplay | Boolean | Auto-start playback |
controls | Boolean | Show player controls |
loop | Boolean | Loop playback |
muted | Boolean | Start muted |
poster | String | Preview image URL |
Events: Play, Pause, Ended
Icon
Icon display from icon libraries.
Properties
| Property | Type | Description |
|---|---|---|
icon | String | Icon name/class |
size | String | "small", "medium", "large" |
color | String | Icon color |
rotate | Integer | Rotation degrees |
Events: Click
Methods
| Method | Description | Returns |
|---|---|---|
setIcon(icon) | Set icon class | void |
setColor(color) | Set icon color | void |
setSize(size) | Set icon size | void |
rotate(degrees) | Rotate icon | void |
Data Widgets
DataGrid
Tabular data display with sorting, filtering, editing, and advanced data manipulation.
Properties
| Property | Type | Description |
|---|---|---|
columns | Column | Column definitions |
query | String | Data source query |
model | String | Bound model name |
pageSize | Integer | Records per page |
autoHeight | Boolean | Adjust height to content |
headerHidden | Boolean | Hide column headers |
resizableColumns | Boolean | Allow column resizing |
enableSorting | Boolean | Enable column sorting |
rowSelection | Boolean | Enable row selection |
multiselect | Boolean | Multiple row selection |
dragRows | Boolean | Enable row reordering |
editLazySave | Boolean | Batch edit mode |
fetchNested | Boolean | Load related data |
lockedCols | Integer | Number of frozen columns |
summaryQuery | String | Summary row query |
disconnected | Boolean | Offline mode |
quiet | Boolean | Suppress notifications |
method | String | HTTP method for updates |
Events
| Event | Description |
|---|---|
RowClick | Row clicked |
RowDblClick | Row double-clicked |
CellClick | Cell clicked |
CellChange | Cell value changed |
RowDelete | Row deleted |
Selection | Selection changed |
Update | Data updated |
BeforeEdit | Before cell edit |
AfterEdit | After cell edit |
Methods
| Method | Description | Returns |
|---|---|---|
enableEdit(enabled) | Enable or disable grid editing | void |
newRecord() | Create a new record in the grid | Record |
getRecord(rowId) | Get a record by row ID | Record |
getFocusedRecord() | Get the currently focused record | Record |
getActiveRecord() | Get the active/editing record | Record |
getSelectedRecords(idsOnly) | Get selected records | Array |
addRecord(record) | Add a new record to the grid | void |
updateRecord(rowId, data) | Update a record's data | void |
deleteRecord(rowId) | Delete a record from the grid | void |
setRecords(records) | Replace all grid records | void |
getAllRecords() | Get all records in the grid | Array |
refresh() | Refresh the grid display | void |
getQuery() | Get the current query | Query |
setQuery(query) | Set a new query | void |
commit() | Save all pending changes | void |
rollback() | Revert all uncommitted changes | void |
getColumns(raw) | Get column configuration | Array |
setColumnHeader(colId, header) | Change column header text | void |
selectRows(rowNumbers) | Select specific rows | void |
selectAll() | Select all visible rows | void |
deselectAll() | Deselect all rows | void |
deselectRows(rowNumbers) | Deselect specific rows | void |
isRowSelected(rowId) | Check if a row is selected | Boolean |
toggleCellHighlight(colId, style) | Toggle cell highlighting | void |
copyToClipboard() | Copy selected data to clipboard | void |
setColumnValueOptions(colId, options) | Set dropdown options for column | void |
setRowData(rowId, data) | Update a row's data | void |
stepFocus(direction) | Move focus to adjacent cell | void |
DataGrid2
Enhanced data grid with advanced features.
Properties
| Property | Type | Description |
|---|---|---|
groupBy | String | Group rows by field |
aggregates | Object | Column aggregations |
virtualScroll | Boolean | Virtual scrolling |
Also includes all DataGrid properties.
Methods
| Method | Description | Returns |
|---|---|---|
groupBy(field) | Group rows by field | void |
expandGroup(groupName) | Expand a grouped section | void |
collapseGroup(groupName) | Collapse a grouped section | void |
setAggregates(config) | Configure column aggregations | void |
Also includes all DataGrid methods.
DataList
List-based data display.
Properties
| Property | Type | Description |
|---|---|---|
itemTemplate | String | Item display template |
orientation | String | "vertical" or "horizontal" |
selectable | Boolean | Enable selection |
Events
| Event | Description |
|---|---|
ItemClick | Item clicked |
ItemDoubleClick | Item double-clicked |
Selection | Selection changed |
Methods
| Method | Description | Returns |
|---|---|---|
getSelectedItems() | Get selected list items | Array |
selectItem(index) | Select an item by index | void |
clearSelection() | Clear all selections | void |
scrollToItem(index) | Scroll to specific item | void |
refresh() | Refresh list display | void |
setItemTemplate(template) | Set item display template | void |
Chart
Interactive data visualization with multiple chart types.
Properties
| Property | Type | Description |
|---|---|---|
chartType | String | Chart type (bar, line, pie, etc.) |
dataSource | String | Data query |
xAxis | Object | X-axis configuration |
yAxis | Object | Y-axis configuration |
series | Series | Data series definitions |
legend | Object | Legend configuration |
colors | String | Color palette |
title | String | Chart title |
subtitle | String | Chart subtitle |
animations | Boolean | Enable animations |
Events
| Event | Description |
|---|---|
DataClick | Data point clicked |
LabelClick | Label clicked |
Zoom | Chart zoomed |
Methods
| Method | Description | Returns |
|---|---|---|
setQuery(query) | Set chart data source query | void |
setData(data) | Set chart data directly | void |
refresh() | Refresh chart with latest data | void |
setAnnotations(annotations) | Add chart annotations | void |
removeAnnotations() | Remove all annotations | void |
toPNG() | Export chart as PNG image | String (base64) |
updateSeries(index, data) | Update specific series data | void |
setTitle(title) | Update chart title | void |
setColors(colors) | Update color palette | void |
Calendar
Event calendar display.
Properties
| Property | Type | Description |
|---|---|---|
view | String | "month", "week", "day" |
eventSource | String | Events data query |
startField | String | Event start date field |
endField | String | Event end date field |
titleField | String | Event title field |
editable | Boolean | Allow event editing |
Events
| Event | Description |
|---|---|
EventClick | Calendar event clicked |
DateClick | Date cell clicked |
ViewChange | View type changed |
Methods
| Method | Description | Returns |
|---|---|---|
setView(view) | Change calendar view | void |
gotoDate(date) | Navigate to specific date | void |
next() | Go to next period | void |
previous() | Go to previous period | void |
today() | Go to today | void |
addEvent(event) | Add calendar event | void |
removeEvent(eventId) | Remove calendar event | void |
getEvents(start, end) | Get events in range | Array |
refresh() | Refresh calendar display | void |
Container Widgets
FlexContainer
Flexible box layout container for responsive layouts.
Properties
| Property | Type | Description |
|---|---|---|
direction | String | "row", "column" |
wrap | String | "wrap", "nowrap" |
justify | String | Main axis alignment |
align | String | Cross axis alignment |
gap | Integer | Space between items |
Methods
| Method | Description | Returns |
|---|---|---|
addChild(widget, index) | Add a child widget to the container | void |
removeChild(widget) | Remove a child widget | void |
getChildren() | Get all child widgets | Array |
clear() | Remove all child widgets | void |
setDirection(direction) | Change flex direction | void |
FlexItem
Item within FlexContainer.
Properties
| Property | Type | Description |
|---|---|---|
flex | String | Flex grow/shrink/basis |
order | Integer | Display order |
alignSelf | String | Individual alignment |
Methods
| Method | Description | Returns |
|---|---|---|
setFlex(value) | Set flex CSS value | void |
setOrder(order) | Set display order | void |
setAlignSelf(align) | Set self alignment | void |
GridContainer
CSS Grid layout container.
Properties
| Property | Type | Description |
|---|---|---|
columns | String | Column template |
rows | String | Row template |
gap | Integer | Grid gap |
areas | String | Grid areas template |
Methods
| Method | Description | Returns |
|---|---|---|
addChild(widget, gridArea) | Add child to grid area | void |
setColumns(template) | Set column template | void |
setRows(template) | Set row template | void |
setGap(gap) | Set grid gap | void |
TabContainer
Tabbed content panels.
Properties
| Property | Type | Description |
|---|---|---|
tabPosition | String | "top", "bottom", "left", "right" |
activeTab | Integer | Initially active tab |
closable | Boolean | Allow tab closing |
Events: TabChange
Methods
| Method | Description | Returns |
|---|---|---|
addTab(title, content, index) | Add a new tab | void |
removeTab(index) | Remove a tab | void |
selectTab(index) | Select a tab | void |
getActiveTab() | Get active tab index | Number |
setTabTitle(index, title) | Change tab title | void |
BorderContainer
Border layout with regions.
Properties
| Property | Type | Description |
|---|---|---|
regions | Object | north, south, east, west, center |
gutters | Boolean | Show region dividers |
resizable | Boolean | Allow region resizing |
Methods
| Method | Description | Returns |
|---|---|---|
setRegion(region, widget) | Set region content | void |
getRegion(region) | Get region content | Widget |
setRegionSize(region, size) | Set region size | void |
toggleRegion(region) | Toggle region visibility | void |
SplitPane
Resizable split layout.
Properties
| Property | Type | Description |
|---|---|---|
orientation | String | "horizontal" or "vertical" |
splitPosition | Integer | Initial split position |
minSize | Integer | Minimum pane size |
Action Widgets
Button
Clickable action button for triggering events and actions.
Properties
| Property | Type | Description |
|---|---|---|
label | String | Button text |
icon | String | Button icon |
buttonType | String | "solid", "outline", "light" |
color | String | Button color theme |
size | String | "small", "medium", "large" |
tooltip | String | Hover tooltip text |
disabled | Boolean | Disable button |
Events: Click
Methods
| Method | Description | Returns |
|---|---|---|
setLabel(label) | Change button label text | void |
getLabel() | Get current button label | String |
setIcon(icon) | Change button icon | void |
enable() | Enable the button | void |
disable() | Disable the button | void |
click() | Programmatically click the button | void |
DropdownButton
Button with dropdown menu.
Properties
| Property | Type | Description |
|---|---|---|
menu | Menu | Dropdown menu definition |
showCaret | Boolean | Show dropdown indicator |
Also includes all Button properties.
ButtonBar
Group of related buttons.
Properties
| Property | Type | Description |
|---|---|---|
buttons | Button | Button definitions |
orientation | String | "horizontal" or "vertical" |
spacing | Integer | Space between buttons |
Navigation Widgets
Menu
Hierarchical menu structure.
Properties
| Property | Type | Description |
|---|---|---|
items | MenuItem | Menu item definitions |
orientation | String | Menu orientation |
showIcons | Boolean | Display item icons |
Events: ItemClick, MenuClose
MenuBar
Horizontal application menu bar.
Properties
| Property | Type | Description |
|---|---|---|
menus | Menu | Top-level menus |
sticky | Boolean | Stick to top |
NavigationBar
Application navigation header.
Properties
| Property | Type | Description |
|---|---|---|
title | String | Navigation title |
logo | String | Logo image URL |
items | NavItem | Navigation items |
userMenu | Menu | User account menu |
Methods
| Method | Description | Returns |
|---|---|---|
setTitle(title) | Set navigation title | void |
addItem(item, index) | Add navigation item | void |
setLogo(url) | Set logo image | void |
setUserMenu(menu) | Set user account menu | void |
Specialized Widgets
FileUpload
File selection and upload.
Properties
| Property | Type | Description |
|---|---|---|
accept | String | Accepted file types |
multiple | Boolean | Multiple file selection |
maxSize | Integer | Maximum file size (bytes) |
autoUpload | Boolean | Upload on selection |
Events: FileUploaded, FileDeleted
Methods
| Method | Description | Returns |
|---|---|---|
upload() | Trigger file upload | void |
clear() | Clear selected files | void |
getFiles() | Get uploaded file list | Array |
setAccept(types) | Set accepted file types | void |
setMaxSize(size) | Set maximum file size | void |
Dropzone
Drag-and-drop file upload area.
Properties
| Property | Type | Description |
|---|---|---|
dropText | String | Drop zone message |
preview | Boolean | Show file preview |
Also includes all FileUpload properties.
Methods
| Method | Description | Returns |
|---|---|---|
showPreview(file) | Show file preview | void |
Also includes all FileUpload methods.
Signature
Digital signature capture widget.
Properties
| Property | Type | Description |
|---|---|---|
width | Integer | Signature pad width |
height | Integer | Signature pad height |
penColor | String | Pen color |
backgroundColor | String | Background color |
attribute | String | Model attribute |
enableEditLock | Boolean | Lock after signing |
required | Boolean | Required field |
Events: Change, AfterChange
Map
Interactive map display.
Properties
| Property | Type | Description |
|---|---|---|
center | Coordinates | Map center point |
zoom | Integer | Zoom level |
markers | Marker | Map markers |
showControls | Boolean | Show map controls |
Events: MarkerClick, Zoom
Methods
| Method | Description | Returns |
|---|---|---|
setCenter(lat, lng) | Set map center | void |
setZoom(level) | Set zoom level | void |
addMarker(marker) | Add map marker | String (ID) |
removeMarker(id) | Remove map marker | void |
clearMarkers() | Remove all markers | void |
panTo(lat, lng) | Pan to coordinates | void |
fitBounds(bounds) | Fit map to bounds | void |
Tree
Hierarchical tree structure for displaying parent-child relationships.
Properties
| Property | Type | Description |
|---|---|---|
model | Model | Data model |
labelAttr | String | Attribute for node labels |
parentAttr | String | Attribute for parent relationship |
iconAttr | String | Attribute for node icons |
sortAttr | String | Attribute for sorting nodes |
defIcon | String | Default icon for nodes |
dnd | Boolean | Enable drag and drop |
checkboxes | Boolean | Show checkboxes for selection |
action | String | Action to execute on click |
formName | String | Associated form name |
ctxMenu | Menu | Context menu |
iconFormatter | Function | Custom icon formatter |
loader | Function | Custom data loader |
menuFilter | Function | Context menu filter |
Events: ItemClick, Expand, Collapse, Drop
Methods
| Method | Description | Returns |
|---|---|---|
expandNode(nodeId) | Expand tree node | void |
collapseNode(nodeId) | Collapse tree node | void |
selectNode(nodeId) | Select tree node | void |
getSelectedNode() | Get selected node ID | String |
addNode(parentId, node) | Add tree node | String |
removeNode(nodeId) | Remove tree node | void |
refresh() | Refresh tree display | void |
Canvas
Drawing and graphics canvas.
Properties
| Property | Type | Description |
|---|---|---|
advanced | Boolean | Enable advanced canvas features |
Events: Click, Change
Methods
| Method | Description | Returns |
|---|---|---|
getContext() | Get drawing context | CanvasRenderingContext2D |
clear() | Clear canvas content | void |
toDataURL(format) | Export canvas as image | String (base64) |
setSize(width, height) | Set canvas dimensions | void |
drawImage(image, x, y) | Draw image on canvas | void |
Select2
Advanced searchable select widget with autocomplete.
Properties
| Property | Type | Description |
|---|---|---|
modelName | String | Data model name |
query | String | Query filter |
searchAttr | String | Search attribute |
searchLabels | Boolean | Search in labels |
valueAttribute | String | Value attribute |
placeholder | String | Placeholder text |
multiSelect | Boolean | Allow multiple selection |
optional | Boolean | Allow empty selection |
createOptions | Boolean | Allow creating new options |
minInput | Integer | Minimum characters to search |
preload | Boolean | Preload options |
selectionFormatter | Function | Custom selection formatter |
optionFormatter | Function | Custom option formatter |
options | Option | Static options |
Events: Change, Select, OptionAdded
Countdown
Countdown timer display.
Properties
| Property | Type | Description |
|---|---|---|
attribute | String | Date/time attribute |
format | String | Display format |
Events: Finished
Methods
| Method | Description | Returns |
|---|---|---|
start() | Start countdown timer | void |
stop() | Stop countdown timer | void |
reset() | Reset timer to start | void |
getRemaining() | Get remaining time | Number (seconds) |
setTarget(date) | Set target end date | void |
ExcelImport
Excel file import button with mapping dialog.
Properties
| Property | Type | Description |
|---|---|---|
label | String | Button label |
icon | String | Button icon |
dialogLabel | String | Import dialog title |
message | String | Import instructions |
modelName | String | Target model |
mapping | Object | Column mapping |
columns | Object | Column definitions |
headerRow | Integer | Header row number |
useUTC | Boolean | Use UTC for dates |
buttonType | ButtonType | Button style |
color | String | Button color |
size | String | Button size |
tooltip | String | Button tooltip |
Events: Click, ImportReady
Twitter feed integration widget.
Properties
| Property | Type | Description |
|---|---|---|
consumerKey | String | Twitter API consumer key |
consumerKeySecret | String | Consumer key secret |
token | String | Access token |
tokenSecret | String | Access token secret |
hashtag | String | Hashtag to display |
Events: Click
Instagram feed integration widget.
Properties
| Property | Type | Description |
|---|---|---|
clientId | String | Instagram client ID |
userId | String | Instagram user ID |
Events: Click
AutodeskViewer
Autodesk 3D model viewer for CAD and BIM files.
Properties
| Property | Type | Description |
|---|---|---|
env | String | Autodesk environment |
api | String | API endpoint |
docId | String | Document URN |
accessToken | String | Access token |
accessTokenWebhook | String | Token refresh webhook |
Events: ViewLoad, Selection
AudioPlayer
Audio file playback widget.
Properties
| Property | Type | Description |
|---|---|---|
sound | String | Audio file URL |
Events: Click, Finished
Methods
| Method | Description | Returns |
|---|---|---|
play() | Start audio playback | void |
pause() | Pause audio playback | void |
stop() | Stop audio playback | void |
setVolume(volume) | Set playback volume (0-1) | void |
getDuration() | Get audio duration | Number (seconds) |
getCurrentTime() | Get current position | Number (seconds) |
setCurrentTime(time) | Set playback position | void |
Animation
Animation and Lottie file display.
Properties
| Property | Type | Description |
|---|---|---|
src | String | Animation source URL |
param | String | Animation parameters |
resource | String | Resource identifier |
autoplay | Boolean | Auto-start animation |
controls | Boolean | Show playback controls |
loop | Boolean | Loop animation |
attribute | String | Model attribute |
Events: Click, Finished
Methods
| Method | Description | Returns |
|---|---|---|
play() | Start animation | void |
pause() | Pause animation | void |
stop() | Stop animation | void |
setSpeed(speed) | Set animation speed | void |
setLoop(loop) | Set loop behavior | void |
goToFrame(frame) | Jump to specific frame | void |
setSrc(src) | Set animation source | void |
FormAssistant
AI-powered form filling assistant button.
Properties
| Property | Type | Description |
|---|---|---|
label | String | Button label |
icon | String | Button icon |
formName | String | Target form |
buttonType | ButtonType | Button style |
color | String | Button color |
size | String | Button size |
tooltip | String | Button tooltip |
Events: Click
Methods
| Method | Description | Returns |
|---|---|---|
assist() | Trigger AI form assistance | void |
setFormTarget(formName) | Set target form | void |
setPrompt(prompt) | Set AI assistance prompt | void |
isProcessing() | Check if AI is processing | Boolean |
Next Steps
- Mobile Widgets - Complete mobile widget reference
- Widget Reference Overview - Widget categories and common features
- User Interfaces Guide - UI architecture and patterns