id |
String
|
|
The unique identifier of the component. |
containerElement |
HTMLElement
|
|
The parent element of the component's root element. |
beforeElement |
HTMLElement
|
|
The component's root element will be placed before this node when specified. |
name |
String
|
|
The name of the component's input field when applicable. |
theme |
componyx.UI.base.static.ThemeOption
|
|
The active styling theme of the component. |
themeName |
String
|
|
The CSS theme name which is set on the component's root element. |
cssClass |
String
|
|
The CSS class of the component's root HTMLElement. |
cssClassTouch |
String
|
|
The CSS class applied to the component's root HTMLElement when dealing with a touch device. |
style |
String
|
|
The CSS style text applied to the root HTMLElement of the component. |
title |
String
|
|
The title of the root element. |
tabIndex |
String
|
|
The tabindex of the component's root HTMLElement. |
autoTouchConfig |
Boolean
|
true
|
A value indicating if the component automatically uses optimal touch device settings when rendered on a touch device. |
cloneInput |
Boolean
|
false
|
A value indicating if the source input is cloned when a (hidden)input is used as base element. |
keepInputId |
Boolean
|
true
|
A value indicating if the source input id is kept when a (hidden)input is cloned and used as base element. Should be false when cloning a single input for use in multiple components. |
keepInputEventHandlers |
Boolean
|
false
|
A value indicating if the source input event handlers are kept when a (hidden)input is cloned and used as base element. |
disableDefaultCssClass |
Boolean
|
false
|
A value indicating if the default component css class is set on the component element. |
renderState |
componyx.UI.base.static.RenderState
|
|
The current render state of the component. |
element |
HTMLElement
|
|
The root HTMLElement of the component. |
showing |
Boolean
|
false
|
A value indicating if the component is visible. This active state might differ from property hidden when async resources are loaded, i.e. when a component.show() is called this property value is set to true while the hidden property will also remain true until the resources are loaded and the component is rendered. |
allowPostRender |
Boolean
|
true
|
A value indicating if the post render event is allowed. |
renderWhenConnected |
Boolean
|
false
|
A value indicating if the component is rendered when the connectedCallback method is invoked. This property only applies to components that are build as standard Web Component with a custom element definition, see documentation for applicable components. |
ignoreConnectionCallbacks |
Boolean
|
false
|
A value indicating if the execution of the connectedCallback and disconnectedCallback are prevented during DOM modifications (e.g. replaceChild, appendChild, insertBefore, replaceWith). By default, this is false. If needed, you can set it to true before modifying the DOM. This property only applies to components built as standard Web Components with a custom element definition; see documentation for applicable components. |
canRender |
Boolean
|
true
|
A value indicating if the component is allowed to render. Useful for delaying rendering until data binding (using any prefered framework) is complete when attributes are data-bound. |
templates |
Object
|
|
Initialized Templates of the component. |
store |
Object
|
|
Internal storage of UI child components. |
events |
componyx.UI.base.Events
|
|
The base component events. |
ajax |
Object
|
|
Contains AJAX configuration and dynamically created AJAX methods.
Properties
| Name |
Type |
Attributes |
Default |
Description |
url |
String
|
|
|
The default base URL used for AJAX calls. |
absoluteURL |
Boolean
|
|
true
|
Indicates whether the url is treated as absolute (true) or relative to the current location (false). |
headers |
Object.<string, string>
|
<optional>
|
null
|
Optional HTTP request headers to include with each AJAX call. |
jsonResponseDataWrapper |
String
|
|
'd'
|
The JSON wrapper key used to extract data from the server response (e.g., for ASP.NET JSON responses). |
jsonDeserializer |
function
|
null
|
|
null
|
Optional function to deserialize JSON data from the server. |
load |
componyx.UI.base.AjaxMethod
|
|
|
Default AJAX method instance used for basic data loading. |
addMethod |
componyx.UI.base.AddAjaxMethod
|
|
|
INTERNAL: Adds or overrides a named AJAX method. |
|