Context Variables Summary
This page provides a comprehensive overview of all context variables exposed by XMLUI components. Context variables are values that components make available to their children, accessible using the $variableName syntax.
Available Context Variables
Jump to:
$attempts$cell$colIndex$completedItems$context$data$elapsed$error$group$header$isFirst$isLast$item$itemContext$itemIndex$overflow$param$params$polling$progress$queuedItems$result$row$rowIndex$setValue$statusData$validationResult$value
$attempts
Number of status polls made in deferred mode
Used by: 1 component
| Component | Description |
|---|---|
| APICall | Number of status polls made in deferred mode |
$cell
The specific cell value for this column
Used by: 1 component
| Component | Description |
|---|---|
| Column | The specific cell value for this column |
$colIndex
Zero-based column index
Used by: 1 component
| Component | Description |
|---|---|
| Column | Zero-based column index |
$completedItems
A list containing the queue items that have been completed (fully processed).
Used by: 1 component
| Component | Description |
|---|---|
| Queue | A list containing the queue items that have been completed (fully processed). |
$context
Contains the context data passed to the openAt() method. This allows menu items to access information about the element or data that triggered the context menu.
Used by: 1 component
| Component | Description |
|---|---|
| ContextMenu | Contains the context data passed to the openAt() method. This allows menu items to access information about the element or data that triggered the context menu. |
$data
This property represents the value of the form data. You can access the fields of the form using the IDs in the bindTo property of nested FormItem instances. $data also provides an update method as a shortcut to the Form's exposed update method.
Used by: 1 component
| Component | Description |
|---|---|
| Form | This property represents the value of the form data. You can access the fields of the form using the IDs in the bindTo property of nested FormItem instances. $data also provides an update method as a shortcut to the Form's exposed update method. |
$elapsed
Time elapsed since polling started in milliseconds
Used by: 1 component
| Component | Description |
|---|---|
| APICall | Time elapsed since polling started in milliseconds |
$error
Error details (available in errorNotificationMessage)
Used by: 1 component
| Component | Description |
|---|---|
| APICall | Error details (available in errorNotificationMessage) |
$group
Context variable exposed by the following components. See individual component descriptions for details.
Used by: 2 components
| Component | Description |
|---|---|
| List | Group information when using groupBy (available in group templates) |
| Select | Group name when using groupBy (available in group header templates) |
$header
This context value represents the header context with props: id (optional), index, label, isActive.
Used by: 1 component
| Component | Description |
|---|---|
| TabItem | This context value represents the header context with props: id (optional), index, label, isActive. |
$isFirst
Boolean indicating if this is the first item
Used by: 2 components
| Component | Description |
|---|---|
| Items | Boolean indicating if this is the first item |
| List | Boolean indicating if this is the first item |
$isLast
Boolean indicating if this is the last item
Used by: 2 components
| Component | Description |
|---|---|
| Items | Boolean indicating if this is the last item |
| List | Boolean indicating if this is the last item |
$item
Provides access to the current item being rendered in a list or iteration context.
Used by: 5 components
| Component | Description |
|---|---|
| AutoComplete | This context value represents an item when you define an option item template. Use $item.value and $item.label to refer to the value and label of the particular option. |
| Column | The complete data row object being rendered |
| Items | Current data item being rendered |
| List | Current data item being rendered |
| Select | Represents the current option's data (label and value properties) |
$itemContext
Provides the removeItem() method for multi-select scenarios
Used by: 1 component
| Component | Description |
|---|---|
| Select | Provides the removeItem() method for multi-select scenarios |
$itemIndex
Provides access to the current item being rendered in a list or iteration context.
Used by: 3 components
| Component | Description |
|---|---|
| Column | Zero-based row index |
| Items | Zero-based index of current item |
| List | Zero-based index of current item |
$overflow
Boolean indicating whether the child component is displayed in the overflow dropdown menu (true) or visible in the main bar (false).
Used by: 1 component
| Component | Description |
|---|---|
| ResponsiveBar | Boolean indicating whether the child component is displayed in the overflow dropdown menu (true) or visible in the main bar (false). |
$param
Context variable exposed by the following components. See individual component descriptions for details.
Used by: 2 components
| Component | Description |
|---|---|
| APICall | The first parameter passed to execute() method |
| ModalDialog | First parameter passed to the open() method |
$params
Context variable exposed by the following components. See individual component descriptions for details.
Used by: 2 components
| Component | Description |
|---|---|
| APICall | Array of all parameters passed to execute() method (access with $params[0], $params[1], etc.) |
| ModalDialog | Array of all parameters passed to open() method (access with $params[0], $params[1], etc.) |
$polling
Boolean indicating if polling is currently active in deferred mode
Used by: 1 component
| Component | Description |
|---|---|
| APICall | Boolean indicating if polling is currently active in deferred mode |
$progress
Current progress 0-100 when in deferred mode (extracted via progressExtractor expression)
Used by: 1 component
| Component | Description |
|---|---|
| APICall | Current progress 0-100 when in deferred mode (extracted via progressExtractor expression) |
$queuedItems
A list containing the items waiting in the queue, icluding the completed items.
Used by: 1 component
| Component | Description |
|---|---|
| Queue | A list containing the items waiting in the queue, icluding the completed items. |
$result
Response data (available in completedNotificationMessage)
Used by: 1 component
| Component | Description |
|---|---|
| APICall | Response data (available in completedNotificationMessage) |
$row
The complete data row object being rendered (the same as $item).
Used by: 1 component
| Component | Description |
|---|---|
| Column | The complete data row object being rendered (the same as $item). |
$rowIndex
Zero-based row index (the same as $itemIndex).
Used by: 1 component
| Component | Description |
|---|---|
| Column | Zero-based row index (the same as $itemIndex). |
$setValue
Function to set the FormItem's value programmatically
Used by: 1 component
| Component | Description |
|---|---|
| FormItem | Function to set the FormItem's value programmatically |
$statusData
Latest status response data when in deferred mode (available in event handlers and notifications)
Used by: 1 component
| Component | Description |
|---|---|
| APICall | Latest status response data when in deferred mode (available in event handlers and notifications) |
$validationResult
Current validation state and error messages for this field
Used by: 1 component
| Component | Description |
|---|---|
| FormItem | Current validation state and error messages for this field |
$value
Current value of the FormItem, accessible in expressions and code snippets
Used by: 1 component
| Component | Description |
|---|---|
| FormItem | Current value of the FormItem, accessible in expressions and code snippets |