Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
…entation into 24_2
  • Loading branch information
GoodDayForSurf committed Dec 10, 2024
2 parents c39ee58 + dc083d5 commit 971aabb
Show file tree
Hide file tree
Showing 91 changed files with 562 additions and 227 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ default: null
Binds the UI component to data.

---
[important] If you use [DataSource](/api-reference/30%20Data%20Layer/DataSource '/Documentation/ApiReference/Data_Layer/DataSource/'), disable [pagination](/api-reference/30%20Data%20Layer/DataSource/1%20Configuration/paginate.md '/Documentation/ApiReference/Data_Layer/DataSource/Configuration/#paginate') to ensure Chat functions properly.

#include common-dataSource-description with {
widget_works_with: "{WidgetName} works with collections of [objects](/api-reference/10%20UI%20Components/dxChat/9%20Types/Message '/Documentation/ApiReference/UI_Components/dxChat/Types/Message/') or `string` values.",

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ default: true
---
---
##### shortDescription
Specifies whether the Chat UI component displays newly entered messages immediately. This property only applies if a [DataSource](/api-reference/30%20Data%20Layer/DataSource '/Documentation/ApiReference/Data_Layer/DataSource/') object is used.
Specifies whether the Chat UI component displays newly entered messages immediately. This property only applies if [dataSource](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/dataSource.md '/Documentation/ApiReference/UI_Components/dxChat/Configuration/#dataSource') is used.

---
When you send a message in a Chat (press the "Send" button), the Chat triggers the store's [insert](/api-reference/30%20Data%20Layer/CustomStore/1%20Configuration/insert.md '/Documentation/ApiReference/Data_Layer/CustomStore/Configuration/#insert') method and adds the message to the store.

If **reloadOnChange** is enabled (default), the DataSource [reloads](/api-reference/30%20Data%20Layer/DataSource/3%20Methods/reload().md '/Documentation/ApiReference/Data_Layer/DataSource/Methods/#reload'): clears all items and calls the [load](/api-reference/30%20Data%20Layer/DataSource/3%20Methods/load().md '/Documentation/ApiReference/Data_Layer/DataSource/Methods/#load') method to update itself. Chat automatically listens to DataSource [changes](/api-reference/30%20Data%20Layer/DataSource/4%20Events/changed.md '/Documentation/ApiReference/Data_Layer/DataSource/Events/#changed') and updates the message feed with new messages.
If **reloadOnChange** is enabled (default), the dataSource [reloads](/api-reference/30%20Data%20Layer/DataSource/3%20Methods/reload().md '/Documentation/ApiReference/Data_Layer/DataSource/Methods/#reload'): clears all items and calls the [load](/api-reference/30%20Data%20Layer/DataSource/3%20Methods/load().md '/Documentation/ApiReference/Data_Layer/DataSource/Methods/#load') method to update itself. Chat automatically listens to dataSource [changes](/api-reference/30%20Data%20Layer/DataSource/4%20Events/changed.md '/Documentation/ApiReference/Data_Layer/DataSource/Events/#changed') and updates the message feed with new messages.

Disable **reloadOnChange** to manage large numbers of messages, prevent additional load requests, and control message rendering timing. Handle the store's CRUD operations and [render messages](/api-reference/10%20UI%20Components/dxChat/3%20Methods/renderMessage(message).md '/Documentation/ApiReference/UI_Components/dxChat/Methods/#renderMessagemessage') as your needs dictate.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ This property changes when the user clicks the **Select All** checkbox in the [h
<th>filterType / filterValues</th>
</tr>
<tr>
<td><img src="Content/images/doc/24_1/DataGrid/dg-selectall-unchecked.png"></td>
<td><img src="/images/DataGrid/dg-selectall-unchecked.png"></td>
<td><code>filterType: "include"</code><br><code>filterValues: null</code></td>
</tr>
<tr>
<td><img src="Content/images/doc/24_1/DataGrid/dg-selectall-checked.png"></td>
<td><img src="/images/DataGrid/dg-selectall-checked.png"></td>
<td><code>filterType: "exclude"</code><br><code>filterValues: null</code></td>
</tr>
</table>
Expand Down
2 changes: 0 additions & 2 deletions api-reference/50 Common/utils/devices/devices.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
id: DevicesObject
module: core/devices
export: default
---
---
##### shortDescription
Expand Down
2 changes: 1 addition & 1 deletion api-reference/_hidden/GridBaseColumn/filterOperations.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Specifies available filter operations. Applies if [allowFiltering](/api-referenc
---
The following table lists available filter operations by [data type](/api-reference/_hidden/GridBaseColumn/dataType.md '{basewidgetpath}/Configuration/columns/#dataType'). Users can apply these filter operations in the filter row and nested [filterBuilder](/api-reference/10%20UI%20Components/GridBase/1%20Configuration/filterBuilder.md '{basewidgetpath}/Configuration/#filterBuilder') component.

[note] The default filter operations for each data type are listed in the [selectedFilterOperation]({basewidgetpath}/Configuration/columns/#selectedFilterOperation) API section.
[note] The default filter operations for each data type are listed in the [selectedFilterOperation](/api-reference/_hidden/GridBaseColumn/selectedFilterOperation.md '{basewidgetpath}/Configuration/columns/#selectedFilterOperation') API section.

<table class="dx-table">
<tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@
<!-- ... -->
<script type="text/javascript" src="https://code.jquery.com/jquery-3.5.1.min.js"></script>

<link rel="stylesheet" href="https://cdn3.devexpress.com/jslib/minor_23_2/css/dx.light.css">
<link rel="stylesheet" href="https://cdn3.devexpress.com/jslib/minor_24_2/css/dx.light.css">
<link rel="stylesheet" href="index.css">

<script type="text/javascript" src="https://cdn3.devexpress.com/jslib/minor_23_2/js/dx.all.js"></script>
<script type="text/javascript" src="https://cdn3.devexpress.com/jslib/minor_24_2/js/dx.all.js"></script>
</head>
<body class="dx-viewport">
<div id="button"></div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
</tr>
<tr>
<td><a href="https://www.access-board.gov/ict/" target="_blank">Section 508</a> Support</td>
<td class="dx-table-row__center"><svg width="18" height="18"><use xlink:href="#svg-icon-success"/></svg></td>
<td class="dx-table-row__center"><svg width="18" height="18"><use xlink:href="#svg-icon-warning"/></svg></td>
</tr>
<tr>
<td><a href="https://www.w3.org/WAI/standards-guidelines/wcag/" target="_blank">WCAG 2.x</a> Support</td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,6 @@ The Calendar component meets a variety of <a href="https://www.access-board.gov/
<th>WCAG 2.x criteria</th>
<th>Exception description</th>
</tr>
<tr>
<td>501 (Web)(Software) <br> 504.2 (Authoring Tool) <br> 602.3 (Support Docs)</td>
<td>1.3.1 Info and Relationships (Level A)</td>
<td>Calendar does not pronounce selected range in multiselect mode.</td>
</tr>
<tr>
<td>501 (Web)(Software) <br> 504.2 (Authoring Tool) <br> 602.3 (Support Docs)</td>
<td>1.4.3 Contrast (Minimum) (Level AA) <br> 1.4.11 Non-text Contrast (Level AA 2.1 and 2.2)</td>
Expand Down
12 changes: 6 additions & 6 deletions concepts/05 UI Components/Chat/00 Overview/05 Elements.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<img src="/images/Chat/chat-elements.png" alt="Chat elements" style="width: 750px;"/>

1. [User name](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#showUserName)
2. [Timestamp](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#showMessageTimestamp)
3. [Day header](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#showDayHeaders)
4. [Avatar](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#showAvatar)
5. [Typing users](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#typingUsers)
6. [Message input](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#onMessageEntered)
1. [User name](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/showUserName.md '/Documentation/ApiReference/UI_Components/dxChat/Configuration/#showUserName')
2. [Timestamp](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/showMessageTimestamp.md '/Documentation/ApiReference/UI_Components/dxChat/Configuration/#showMessageTimestamp')
3. [Day header](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/showDayHeaders.md '/Documentation/ApiReference/UI_Components/dxChat/Configuration/#showDayHeaders')
4. [Avatar](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/showAvatar.md '/Documentation/ApiReference/UI_Components/dxChat/Configuration/#showAvatar')
5. [Typing users](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/typingUsers.md '/Documentation/ApiReference/UI_Components/dxChat/Configuration/#typingUsers')
6. [Message input](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/onMessageEntered.md '/Documentation/ApiReference/UI_Components/dxChat/Configuration/#onMessageEntered')
6 changes: 3 additions & 3 deletions concepts/05 UI Components/Chat/00 Overview/10 Key Features.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
- **Control Message Feed**
Set initial Chat messages and display new ones with the [items](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#items) array, [renderMessage](/Documentation/ApiReference/UI_Components/dxChat/Methods/#renderMessagemessage) method, or [dataSource](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#dataSource) CRUD operations. Use [onMessageEntered](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#onMessageEntered) to define actions after a message is entered.
Set initial Chat messages and display new ones with the [items](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/items.md '/Documentation/ApiReference/UI_Components/dxChat/Configuration/#items') array, [renderMessage](/api-reference/10%20UI%20Components/dxChat/3%20Methods/renderMessage(message).md '/Documentation/ApiReference/UI_Components/dxChat/Methods/#renderMessagemessage') method, or [dataSource](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/dataSource.md '/Documentation/ApiReference/UI_Components/dxChat/Configuration/#dataSource') CRUD operations. Use [onMessageEntered](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/onMessageEntered.md '/Documentation/ApiReference/UI_Components/dxChat/Configuration/#onMessageEntered') to define actions after a message is entered.

- **Integrate AI and Chatbots**
The DevExtreme Chat component allows you to add AI assistants by configuring AI services in the backend.
Expand All @@ -9,10 +9,10 @@ The DevExtreme Chat component allows you to add AI assistants by configuring AI
}

- **Typing Status**
Typing triggers [typingStart](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#onTypingStart), while stopping or sending a message raises [typingEnd](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#onTypingEnd). Use these events to manage the [typingUsers](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#typingUsers) array, indicating who is typing in the Chat.
Typing triggers [typingStart](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/onTypingStart.md '/Documentation/ApiReference/UI_Components/dxChat/Configuration/#onTypingStart'), while stopping or sending a message raises [typingEnd](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/onTypingEnd.md '/Documentation/ApiReference/UI_Components/dxChat/Configuration/#onTypingEnd'). Use these events to manage the [typingUsers](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/typingUsers.md '/Documentation/ApiReference/UI_Components/dxChat/Configuration/#typingUsers') array, indicating who is typing in the Chat.

- **UI Customization**
Customize Chat messages with [messageTemplate](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#messageTemplate). Display runtime issues with the [alerts](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#alerts) array. Control UI elements with properties like [showAvatar](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#showAvatar), and adjust date/time formats with options like [messageTimestampFormat](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#messageTimestampFormat).
Customize Chat messages with [messageTemplate](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/messageTemplate.md '/Documentation/ApiReference/UI_Components/dxChat/Configuration/#messageTemplate'). Display runtime issues with the [alerts](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/alerts.md '/Documentation/ApiReference/UI_Components/dxChat/Configuration/#alerts') array. Control UI elements with properties like [showAvatar](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/showAvatar.md '/Documentation/ApiReference/UI_Components/dxChat/Configuration/#showAvatar'), and adjust date/time formats with options like [messageTimestampFormat](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/messageTimestampFormat.md '/Documentation/ApiReference/UI_Components/dxChat/Configuration/#messageTimestampFormat').

#include btn-open-demo with {
href: "https://js.devexpress.com/Demos/WidgetsGallery/Demo/Chat/Customization/"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- [Getting Started with Chat](/concepts/05%20UI%20Components/Chat/00%20Getting%20Started%20with%20Chat '/Documentation/Guide/UI_Components/Chat/Getting_Started_with_Chat/')
- [Getting Started with Chat](/concepts/05%20UI%20Components/Chat/05%20Getting%20Started%20with%20Chat/00%20Getting%20Started%20with%20Chat.md '/Documentation/Guide/UI_Components/Chat/Getting_Started_with_Chat/')

- [API](/api-reference/10%20UI%20Components/dxChat '/Documentation/ApiReference/UI_Components/dxChat/')

Expand Down
Empty file.
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
[note] The overall accessibility level of your application depends on the Chat features you use.

<table class="dx-table">
<tr>
<th class="dx-table-row__width-80">Accessibility Requirement</th>
<th>Support Level</th>
</tr>
<tr>
<td>Right-to-Left Support</td>
<td class="dx-table-row__center"><svg width="18" height="18"><use xlink:href="#svg-icon-success"/></svg></td>
</tr>
<tr>
<td>Keyboard Navigation Support</td>
<td class="dx-table-row__center"><svg width="18" height="18"><use xlink:href="#svg-icon-success"/></svg></td>
</tr>
<tr>
<td>Screen Reader Support</td>
<td class="dx-table-row__center"><svg width="18" height="18"><use xlink:href="#svg-icon-success"/></svg></td>
</tr>
<tr>
<td>Contrast Color Theme</td>
<td class="dx-table-row__center"><svg width="18" height="18"><use xlink:href="#svg-icon-warning"/></svg></td>
</tr>
<tr>
<td>Mobile Device Support</td>
<td class="dx-table-row__center"><svg width="18" height="18"><use xlink:href="#svg-icon-success"/></svg></td>
</tr>
<tr>
<td><a href="https://developer.chrome.com/docs/lighthouse/" target="_blank">Lighthouse</a> Accessibility Validation</td>
<td class="dx-table-row__center"><svg width="18" height="18"><use xlink:href="#svg-icon-success"/></svg></td>
</tr>
<tr>
<td><a href="https://www.deque.com/axe/" target="_blank">Axe</a> Accessibility Validation</td>
<td class="dx-table-row__center"><svg width="18" height="18"><use xlink:href="#svg-icon-success"/></svg></td>
</tr>
<tr>
<td><a href="https://wave.webaim.org/" target="_blank">WAVE</a> Accessibility Validation</td>
<td class="dx-table-row__center"><svg width="18" height="18"><use xlink:href="#svg-icon-warning"/></svg></td>
</tr>
<tr>
<td><a href="https://www.access-board.gov/ict/" target="_blank">Section 508</a> Support</td>
<td class="dx-table-row__center"><svg width="18" height="18"><use xlink:href="#svg-icon-success"/></svg></td>
</tr>
<tr>
<td><a href="https://www.w3.org/WAI/standards-guidelines/wcag/" target="_blank">WCAG 2.x</a> Support</td>
<td class="dx-table-row__center"><svg width="18" height="18"><use xlink:href="#svg-icon-success"/></svg></td>
</tr>
</table>

<ul style="list-style-type: none;">
<li style="display: flex; align-items: center;"><svg width="18" height="18" style="padding: 2px 4px 0px 0px;"><use xlink:href="#svg-icon-success"/></svg> - All component features meet the requirement</li>
<li style="display: flex; align-items: center;"><svg width="18" height="18" style="padding: 2px 4px 0px 0px;"><use xlink:href="#svg-icon-warning"/></svg> - Some component features may not meet the requirement</li>
<li style="display: flex; align-items: center;"><svg width="18" height="18" style="padding: 2px 4px 0px 0px;"><use xlink:href="#svg-icon-error"/></svg> - Accessibility requirement is not supported</li>
</ul>

Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
The Chat component meets a variety of <a href="https://www.access-board.gov/ict/" target="_blank">Section 508</a> and <a href="https://www.w3.org/WAI/standards-guidelines/wcag/" target="_blank">WCAG 2.x</a> compliance standards. Known exceptions:

<table class="dx-table">
<tr>
<th>Section 508 criteria</th>
<th>WCAG 2.x criteria</th>
<th>Exception description</th>
</tr>
<tr>
<td>501 (Web)(Software) <br> 504.2 (Authoring Tool) <br> 602.3 (Support Docs)</td>
<td>1.4.3 Contrast (Minimum) (Level AA) <br> 1.4.11 Non-text Contrast (Level AA 2.1 and 2.2)</td>
<td>Chat does not support Windows High Contrast themes.</td>
</tr>
</table>
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
A user can use the following keys to interact with the Chat component:

<table class="dx-table">
<tr>
<th>Key</th>
<th>Action</th>
</tr>
<tr>
<td>Enter</td>
<td>Enters a message.</td>
</tr>
</table>

#include common-code-register-key-handler
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The Chat component supports screen readers and complies to <a href="https://www.w3.org/WAI/standards-guidelines/aria/" target="_blank">WAI-ARIA</a> standards.
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ The ColorBox component meets a variety of <a href="https://www.access-board.gov/
<td>2.4.3 Focus Order (Level A)</td>
<td>The ColorBox component does not meet this criterion.</td>
</tr>
<tr>
<td>501 (Web)(Software) <br> 504.2 (Authoring Tool) <br> 602.3 (Support Docs)</td>
<td>2.4.7 Focus Visible (Level AA) </td>
<td>The ColorBox palette handle does not have a focus indicator.</td>
</tr>
<tr>
<td>-</td>
<td>2.5.8 Target Size (Minimum) (Level AA 2.2 only)</td>
Expand Down
Loading

0 comments on commit 971aabb

Please sign in to comment.