@bryntum/core-react-thin 7.2.4 → 7.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/BryntumBooleanCombo.d.ts +261 -0
- package/lib/BryntumBooleanCombo.js +204 -0
- package/lib/BryntumBooleanCombo.js.map +1 -0
- package/lib/BryntumButton.d.ts +6 -14
- package/lib/BryntumButton.js +1 -2
- package/lib/BryntumButton.js.map +1 -1
- package/lib/BryntumButtonGroup.d.ts +8 -15
- package/lib/BryntumButtonGroup.js +2 -5
- package/lib/BryntumButtonGroup.js.map +1 -1
- package/lib/BryntumChatPanel.d.ts +16 -20
- package/lib/BryntumChatPanel.js +7 -6
- package/lib/BryntumChatPanel.js.map +1 -1
- package/lib/BryntumCheckbox.d.ts +7 -15
- package/lib/BryntumCheckbox.js +1 -2
- package/lib/BryntumCheckbox.js.map +1 -1
- package/lib/BryntumCheckboxGroup.d.ts +9 -21
- package/lib/BryntumCheckboxGroup.js +2 -6
- package/lib/BryntumCheckboxGroup.js.map +1 -1
- package/lib/BryntumChipView.d.ts +6 -14
- package/lib/BryntumChipView.js +1 -2
- package/lib/BryntumChipView.js.map +1 -1
- package/lib/BryntumCodeEditor.d.ts +9 -20
- package/lib/BryntumCodeEditor.js +2 -5
- package/lib/BryntumCodeEditor.js.map +1 -1
- package/lib/BryntumColorField.d.ts +7 -15
- package/lib/BryntumColorField.js +1 -2
- package/lib/BryntumColorField.js.map +1 -1
- package/lib/BryntumCombo.d.ts +10 -18
- package/lib/BryntumCombo.js +1 -2
- package/lib/BryntumCombo.js.map +1 -1
- package/lib/BryntumContainer.d.ts +7 -14
- package/lib/BryntumContainer.js +2 -5
- package/lib/BryntumContainer.js.map +1 -1
- package/lib/BryntumDateField.d.ts +7 -15
- package/lib/BryntumDateField.js +1 -2
- package/lib/BryntumDateField.js.map +1 -1
- package/lib/BryntumDatePicker.d.ts +9 -20
- package/lib/BryntumDatePicker.js +2 -5
- package/lib/BryntumDatePicker.js.map +1 -1
- package/lib/BryntumDateRangeField.d.ts +10 -18
- package/lib/BryntumDateRangeField.js +1 -2
- package/lib/BryntumDateRangeField.js.map +1 -1
- package/lib/BryntumDateTimeField.d.ts +7 -15
- package/lib/BryntumDateTimeField.js +1 -2
- package/lib/BryntumDateTimeField.js.map +1 -1
- package/lib/BryntumDemoCodeEditor.d.ts +9 -20
- package/lib/BryntumDemoCodeEditor.js +2 -5
- package/lib/BryntumDemoCodeEditor.js.map +1 -1
- package/lib/BryntumDisplayField.d.ts +7 -15
- package/lib/BryntumDisplayField.js +1 -2
- package/lib/BryntumDisplayField.js.map +1 -1
- package/lib/BryntumDurationField.d.ts +7 -15
- package/lib/BryntumDurationField.js +1 -2
- package/lib/BryntumDurationField.js.map +1 -1
- package/lib/BryntumEditor.d.ts +9 -19
- package/lib/BryntumEditor.js +2 -5
- package/lib/BryntumEditor.js.map +1 -1
- package/lib/BryntumFieldFilterPicker.d.ts +7 -14
- package/lib/BryntumFieldFilterPicker.js +2 -5
- package/lib/BryntumFieldFilterPicker.js.map +1 -1
- package/lib/BryntumFieldFilterPickerGroup.d.ts +7 -14
- package/lib/BryntumFieldFilterPickerGroup.js +2 -5
- package/lib/BryntumFieldFilterPickerGroup.js.map +1 -1
- package/lib/BryntumFieldSet.d.ts +9 -21
- package/lib/BryntumFieldSet.js +2 -6
- package/lib/BryntumFieldSet.js.map +1 -1
- package/lib/BryntumFileField.d.ts +7 -15
- package/lib/BryntumFileField.js +1 -2
- package/lib/BryntumFileField.js.map +1 -1
- package/lib/BryntumFilePicker.d.ts +7 -14
- package/lib/BryntumFilePicker.js +2 -5
- package/lib/BryntumFilePicker.js.map +1 -1
- package/lib/BryntumFilterField.d.ts +7 -15
- package/lib/BryntumFilterField.js +1 -2
- package/lib/BryntumFilterField.js.map +1 -1
- package/lib/BryntumHint.d.ts +21 -30
- package/lib/BryntumHint.js +2 -5
- package/lib/BryntumHint.js.map +1 -1
- package/lib/BryntumLabel.d.ts +6 -14
- package/lib/BryntumLabel.js +1 -2
- package/lib/BryntumLabel.js.map +1 -1
- package/lib/BryntumList.d.ts +6 -14
- package/lib/BryntumList.js +1 -2
- package/lib/BryntumList.js.map +1 -1
- package/lib/BryntumMenu.d.ts +20 -25
- package/lib/BryntumMenu.js +2 -6
- package/lib/BryntumMenu.js.map +1 -1
- package/lib/BryntumMonthPicker.d.ts +9 -20
- package/lib/BryntumMonthPicker.js +2 -5
- package/lib/BryntumMonthPicker.js.map +1 -1
- package/lib/BryntumNumberField.d.ts +7 -15
- package/lib/BryntumNumberField.js +1 -2
- package/lib/BryntumNumberField.js.map +1 -1
- package/lib/BryntumPagingToolbar.d.ts +10 -17
- package/lib/BryntumPagingToolbar.js +2 -5
- package/lib/BryntumPagingToolbar.js.map +1 -1
- package/lib/BryntumPanel.d.ts +9 -20
- package/lib/BryntumPanel.js +2 -5
- package/lib/BryntumPanel.js.map +1 -1
- package/lib/BryntumPasswordField.d.ts +7 -15
- package/lib/BryntumPasswordField.js +1 -2
- package/lib/BryntumPasswordField.js.map +1 -1
- package/lib/BryntumProgressBar.d.ts +6 -14
- package/lib/BryntumProgressBar.js +1 -2
- package/lib/BryntumProgressBar.js.map +1 -1
- package/lib/BryntumRadio.d.ts +7 -15
- package/lib/BryntumRadio.js +1 -2
- package/lib/BryntumRadio.js.map +1 -1
- package/lib/BryntumRadioGroup.d.ts +9 -21
- package/lib/BryntumRadioGroup.js +2 -6
- package/lib/BryntumRadioGroup.js.map +1 -1
- package/lib/BryntumSlideToggle.d.ts +7 -15
- package/lib/BryntumSlideToggle.js +1 -2
- package/lib/BryntumSlideToggle.js.map +1 -1
- package/lib/BryntumSlider.d.ts +7 -14
- package/lib/BryntumSlider.js +2 -2
- package/lib/BryntumSlider.js.map +1 -1
- package/lib/BryntumSplitter.d.ts +6 -14
- package/lib/BryntumSplitter.js +1 -2
- package/lib/BryntumSplitter.js.map +1 -1
- package/lib/BryntumTabPanel.d.ts +9 -20
- package/lib/BryntumTabPanel.js +2 -5
- package/lib/BryntumTabPanel.js.map +1 -1
- package/lib/BryntumTextAreaField.d.ts +8 -15
- package/lib/BryntumTextAreaField.js +2 -2
- package/lib/BryntumTextAreaField.js.map +1 -1
- package/lib/BryntumTextAreaPickerField.d.ts +8 -16
- package/lib/BryntumTextAreaPickerField.js +1 -2
- package/lib/BryntumTextAreaPickerField.js.map +1 -1
- package/lib/BryntumTextField.d.ts +7 -15
- package/lib/BryntumTextField.js +1 -2
- package/lib/BryntumTextField.js.map +1 -1
- package/lib/BryntumTimeField.d.ts +8 -16
- package/lib/BryntumTimeField.js +1 -2
- package/lib/BryntumTimeField.js.map +1 -1
- package/lib/BryntumTimePicker.d.ts +7 -14
- package/lib/BryntumTimePicker.js +2 -5
- package/lib/BryntumTimePicker.js.map +1 -1
- package/lib/BryntumToolbar.d.ts +10 -17
- package/lib/BryntumToolbar.js +2 -5
- package/lib/BryntumToolbar.js.map +1 -1
- package/lib/BryntumWidget.d.ts +6 -14
- package/lib/BryntumWidget.js +1 -2
- package/lib/BryntumWidget.js.map +1 -1
- package/lib/BryntumYearPicker.d.ts +9 -20
- package/lib/BryntumYearPicker.js +2 -5
- package/lib/BryntumYearPicker.js.map +1 -1
- package/lib/WrapperHelper.js +2 -2
- package/lib/WrapperHelper.js.map +1 -1
- package/lib/index.d.ts +1 -0
- package/lib/index.js +1 -0
- package/lib/index.js.map +1 -1
- package/package.json +1 -1
- package/src/BryntumBooleanCombo.tsx +1180 -0
- package/src/BryntumButton.tsx +69 -115
- package/src/BryntumButtonGroup.tsx +78 -123
- package/src/BryntumChatPanel.tsx +139 -169
- package/src/BryntumCheckbox.tsx +73 -117
- package/src/BryntumCheckboxGroup.tsx +109 -179
- package/src/BryntumChipView.tsx +65 -105
- package/src/BryntumCodeEditor.tsx +106 -167
- package/src/BryntumColorField.tsx +73 -117
- package/src/BryntumCombo.tsx +92 -152
- package/src/BryntumContainer.tsx +78 -124
- package/src/BryntumDateField.tsx +80 -123
- package/src/BryntumDatePicker.tsx +119 -193
- package/src/BryntumDateRangeField.tsx +79 -126
- package/src/BryntumDateTimeField.tsx +73 -117
- package/src/BryntumDemoCodeEditor.tsx +106 -167
- package/src/BryntumDisplayField.tsx +74 -119
- package/src/BryntumDurationField.tsx +80 -125
- package/src/BryntumEditor.tsx +90 -140
- package/src/BryntumFieldFilterPicker.tsx +80 -128
- package/src/BryntumFieldFilterPickerGroup.tsx +82 -132
- package/src/BryntumFieldSet.tsx +105 -172
- package/src/BryntumFileField.tsx +73 -117
- package/src/BryntumFilePicker.tsx +78 -124
- package/src/BryntumFilterField.tsx +76 -123
- package/src/BryntumHint.tsx +133 -190
- package/src/BryntumLabel.tsx +59 -95
- package/src/BryntumList.tsx +62 -101
- package/src/BryntumMenu.tsx +128 -188
- package/src/BryntumMonthPicker.tsx +106 -167
- package/src/BryntumNumberField.tsx +77 -121
- package/src/BryntumPagingToolbar.tsx +82 -129
- package/src/BryntumPanel.tsx +106 -167
- package/src/BryntumPasswordField.tsx +73 -117
- package/src/BryntumProgressBar.tsx +58 -93
- package/src/BryntumRadio.tsx +73 -117
- package/src/BryntumRadioGroup.tsx +109 -178
- package/src/BryntumSlideToggle.tsx +73 -117
- package/src/BryntumSlider.tsx +67 -101
- package/src/BryntumSplitter.tsx +61 -99
- package/src/BryntumTabPanel.tsx +107 -169
- package/src/BryntumTextAreaField.tsx +81 -119
- package/src/BryntumTextAreaPickerField.tsx +75 -120
- package/src/BryntumTextField.tsx +74 -119
- package/src/BryntumTimeField.tsx +79 -120
- package/src/BryntumTimePicker.tsx +78 -124
- package/src/BryntumToolbar.tsx +82 -129
- package/src/BryntumWidget.tsx +59 -95
- package/src/BryntumYearPicker.tsx +107 -169
- package/src/WrapperHelper.tsx +2 -2
- package/src/index.ts +1 -0
package/src/BryntumChatPanel.tsx
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
5
5
|
import React, { RefObject } from 'react';
|
|
6
|
-
import { AlignSpec, Base, ChatMessageModelConfig, ChatPanel, ChatPanelListeners, Color, Container, CoreContainerItemConfig, CoreContainerLayoutConfig, DomConfig, KeyMapConfig, Layout, MaskConfig, MenuItemConfig, MenuItemEntry, Model, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, Rectangle, Scroller, ScrollerConfig, StateProvider,
|
|
6
|
+
import { AlignSpec, Base, ChatMessageModelConfig, ChatPanel, ChatPanelListeners, Color, Container, CoreContainerItemConfig, CoreContainerLayoutConfig, DomConfig, KeyMapConfig, Layout, MaskConfig, MenuItemConfig, MenuItemEntry, Model, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, ReactJSX, Rectangle, Scroller, ScrollerConfig, StateProvider, TabConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
|
|
7
7
|
|
|
8
8
|
import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
|
|
9
9
|
|
|
@@ -12,14 +12,12 @@ export type BryntumChatPanelProps = {
|
|
|
12
12
|
/**
|
|
13
13
|
* Element (or element id) to adopt as this Widget's encapsulating element. The widget's
|
|
14
14
|
* content will be placed inside this element.
|
|
15
|
-
* ...
|
|
16
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-adopt)
|
|
15
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-adopt)
|
|
17
16
|
*/
|
|
18
17
|
adopt? : HTMLElement|string
|
|
19
18
|
/**
|
|
20
19
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
21
|
-
* ...
|
|
22
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-align)
|
|
20
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-align)
|
|
23
21
|
*/
|
|
24
22
|
align? : AlignSpec|string
|
|
25
23
|
/**
|
|
@@ -33,6 +31,10 @@ export type BryntumChatPanelProps = {
|
|
|
33
31
|
* `true` to show a connector arrow pointing to the align target.
|
|
34
32
|
*/
|
|
35
33
|
anchor? : boolean
|
|
34
|
+
/**
|
|
35
|
+
* Set to `true` to animate incoming messages with a character-by-character typing effect.
|
|
36
|
+
*/
|
|
37
|
+
animateTyping? : boolean
|
|
36
38
|
/**
|
|
37
39
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
38
40
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
@@ -41,15 +43,13 @@ export type BryntumChatPanelProps = {
|
|
|
41
43
|
/**
|
|
42
44
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
|
|
43
45
|
* into an element which will be linked using the `aria-describedby` attribute.
|
|
44
|
-
* ...
|
|
45
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-ariaDescription)
|
|
46
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-ariaDescription)
|
|
46
47
|
*/
|
|
47
48
|
ariaDescription? : string
|
|
48
49
|
/**
|
|
49
50
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
|
|
50
51
|
* the `aria-label` attribute.
|
|
51
|
-
* ...
|
|
52
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-ariaLabel)
|
|
52
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-ariaLabel)
|
|
53
53
|
*/
|
|
54
54
|
ariaLabel? : string
|
|
55
55
|
/**
|
|
@@ -63,14 +63,12 @@ export type BryntumChatPanelProps = {
|
|
|
63
63
|
/**
|
|
64
64
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/core/docs/api/Core/widget/Toolbar),
|
|
65
65
|
* or array of config objects representing the child items of a Toolbar. Another way to add a bbar is to use [strips](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-strips).
|
|
66
|
-
* ...
|
|
67
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-bbar)
|
|
66
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-bbar)
|
|
68
67
|
*/
|
|
69
68
|
bbar? : (CoreContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
70
69
|
/**
|
|
71
70
|
* Custom CSS classes to add to the panel's body element.
|
|
72
|
-
* ...
|
|
73
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-bodyCls)
|
|
71
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-bodyCls)
|
|
74
72
|
*/
|
|
75
73
|
bodyCls? : string|object
|
|
76
74
|
/**
|
|
@@ -80,8 +78,7 @@ export type BryntumChatPanelProps = {
|
|
|
80
78
|
/**
|
|
81
79
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
82
80
|
* hierarchy when triggered.
|
|
83
|
-
* ...
|
|
84
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-bubbleEvents)
|
|
81
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-bubbleEvents)
|
|
85
82
|
*/
|
|
86
83
|
bubbleEvents? : object
|
|
87
84
|
/**
|
|
@@ -92,15 +89,13 @@ export type BryntumChatPanelProps = {
|
|
|
92
89
|
bubbleTools? : DomConfig
|
|
93
90
|
/**
|
|
94
91
|
* Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
95
|
-
* ...
|
|
96
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-callOnFunctions)
|
|
92
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-callOnFunctions)
|
|
97
93
|
*/
|
|
98
94
|
callOnFunctions? : boolean
|
|
99
95
|
/**
|
|
100
96
|
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
101
97
|
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
102
|
-
* ...
|
|
103
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-catchEventHandlerExceptions)
|
|
98
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-catchEventHandlerExceptions)
|
|
104
99
|
*/
|
|
105
100
|
catchEventHandlerExceptions? : boolean
|
|
106
101
|
/**
|
|
@@ -112,8 +107,7 @@ export type BryntumChatPanelProps = {
|
|
|
112
107
|
* Custom CSS classes to add to element.
|
|
113
108
|
* May be specified as a space separated string, or as an object in which property names
|
|
114
109
|
* with truthy values are used as the class names:
|
|
115
|
-
* ...
|
|
116
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-cls)
|
|
110
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-cls)
|
|
117
111
|
*/
|
|
118
112
|
cls? : string|object
|
|
119
113
|
/**
|
|
@@ -123,15 +117,13 @@ export type BryntumChatPanelProps = {
|
|
|
123
117
|
collapsed? : boolean
|
|
124
118
|
/**
|
|
125
119
|
* This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-collapsed).
|
|
126
|
-
* ...
|
|
127
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-collapsible)
|
|
120
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-collapsible)
|
|
128
121
|
*/
|
|
129
122
|
collapsible? : boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
|
|
130
123
|
/**
|
|
131
124
|
* Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
|
|
132
125
|
* `style` block.
|
|
133
|
-
* ...
|
|
134
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-color)
|
|
126
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-color)
|
|
135
127
|
*/
|
|
136
128
|
color? : Color
|
|
137
129
|
/**
|
|
@@ -155,8 +147,7 @@ export type BryntumChatPanelProps = {
|
|
|
155
147
|
* Custom CSS classes to add to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
|
|
156
148
|
* May be specified as a space separated string, or as an object in which property names
|
|
157
149
|
* with truthy values are used as the class names:
|
|
158
|
-
* ...
|
|
159
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-contentElementCls)
|
|
150
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-contentElementCls)
|
|
160
151
|
*/
|
|
161
152
|
contentElementCls? : string|object
|
|
162
153
|
/**
|
|
@@ -176,8 +167,7 @@ export type BryntumChatPanelProps = {
|
|
|
176
167
|
/**
|
|
177
168
|
* A [query](https://bryntum.com/products/core/docs/api/Core/widget/Container#function-query) selector function which can identify the descendant widget to which
|
|
178
169
|
* focus should be directed by default.
|
|
179
|
-
* ...
|
|
180
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-defaultFocus)
|
|
170
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-defaultFocus)
|
|
181
171
|
* @param {Core.widget.Widget} widget Widget passed to method
|
|
182
172
|
* @returns {boolean} truthy value if widget is the default one
|
|
183
173
|
*/
|
|
@@ -187,16 +177,15 @@ export type BryntumChatPanelProps = {
|
|
|
187
177
|
*/
|
|
188
178
|
defaults? : CoreContainerItemConfig
|
|
189
179
|
/**
|
|
190
|
-
* Check for CSS compatibility issues
|
|
191
|
-
*
|
|
192
|
-
* [
|
|
180
|
+
* Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
|
|
181
|
+
* checks:
|
|
182
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-detectCSSCompatibilityIssues)
|
|
193
183
|
*/
|
|
194
184
|
detectCSSCompatibilityIssues? : boolean
|
|
195
185
|
/**
|
|
196
186
|
* Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
|
|
197
187
|
* cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
|
|
198
|
-
* ...
|
|
199
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-disabled)
|
|
188
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-disabled)
|
|
200
189
|
*/
|
|
201
190
|
disabled? : boolean|'inert'
|
|
202
191
|
/**
|
|
@@ -204,41 +193,41 @@ export type BryntumChatPanelProps = {
|
|
|
204
193
|
* [strips collection](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
|
|
205
194
|
* `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
|
|
206
195
|
* body. Such widgets are called "edge strips".
|
|
207
|
-
* ...
|
|
208
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-dock)
|
|
196
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-dock)
|
|
209
197
|
*/
|
|
210
198
|
dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
211
199
|
/**
|
|
212
200
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
213
201
|
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
|
|
214
202
|
* property which controls when a drag should start.
|
|
215
|
-
* ...
|
|
216
|
-
*
|
|
203
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-draggable)
|
|
204
|
+
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
217
205
|
*/
|
|
218
|
-
draggable? : boolean|
|
|
219
|
-
handleSelector?: string
|
|
220
|
-
}
|
|
206
|
+
draggable? : boolean|object
|
|
221
207
|
/**
|
|
222
208
|
* Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
|
|
223
|
-
* ...
|
|
224
|
-
* [
|
|
225
|
-
* @param {
|
|
226
|
-
* @param {
|
|
227
|
-
* @param {boolean}
|
|
228
|
-
* @param {boolean,
|
|
229
|
-
* @param {boolean,string} autoClose.
|
|
230
|
-
* @param {
|
|
231
|
-
* @param {
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
drawer? : boolean|{side?: 'start'|'left'|'end'|'right'|'top'|'bottom', size?: string|number, inline?: boolean, autoClose: { mousedown?: boolean|string, focusout?: boolean|string, mouseout?: string }, autoCloseDelay?: number}
|
|
209
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-drawer)
|
|
210
|
+
* @param {'start','left','end','right','top','bottom'} [side] The side of the viewport to dock the drawer to. * `'start'` means the `inline-start` side. * `'end'` means the `inline-end` side.
|
|
211
|
+
* @param {string,number} [size] The size of the drawer in its collapsible axis.
|
|
212
|
+
* @param {boolean} [inline] If using the [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-appendTo) config to place the drawer inside a host widget, this may be set to `true` to make the drawer inline within that host. Note that, if using this, the layout of the host element must have `flex-direction` set appropriately.
|
|
213
|
+
* @param {boolean,object} [autoClose] Specifies what user actions should automatically close the drawer. Defaults to closing when the user clicks outside of the drawer or when focus moves outside of the drawer.
|
|
214
|
+
* @param {boolean,string} [autoClose.mousedown] If the user clicks outside of the drawer, the drawer will automatically be hidden. If the value is a string, it is used as a CSS selector to filter clicks which should close the drawer.
|
|
215
|
+
* @param {boolean,string} [autoClose.focusout] If focus moves outside of the drawer, the drawer will automatically be hidden.
|
|
216
|
+
* @param {string} [autoClose.mouseout] Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
|
|
217
|
+
* @param {number} [autoCloseDelay] When using `mouseout`, this is the delay in milliseconds
|
|
218
|
+
*/
|
|
219
|
+
drawer? : boolean|{ side?: 'start'|'left'|'end'|'right'|'top'|'bottom', size?: string|number, inline?: boolean, autoClose?: boolean|{ mousedown?: boolean|string, focusout?: boolean|string, mouseout?: string }, autoCloseDelay?: number }
|
|
235
220
|
/**
|
|
236
221
|
* An object specifying attributes to assign to the root element of this widget.
|
|
237
222
|
* Set `null` value to attribute to remove it.
|
|
238
|
-
* ...
|
|
239
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-elementAttributes)
|
|
223
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-elementAttributes)
|
|
240
224
|
*/
|
|
241
225
|
elementAttributes? : Record<string, string|null>
|
|
226
|
+
/**
|
|
227
|
+
* An array of example prompt strings displayed when the chat is empty. Clicking a prompt fills the
|
|
228
|
+
* message field with its text.
|
|
229
|
+
*/
|
|
230
|
+
examplePrompts? : string[]
|
|
242
231
|
extraData? : any
|
|
243
232
|
/**
|
|
244
233
|
* When this widget is a child of a [Container](https://bryntum.com/products/core/docs/api/Core/widget/Container), it will by default be participating in a
|
|
@@ -256,18 +245,15 @@ export type BryntumChatPanelProps = {
|
|
|
256
245
|
/**
|
|
257
246
|
* Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
|
|
258
247
|
* but rather plain HTML that follows the last element of the panel's body and [strips](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-strips).
|
|
259
|
-
* ...
|
|
260
|
-
*
|
|
248
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-footer)
|
|
249
|
+
* @property {'top','right','bottom','left','start','end'} dock Where to dock
|
|
250
|
+
* @property {string} html Html to populate the footer with
|
|
251
|
+
* @property {string} cls CSS class to add to the footer
|
|
261
252
|
*/
|
|
262
|
-
footer? :
|
|
263
|
-
dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
|
|
264
|
-
html?: string
|
|
265
|
-
cls?: string
|
|
266
|
-
}|string
|
|
253
|
+
footer? : object|string
|
|
267
254
|
/**
|
|
268
255
|
* A config [object](https://bryntum.com/products/core/docs/api/Core/widget/Panel#typedef-PanelHeader) for the panel's header or a string in place of a `title`.
|
|
269
|
-
* ...
|
|
270
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-header)
|
|
256
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-header)
|
|
271
257
|
*/
|
|
272
258
|
header? : string|boolean|PanelHeader
|
|
273
259
|
/**
|
|
@@ -282,25 +268,21 @@ export type BryntumChatPanelProps = {
|
|
|
282
268
|
hidden? : boolean
|
|
283
269
|
/**
|
|
284
270
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
285
|
-
* ...
|
|
286
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-hideAnimation)
|
|
271
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-hideAnimation)
|
|
287
272
|
*/
|
|
288
273
|
hideAnimation? : boolean|object
|
|
289
274
|
/**
|
|
290
275
|
* Specify `true` to make this container hide when it has no visible children (Either empty
|
|
291
276
|
* or all children hidden).
|
|
292
|
-
* ...
|
|
293
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-hideWhenEmpty)
|
|
277
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-hideWhenEmpty)
|
|
294
278
|
*/
|
|
295
279
|
hideWhenEmpty? : boolean
|
|
296
280
|
/**
|
|
297
281
|
* The HTML to display initially or a function returning the markup (called at widget construction time).
|
|
298
|
-
* ...
|
|
299
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-html)
|
|
282
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-html)
|
|
300
283
|
* @param {Core.widget.Widget} widget The calling Widget
|
|
301
|
-
* @returns {string}
|
|
302
284
|
*/
|
|
303
|
-
html? : string|((widget: Widget) =>
|
|
285
|
+
html? : string|((widget: Widget) => void)|DomConfig|DomConfig[]|VueConfig|ReactJSX
|
|
304
286
|
/**
|
|
305
287
|
* The CSS class(es) to add when HTML content is being applied to this widget.
|
|
306
288
|
*/
|
|
@@ -316,16 +298,14 @@ export type BryntumChatPanelProps = {
|
|
|
316
298
|
id? : string
|
|
317
299
|
/**
|
|
318
300
|
* Determines if the widgets read-only state should be controlled by its parent.
|
|
319
|
-
* ...
|
|
320
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-ignoreParentReadOnly)
|
|
301
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-ignoreParentReadOnly)
|
|
321
302
|
*/
|
|
322
303
|
ignoreParentReadOnly? : boolean
|
|
323
304
|
/**
|
|
324
305
|
* Convenience setting to align input fields of child widgets. By default, the Field input element is
|
|
325
306
|
* placed immediately following the `label`. If you prefer to have all input fields aligned to the
|
|
326
307
|
* right, set this config to `'end'`.
|
|
327
|
-
* ...
|
|
328
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-inputFieldAlign)
|
|
308
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-inputFieldAlign)
|
|
329
309
|
*/
|
|
330
310
|
inputFieldAlign? : 'start'|'end'
|
|
331
311
|
/**
|
|
@@ -347,55 +327,52 @@ export type BryntumChatPanelProps = {
|
|
|
347
327
|
/**
|
|
348
328
|
* An object containing typed child widget config objects or Widgets. May also be specified
|
|
349
329
|
* as an array.
|
|
350
|
-
* ...
|
|
351
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-items)
|
|
330
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-items)
|
|
352
331
|
*/
|
|
353
332
|
items? : Record<string, CoreContainerItemConfig|MenuItemEntry>|(CoreContainerItemConfig|MenuItemEntry|Widget)[]
|
|
354
333
|
/**
|
|
355
334
|
* An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
|
|
356
335
|
* and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
|
|
357
336
|
* are the name of the instance method to call when the keystroke is received.
|
|
358
|
-
* ...
|
|
359
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-keyMap)
|
|
337
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-keyMap)
|
|
360
338
|
*/
|
|
361
339
|
keyMap? : Record<string, KeyMapConfig>
|
|
362
340
|
/**
|
|
363
341
|
* Convenience setting to use same label placement on all child widgets.
|
|
364
|
-
* ...
|
|
365
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-labelPosition)
|
|
342
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-labelPosition)
|
|
366
343
|
*/
|
|
367
344
|
labelPosition? : 'before'|'above'|'align-before'|'auto'|null
|
|
345
|
+
/**
|
|
346
|
+
* Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
|
|
347
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-labelWidth)
|
|
348
|
+
*/
|
|
349
|
+
labelWidth? : number|null
|
|
368
350
|
/**
|
|
369
351
|
* The short name of a helper class which manages rendering and styling of child items.
|
|
370
|
-
* ...
|
|
371
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-layout)
|
|
352
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-layout)
|
|
372
353
|
*/
|
|
373
354
|
layout? : string|CoreContainerLayoutConfig
|
|
374
355
|
/**
|
|
375
356
|
* The CSS style properties to apply to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
|
|
376
|
-
* ...
|
|
377
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-layoutStyle)
|
|
357
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-layoutStyle)
|
|
378
358
|
*/
|
|
379
359
|
layoutStyle? : object
|
|
380
360
|
/**
|
|
381
361
|
* An array of [child item](https://bryntum.com/products/core/docs/api/Core/widget/Container#config-items) *config objects* which is to be converted into
|
|
382
362
|
* instances only when this Container is rendered, rather than eagerly at construct time.
|
|
383
|
-
* ...
|
|
384
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-lazyItems)
|
|
363
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-lazyItems)
|
|
385
364
|
*/
|
|
386
365
|
lazyItems? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|Widget[]
|
|
387
366
|
/**
|
|
388
367
|
* The listener set for this object.
|
|
389
|
-
* ...
|
|
390
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-listeners)
|
|
368
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-listeners)
|
|
391
369
|
*/
|
|
392
370
|
listeners? : ChatPanelListeners
|
|
393
371
|
/**
|
|
394
372
|
* A class translations of which are used for translating this entity.
|
|
395
373
|
* This is often used when translations of an item are defined on its container class.
|
|
396
374
|
* For example:
|
|
397
|
-
* ...
|
|
398
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-localeClass)
|
|
375
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-localeClass)
|
|
399
376
|
*/
|
|
400
377
|
localeClass? : typeof Base
|
|
401
378
|
/**
|
|
@@ -407,8 +384,7 @@ export type BryntumChatPanelProps = {
|
|
|
407
384
|
* In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
|
|
408
385
|
* you could use 'localeKey' meta configuration.
|
|
409
386
|
* Example:
|
|
410
|
-
* ...
|
|
411
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-localizableProperties)
|
|
387
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-localizableProperties)
|
|
412
388
|
*/
|
|
413
389
|
localizableProperties? : string[]
|
|
414
390
|
/**
|
|
@@ -434,8 +410,7 @@ export type BryntumChatPanelProps = {
|
|
|
434
410
|
maxHeight? : string|number
|
|
435
411
|
/**
|
|
436
412
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
437
|
-
* ...
|
|
438
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-maximizeOnMobile)
|
|
413
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-maximizeOnMobile)
|
|
439
414
|
*/
|
|
440
415
|
maximizeOnMobile? : number|string
|
|
441
416
|
/**
|
|
@@ -448,6 +423,13 @@ export type BryntumChatPanelProps = {
|
|
|
448
423
|
* you?"
|
|
449
424
|
*/
|
|
450
425
|
messages? : ChatMessageModelConfig
|
|
426
|
+
/**
|
|
427
|
+
* Controls where the message field trigger buttons (send, mic, etc.) are placed relative to the text area.
|
|
428
|
+
* Use `'side'` to place them next to the text area (in the same row), or `'below'` to place them
|
|
429
|
+
* underneath it. When placed on the side, use each trigger's `align` config (`'start'`/`'end'`) to
|
|
430
|
+
* control which side they appear on.
|
|
431
|
+
*/
|
|
432
|
+
messageTriggersPlacement? : 'side'|'below'
|
|
451
433
|
/**
|
|
452
434
|
* The element's minHeight. Can be either a String or a Number (which will have 'px' appended). Note that
|
|
453
435
|
* like [height](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
|
|
@@ -462,26 +444,22 @@ export type BryntumChatPanelProps = {
|
|
|
462
444
|
* When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
|
|
463
445
|
* is used to monitor this element for size changes caused by either style manipulation, or by CSS
|
|
464
446
|
* layout.
|
|
465
|
-
* ...
|
|
466
|
-
*
|
|
447
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-monitorResize)
|
|
448
|
+
* @property {boolean} immediate Set to `true` to receive resize notifications immediately.
|
|
467
449
|
*/
|
|
468
|
-
monitorResize? : boolean|
|
|
469
|
-
immediate?: boolean
|
|
470
|
-
}
|
|
450
|
+
monitorResize? : boolean|object
|
|
471
451
|
/**
|
|
472
452
|
* An object containing default config objects which may be referenced by name in the [items](https://bryntum.com/products/core/docs/api/Core/widget/Container#config-items)
|
|
473
453
|
* config. For example, a specialized [Menu](https://bryntum.com/products/core/docs/api/Core/widget/Menu) subclass may have a `namedItems` default
|
|
474
454
|
* value defined like this:
|
|
475
|
-
* ...
|
|
476
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-namedItems)
|
|
455
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-namedItems)
|
|
477
456
|
*/
|
|
478
457
|
namedItems? : Record<string, CoreContainerItemConfig>
|
|
479
458
|
/**
|
|
480
459
|
* Set to `true` when a widget is rendered into another widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement), but must
|
|
481
460
|
* not participate in the standard layout of that widget, and must be positioned relatively to that
|
|
482
461
|
* widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
|
|
483
|
-
* ...
|
|
484
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-positioned)
|
|
462
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-positioned)
|
|
485
463
|
*/
|
|
486
464
|
positioned? : boolean
|
|
487
465
|
/**
|
|
@@ -492,45 +470,45 @@ export type BryntumChatPanelProps = {
|
|
|
492
470
|
/**
|
|
493
471
|
* Whether this widget is read-only. This is only valid if the widget is an input
|
|
494
472
|
* field, <strong>or contains input fields at any depth</strong>.
|
|
495
|
-
* ...
|
|
496
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-readOnly)
|
|
473
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-readOnly)
|
|
497
474
|
*/
|
|
498
475
|
readOnly? : boolean
|
|
499
476
|
/**
|
|
500
477
|
* [Record](https://bryntum.com/products/core/docs/api/Core/data/Model) whose values will be used to populate fields in the container.
|
|
501
|
-
* ...
|
|
502
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-record)
|
|
478
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-record)
|
|
503
479
|
*/
|
|
504
480
|
record? : Model
|
|
505
481
|
relayStoreEvents? : boolean
|
|
506
482
|
/**
|
|
507
483
|
* Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
|
|
508
484
|
* `type`.
|
|
509
|
-
* ...
|
|
510
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-rendition)
|
|
485
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-rendition)
|
|
511
486
|
*/
|
|
512
487
|
rendition? : string|Record<string, string>|null
|
|
513
488
|
/**
|
|
514
489
|
* Configure as `true` to have the component display a translucent ripple when its
|
|
515
490
|
* [focusElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-focusElement), or [element](#Core/widget/Widget#property-element) is tapped <em>if the
|
|
516
491
|
* current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
|
|
517
|
-
* ...
|
|
518
|
-
* [
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
492
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-ripple)
|
|
493
|
+
* @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
|
|
494
|
+
* @property {string} [color] A CSS color name or specification.
|
|
495
|
+
* @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
|
|
496
|
+
* @property {string} [clip] A string which describes how to clip the ripple if it is not to be clipped to the default element. Either the property of the widget to use as the clipping element, or a selector to allow clipping to the closest matching ancestor to the target element.
|
|
497
|
+
*/
|
|
498
|
+
ripple? : boolean|object
|
|
499
|
+
/**
|
|
500
|
+
* The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
|
|
501
|
+
* accidentally applying a role which may interfere with screen readers.
|
|
502
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-role)
|
|
503
|
+
*/
|
|
504
|
+
role? : string
|
|
526
505
|
/**
|
|
527
506
|
* If you are rendering this widget to a shadow root inside a web component, set this config to the shadowRoot. If not inside a web component, set it to `document.body`
|
|
528
507
|
*/
|
|
529
508
|
rootElement? : ShadowRoot|HTMLElement
|
|
530
509
|
/**
|
|
531
510
|
* This may be configured as `true` to make the widget's element use the `direction:rtl` style.
|
|
532
|
-
* ...
|
|
533
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-rtl)
|
|
511
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-rtl)
|
|
534
512
|
*/
|
|
535
513
|
rtl? : boolean
|
|
536
514
|
/**
|
|
@@ -538,8 +516,7 @@ export type BryntumChatPanelProps = {
|
|
|
538
516
|
* in both axes. May be an object containing boolean `overflowX` and `overflowY` properties which are
|
|
539
517
|
* applied to CSS style properties `overflowX` and `overflowY`. If they are boolean, they are translated to
|
|
540
518
|
* CSS overflow properties thus:
|
|
541
|
-
* ...
|
|
542
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-scrollable)
|
|
519
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-scrollable)
|
|
543
520
|
*/
|
|
544
521
|
scrollable? : boolean|ScrollerConfig|Scroller
|
|
545
522
|
/**
|
|
@@ -549,8 +526,7 @@ export type BryntumChatPanelProps = {
|
|
|
549
526
|
scrollAction? : 'hide'|'realign'|null
|
|
550
527
|
/**
|
|
551
528
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
552
|
-
* ...
|
|
553
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-showAnimation)
|
|
529
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-showAnimation)
|
|
554
530
|
*/
|
|
555
531
|
showAnimation? : boolean|object
|
|
556
532
|
/**
|
|
@@ -567,30 +543,26 @@ export type BryntumChatPanelProps = {
|
|
|
567
543
|
span? : number
|
|
568
544
|
/**
|
|
569
545
|
* This value can be one of the following:
|
|
570
|
-
* ...
|
|
571
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-stateful)
|
|
546
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-stateful)
|
|
572
547
|
*/
|
|
573
548
|
stateful? : boolean|object|string[]
|
|
574
549
|
/**
|
|
575
550
|
* The events that, when fired by this component, should trigger it to save its state by calling
|
|
576
551
|
* [saveState](https://bryntum.com/products/core/docs/api/Core/mixin/State#function-saveState).
|
|
577
|
-
* ...
|
|
578
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-statefulEvents)
|
|
552
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-statefulEvents)
|
|
579
553
|
*/
|
|
580
554
|
statefulEvents? : object|string[]
|
|
581
555
|
/**
|
|
582
556
|
* The key to use when saving this object's state in the [stateProvider](https://bryntum.com/products/core/docs/api/Core/mixin/State#config-stateProvider). If this config is
|
|
583
557
|
* not assigned, and [stateful](https://bryntum.com/products/core/docs/api/Core/mixin/State#config-stateful) is not set to `false`, the [id](#Core/widget/Widget#config-id)
|
|
584
558
|
* (if explicitly specified) will be used as the `stateId`.
|
|
585
|
-
* ...
|
|
586
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-stateId)
|
|
559
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-stateId)
|
|
587
560
|
*/
|
|
588
561
|
stateId? : string
|
|
589
562
|
/**
|
|
590
563
|
* The `StateProvider` to use to save and restore this object's [state](https://bryntum.com/products/core/docs/api/Core/mixin/State#property-state). By default, `state`
|
|
591
564
|
* will be saved using the [default state provider](https://bryntum.com/products/core/docs/api/Core/state/StateProvider#property-instance-static).
|
|
592
|
-
* ...
|
|
593
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-stateProvider)
|
|
565
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-stateProvider)
|
|
594
566
|
*/
|
|
595
567
|
stateProvider? : StateProvider
|
|
596
568
|
/**
|
|
@@ -602,23 +574,20 @@ export type BryntumChatPanelProps = {
|
|
|
602
574
|
* An object containing widgets keyed by name. By default (when no `type` is given), strips are
|
|
603
575
|
* [toolbars](https://bryntum.com/products/core/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
|
|
604
576
|
* the toolbar's [items](https://bryntum.com/products/core/docs/api/Core/widget/Container#config-items).
|
|
605
|
-
* ...
|
|
606
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-strips)
|
|
577
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-strips)
|
|
607
578
|
*/
|
|
608
579
|
strips? : Record<string, CoreContainerItemConfig>
|
|
609
580
|
/**
|
|
610
581
|
* A configuration for the [tab](https://bryntum.com/products/core/docs/api/Core/widget/Tab) created for this widget when it is placed in a
|
|
611
582
|
* [TabPanel](https://bryntum.com/products/core/docs/api/Core/widget/TabPanel). For example, this config can be used to control the icon of the `tab` for
|
|
612
583
|
* this widget:
|
|
613
|
-
* ...
|
|
614
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-tab)
|
|
584
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-tab)
|
|
615
585
|
*/
|
|
616
586
|
tab? : boolean|TabConfig
|
|
617
587
|
/**
|
|
618
588
|
* When this container is used as a tab in a TabPanel, these items are added to the
|
|
619
589
|
* [TabBar](https://bryntum.com/products/core/docs/api/Core/widget/TabBar) when this container is the active tab.
|
|
620
|
-
* ...
|
|
621
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-tabBarItems)
|
|
590
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-tabBarItems)
|
|
622
591
|
*/
|
|
623
592
|
tabBarItems? : ToolbarItems[]|Widget[]
|
|
624
593
|
/**
|
|
@@ -629,42 +598,36 @@ export type BryntumChatPanelProps = {
|
|
|
629
598
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/core/docs/api/Core/widget/Toolbar),
|
|
630
599
|
* or array of config objects representing the child items of a Toolbar.
|
|
631
600
|
* This creates a toolbar docked to the top of the panel immediately below the header.
|
|
632
|
-
* ...
|
|
633
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-tbar)
|
|
601
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-tbar)
|
|
634
602
|
*/
|
|
635
603
|
tbar? : (CoreContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
636
604
|
/**
|
|
637
605
|
* Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
|
|
638
|
-
* ...
|
|
639
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-textAlign)
|
|
606
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-textAlign)
|
|
640
607
|
*/
|
|
641
608
|
textAlign? : 'left'|'center'|'right'|'start'|'end'
|
|
642
609
|
/**
|
|
643
610
|
* Specify `true` for a container used to show text markup. It will apply the CSS class `b-text-content`
|
|
644
611
|
* which specifies a default max-width that makes long text more readable.
|
|
645
|
-
* ...
|
|
646
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-textContent)
|
|
612
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-textContent)
|
|
647
613
|
*/
|
|
648
614
|
textContent? : boolean
|
|
649
615
|
/**
|
|
650
616
|
* A title to display in the header or owning TabPanel. Causes creation and docking of a header
|
|
651
617
|
* to the top if no header is configured.
|
|
652
|
-
* ...
|
|
653
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-title)
|
|
618
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-title)
|
|
654
619
|
*/
|
|
655
620
|
title? : string
|
|
656
621
|
/**
|
|
657
622
|
* The [tools](https://bryntum.com/products/core/docs/api/Core/widget/Tool) to add either before or after the `title` in the Panel header. Each
|
|
658
623
|
* property name is the reference by which an instantiated tool may be retrieved from the live
|
|
659
624
|
* `[tools](https://bryntum.com/products/core/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
|
|
660
|
-
* ...
|
|
661
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-tools)
|
|
625
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-tools)
|
|
662
626
|
*/
|
|
663
627
|
tools? : Record<string, ToolConfig>|null
|
|
664
628
|
/**
|
|
665
629
|
* Tooltip for the widget, either as a string or as a Tooltip config object.
|
|
666
|
-
* ...
|
|
667
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-tooltip)
|
|
630
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-tooltip)
|
|
668
631
|
*/
|
|
669
632
|
tooltip? : string|TooltipConfig|null
|
|
670
633
|
/**
|
|
@@ -674,12 +637,15 @@ export type BryntumChatPanelProps = {
|
|
|
674
637
|
*/
|
|
675
638
|
trapFocus? : boolean
|
|
676
639
|
type? : 'chatpanel'
|
|
640
|
+
/**
|
|
641
|
+
* The delay in milliseconds between each simulated keystroke when typing out a response.
|
|
642
|
+
*/
|
|
643
|
+
typeInterval? : number
|
|
677
644
|
/**
|
|
678
645
|
* Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
|
|
679
646
|
* as a space separated string, an array of strings, or as an object in which property names with truthy
|
|
680
647
|
* values are used as the class names.
|
|
681
|
-
* ...
|
|
682
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-ui)
|
|
648
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-ui)
|
|
683
649
|
*/
|
|
684
650
|
ui? : 'plain'|'toolbar'|string|object
|
|
685
651
|
/**
|
|
@@ -695,14 +661,12 @@ export type BryntumChatPanelProps = {
|
|
|
695
661
|
width? : string|number
|
|
696
662
|
/**
|
|
697
663
|
* The x position for the widget.
|
|
698
|
-
* ...
|
|
699
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-x)
|
|
664
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-x)
|
|
700
665
|
*/
|
|
701
666
|
x? : number
|
|
702
667
|
/**
|
|
703
668
|
* The y position for the widget.
|
|
704
|
-
* ...
|
|
705
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-y)
|
|
669
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-y)
|
|
706
670
|
*/
|
|
707
671
|
y? : number
|
|
708
672
|
|
|
@@ -746,7 +710,7 @@ export type BryntumChatPanelProps = {
|
|
|
746
710
|
*/
|
|
747
711
|
onBeforeStateSave? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
|
|
748
712
|
/**
|
|
749
|
-
* Fired when chat bubble tool icon is clicked.
|
|
713
|
+
* Fired when the chat bubble tool icon is clicked.
|
|
750
714
|
* @param {object} event Event object
|
|
751
715
|
* @param {Core.widget.chat.ChatPanel} event.source This panel
|
|
752
716
|
* @param {string} event.tool The tool identifier
|
|
@@ -755,8 +719,7 @@ export type BryntumChatPanelProps = {
|
|
|
755
719
|
onBubbleToolClick? : ((event: { source: ChatPanel, tool: string, message: ChatMessageModelConfig }) => void)|string
|
|
756
720
|
/**
|
|
757
721
|
* Fires when any other event is fired from the object.
|
|
758
|
-
* ...
|
|
759
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#event-catchAll)
|
|
722
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#event-catchAll)
|
|
760
723
|
* @param {object} event Event object
|
|
761
724
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
762
725
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -834,13 +797,19 @@ export type BryntumChatPanelProps = {
|
|
|
834
797
|
/**
|
|
835
798
|
* Triggered when a widget which had been in a non-visible state for any reason
|
|
836
799
|
* achieves visibility.
|
|
837
|
-
* ...
|
|
838
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#event-paint)
|
|
800
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#event-paint)
|
|
839
801
|
* @param {object} event Event object
|
|
840
802
|
* @param {Core.widget.Widget} event.source The widget being painted.
|
|
841
803
|
* @param {boolean} event.firstPaint `true` if this is the first paint.
|
|
842
804
|
*/
|
|
843
805
|
onPaint? : ((event: { source: Widget, firstPaint: boolean }) => void)|string
|
|
806
|
+
/**
|
|
807
|
+
* Fired when the prompt history changes. Listen to this event to persist the
|
|
808
|
+
* history (e.g. to localStorage).
|
|
809
|
+
* @param {object} event Event object
|
|
810
|
+
* @param {string[]} event.promptHistory The updated prompt history array
|
|
811
|
+
*/
|
|
812
|
+
onPromptHistoryChange? : ((event: { promptHistory: string[] }) => void)|string
|
|
844
813
|
/**
|
|
845
814
|
* Fired when a Widget's read only state is toggled
|
|
846
815
|
* @param {object} event Event object
|
|
@@ -928,12 +897,14 @@ export class BryntumChatPanel extends React.Component<BryntumChatPanelProps> {
|
|
|
928
897
|
'localizableProperties',
|
|
929
898
|
'maskDefaults',
|
|
930
899
|
'masked',
|
|
900
|
+
'messageTriggersPlacement',
|
|
931
901
|
'monitorResize',
|
|
932
902
|
'namedItems',
|
|
933
903
|
'positioned',
|
|
934
904
|
'preventTooltipOnTouch',
|
|
935
905
|
'relayStoreEvents',
|
|
936
906
|
'ripple',
|
|
907
|
+
'role',
|
|
937
908
|
'rootElement',
|
|
938
909
|
'scrollAction',
|
|
939
910
|
'showAnimation',
|
|
@@ -957,6 +928,7 @@ export class BryntumChatPanel extends React.Component<BryntumChatPanelProps> {
|
|
|
957
928
|
|
|
958
929
|
static propertyConfigNames = [
|
|
959
930
|
'alignSelf',
|
|
931
|
+
'animateTyping',
|
|
960
932
|
'appendTo',
|
|
961
933
|
'avatar',
|
|
962
934
|
'bubbleTools',
|
|
@@ -968,6 +940,7 @@ export class BryntumChatPanel extends React.Component<BryntumChatPanelProps> {
|
|
|
968
940
|
'content',
|
|
969
941
|
'dataset',
|
|
970
942
|
'disabled',
|
|
943
|
+
'examplePrompts',
|
|
971
944
|
'extraData',
|
|
972
945
|
'flex',
|
|
973
946
|
'height',
|
|
@@ -981,6 +954,7 @@ export class BryntumChatPanel extends React.Component<BryntumChatPanelProps> {
|
|
|
981
954
|
'items',
|
|
982
955
|
'keyMap',
|
|
983
956
|
'labelPosition',
|
|
957
|
+
'labelWidth',
|
|
984
958
|
'layout',
|
|
985
959
|
'layoutStyle',
|
|
986
960
|
'margin',
|
|
@@ -1008,6 +982,7 @@ export class BryntumChatPanel extends React.Component<BryntumChatPanelProps> {
|
|
|
1008
982
|
'onHide',
|
|
1009
983
|
'onLocalMessage',
|
|
1010
984
|
'onPaint',
|
|
985
|
+
'onPromptHistoryChange',
|
|
1011
986
|
'onReadOnly',
|
|
1012
987
|
'onRecompose',
|
|
1013
988
|
'onResize',
|
|
@@ -1024,20 +999,15 @@ export class BryntumChatPanel extends React.Component<BryntumChatPanelProps> {
|
|
|
1024
999
|
'title',
|
|
1025
1000
|
'tools',
|
|
1026
1001
|
'tooltip',
|
|
1002
|
+
'typeInterval',
|
|
1027
1003
|
'width',
|
|
1028
1004
|
'x',
|
|
1029
1005
|
'y'
|
|
1030
1006
|
];
|
|
1031
1007
|
|
|
1032
1008
|
static propertyNames = [
|
|
1033
|
-
'anchorSize',
|
|
1034
|
-
'focusVisible',
|
|
1035
|
-
'hasChanges',
|
|
1036
|
-
'isSettingValues',
|
|
1037
|
-
'isValid',
|
|
1038
1009
|
'parent',
|
|
1039
1010
|
'state',
|
|
1040
|
-
'store',
|
|
1041
1011
|
'values'
|
|
1042
1012
|
];
|
|
1043
1013
|
|