Vue Chat Methods

beginUpdate()

Postpones rendering that can negatively affect performance until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.

defaultOptions(rule)

Specifies the device-dependent default configuration properties for this component.

Parameters:

rule:

Object

The component's default device properties.

Object structure:

Name	Type	Description
device	Device \| Function	Device parameters. When you specify a function, get information about the current device from the argument. Return true if the properties should be applied to the device.
options	Object	Options to be applied.

Name

Type

Description

device

Device

|

Function

Device parameters.
When you specify a function, get information about the current device from the argument. Return true if the properties should be applied to the device.

options

Object

Options to be applied.

defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the Chat UI component in an application executed on the desktop.

jQuery

JavaScript

DevExpress.ui.dxChat.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the Chat properties
    }
});

Angular

TypeScript

import Chat, { Properties } from "devextreme/ui/chat";
// ...
export class AppComponent {
    constructor () {
        Chat.defaultOptions<Properties>({
            device: { deviceType: "desktop" },
            options: {
                // Here go the Chat properties
            }
        });
    }
}

Vue

<template>
    <div>
        <DxChat id="chat1" />
        <DxChat id="chat2" />
    </div>
</template>
<script>
import DxChat from "devextreme-vue/chat";
import Chat from "devextreme/ui/chat";

Chat.defaultOptions({
    device: { deviceType: "desktop" },
    options: {
        // Here go the Chat properties
    }
});

export default {
    components: {
        DxChat
    }
}
</script>

React

import dxChat from "devextreme/ui/chat";
import Chat from "devextreme-react/chat";

dxChat.defaultOptions({
    device: { deviceType: "desktop" },
    options: {
        // Here go the Chat properties
    }
});

export default function App() {
    return (
        <div>
            <Chat id="chat1" />
            <Chat id="chat2" />
        </div>
    )
}

You can also set rules for multiple device types:

jQuery

JavaScript

const devicesConfig = [
    { deviceType: 'desktop' },
    { deviceType: 'tablet' },
    { deviceType: 'phone' },
];

devicesConfig.forEach(deviceConfig => {
    DevExpress.ui.dxChat.defaultOptions({ 
        device: deviceConfig,
        options: {
            // Here go the Chat properties
        }
    });
});

Angular

TypeScript

import Chat, { Properties } from "devextreme/ui/chat";
// ...
export class AppComponent {
    constructor () {
        const devicesConfig = [
            { deviceType: 'desktop' },
            { deviceType: 'tablet' },
            { deviceType: 'phone' },
        ];

        devicesConfig.forEach(deviceConfig => {
            Chat.defaultOptions<Properties>({
                device: deviceConfig,
                options: {
                    // Here go the Chat properties
                }
            });
        });
    }
}

Vue

<template>
    <div>
        <DxChat />
    </div>
</template>
<script>
import DxChat from "devextreme-vue/chat";
import Chat from "devextreme/ui/chat";

const devicesConfig = [
    { deviceType: 'desktop' },
    { deviceType: 'tablet' },
    { deviceType: 'phone' },
];

devicesConfig.forEach(deviceConfig => {
    Chat.defaultOptions({
        device: deviceConfig,
        options: {
            // Here go the Chat properties
        }
    });
});

export default {
    components: {
        DxChat
    }
}
</script>

React

import dxChat from "devextreme/ui/chat";
import Chat from "devextreme-react/chat";

const devicesConfig = [
    { deviceType: 'desktop' },
    { deviceType: 'tablet' },
    { deviceType: 'phone' },
];

devicesConfig.forEach(deviceConfig => {
    dxChat.defaultOptions({
        device: deviceConfig,
        options: {
            // Here go the Chat properties
        }
    });
});

export default function App() {
    return (
        <div>
            <Chat />
        </div>
    )
}

dispose()

Disposes of all the resources allocated to the Chat instance.

jQuery

After calling this method, remove the DOM element associated with the UI component:

JavaScript

$("#myChat").dxChat("dispose");
$("#myChat").remove();

Angular

Use conditional rendering instead of this method:

app.component.html

<dx-chat ...
    *ngIf="condition">
</dx-chat>

Vue

Use conditional rendering instead of this method:

App.vue

<template>
    <DxChat ...
        v-if="condition">
    </DxChat>
</template>

<script>
import DxChat from 'devextreme-vue/chat';

export default {
    components: {
        DxChat
    }
}
</script>

React

Use conditional rendering instead of this method:

App.js

import React from 'react';

import Chat from 'devextreme-react/chat';

function DxChat(props) {
    if (!props.shouldRender) {
        return null;
    }

    return (
        <Chat ... >    
        </Chat>
    );
}

class App extends React.Component {
    render() {
        return (
            <DxChat shouldRender="condition" />
        );
    }
}
export default App;

element()

Gets the root UI component element.

Return Value:

HTMLElement | jQuery

An HTML element or a jQuery element when you use jQuery.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.

The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

focus()

Sets focus on the UI component.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

getDataSource()

Gets the DataSource instance.

Return Value:

DataSource

The DataSource instance.

NOTE

This method returns the DataSource instance even if the UI component's dataSource property was given a simple array.

View on GitHub

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

getInstance(element)

Gets the instance of a UI component found using its DOM node.

Parameters:

element:

Element

|

jQuery

The UI component's container.

Return Value:

Object

The UI component's instance.

getInstance is a static method that the UI component class supports. The following code demonstrates how to get the Chat instance found in an element with the myChat ID:

// Modular approach
import Chat from "devextreme/ui/chat";
...
let element = document.getElementById("myChat");
let instance = Chat.getInstance(element) as Chat;

// Non-modular approach
let element = document.getElementById("myChat");
let instance = DevExpress.ui.dxChat.getInstance(element);