JavaScript/jQuery DeferRendering API
The DeferRendering is a UI component that waits for its content to be ready before rendering it. While the content is getting ready, the DeferRendering displays a loading indicator.
This component is deprecated. To defer rendering in other components, enable the corresponding deferRendering properties. You can also create a loading indicator and display it based on your logic.
Angular
For details on how to defer loading in jQuery, refer to the following help topic: Deferred loading with @defer.
Vue
For details on how to defer loading in jQuery, refer to the following help topic: Suspense.
React
For details on how to defer loading in jQuery, refer to the following help topics: Suspense and useDeferredValue.
See Also
jQuery
Angular
Vue
React
Options
An object defining configuration properties for the UI component.
| Name | Description |
|---|---|
| accessKey | Specifies the shortcut key that sets focus on the UI component. |
| activeStateEnabled | Specifies whether the UI component changes its visual state as a result of user interaction. |
| animation | Specifies the animation to be used to show the rendered content. |
| disabled | Specifies whether the UI component responds to user interaction. |
| elementAttr | Specifies the global attributes to be attached to the UI component's container element. |
| focusStateEnabled | Specifies whether the UI component can be focused using keyboard navigation. |
| height | Specifies the UI component's height. |
| hint | Specifies text for a hint that appears when a user pauses on the UI component. |
| hoverStateEnabled | Specifies whether the UI component changes its state when a user pauses on it. |
| onContentReady | A function that is executed when the UI component is rendered and each time the component is repainted. |
| onDisposing | A function that is executed before the UI component is disposed of. |
| onInitialized | A function used in JavaScript frameworks to save the UI component instance. |
| onOptionChanged | A function that is executed after a UI component property is changed. |
| onRendered | A function that is executed when the content is rendered but not yet displayed. |
| onShown | A function that is executed when the content is displayed and animation is completed. |
| renderWhen | Specifies when the UI component content is rendered. |
| rtlEnabled | Switches the UI component to a right-to-left representation. |
| showLoadIndicator | Indicates if a load indicator should be shown until the UI component's content is rendered. |
| staggerItemSelector | Specifies a jQuery selector of items that should be rendered using a staggered animation. |
| tabIndex | Specifies the number of the element when the Tab key is used for navigating. |
| visible | Specifies whether the UI component is visible. |
| width | Specifies the UI component's width. |
Methods
This section describes members used to manipulate the UI component.
| Name | Description |
|---|---|
| beginUpdate() | Postpones rendering that can negatively affect performance until the endUpdate() method is called. |
| defaultOptions(rule) | Specifies the device-dependent default configuration properties for this component. |
| dispose() | Disposes of all the resources allocated to the DeferRendering instance. |
| element() | Gets the root UI component element. |
| endUpdate() | Refreshes the UI component after a call of the beginUpdate() method. |
| focus() | Sets focus on the UI component. |
| getInstance(element) | Gets the instance of a UI component found using its DOM node. |
| instance() | Gets the UI component's instance. Use it to access other methods of the UI component. |
| off(eventName) | Detaches all event handlers from a single event. |
| off(eventName, eventHandler) | Detaches a particular event handler from a single event. |
| on(eventName, eventHandler) | Subscribes to an event. |
| on(events) | Subscribes to events. |
| option() | Gets all UI component properties. |
| option(optionName) | Gets the value of a single property. |
| option(optionName, optionValue) | Updates the value of a single property. |
| option(options) | Updates the values of several properties. |
| registerKeyHandler(key, handler) | Registers a handler to be executed when a user presses a specific key. |
| repaint() | Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically. |
| resetOption(optionName) | Resets a property to its default value. |
Events
This section describes events fired by this UI component.
| Name | Description |
|---|---|
| contentReady | Raised when the UI component is rendered and each time the component is repainted. |
| disposing | Raised before the UI component is disposed of. |
| initialized | Raised only once, after the UI component is initialized. |
| optionChanged | Raised after a UI component property is changed. |
| rendered | Raised when the content is rendered but not yet displayed. |
| shown | Raised when the content is displayed and animation is completed. |
See Also
Types
| Name | Description |
|---|---|
| ContentReadyEvent | The type of the contentReady event handler's argument. |
| DisposingEvent | The type of the disposing event handler's argument. |
| InitializedEvent | The type of the initialized event handler's argument. |
| OptionChangedEvent | The type of the optionChanged event handler's argument. |
| RenderedEvent | The type of the rendered event handler's argument. |
| ShownEvent | The type of the shown event handler's argument. |
If you have technical questions, please create a support ticket in the DevExpress Support Center.