@bryntum/core-react-thin 7.2.4 → 7.3.1
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 +262 -0
- package/lib/BryntumBooleanCombo.js +205 -0
- package/lib/BryntumBooleanCombo.js.map +1 -0
- package/lib/BryntumButton.d.ts +9 -17
- package/lib/BryntumButton.js +1 -2
- package/lib/BryntumButton.js.map +1 -1
- package/lib/BryntumButtonGroup.d.ts +9 -16
- package/lib/BryntumButtonGroup.js +2 -5
- package/lib/BryntumButtonGroup.js.map +1 -1
- package/lib/BryntumChatPanel.d.ts +19 -23
- package/lib/BryntumChatPanel.js +7 -6
- package/lib/BryntumChatPanel.js.map +1 -1
- package/lib/BryntumCheckbox.d.ts +10 -17
- package/lib/BryntumCheckbox.js +2 -2
- package/lib/BryntumCheckbox.js.map +1 -1
- package/lib/BryntumCheckboxGroup.d.ts +12 -24
- package/lib/BryntumCheckboxGroup.js +2 -6
- package/lib/BryntumCheckboxGroup.js.map +1 -1
- package/lib/BryntumChipView.d.ts +8 -16
- package/lib/BryntumChipView.js +1 -2
- package/lib/BryntumChipView.js.map +1 -1
- package/lib/BryntumCodeEditor.d.ts +12 -23
- package/lib/BryntumCodeEditor.js +2 -5
- package/lib/BryntumCodeEditor.js.map +1 -1
- package/lib/BryntumColorField.d.ts +9 -16
- package/lib/BryntumColorField.js +2 -2
- package/lib/BryntumColorField.js.map +1 -1
- package/lib/BryntumCombo.d.ts +12 -19
- package/lib/BryntumCombo.js +2 -2
- package/lib/BryntumCombo.js.map +1 -1
- package/lib/BryntumContainer.d.ts +8 -15
- package/lib/BryntumContainer.js +2 -5
- package/lib/BryntumContainer.js.map +1 -1
- package/lib/BryntumDateField.d.ts +9 -16
- package/lib/BryntumDateField.js +2 -2
- package/lib/BryntumDateField.js.map +1 -1
- package/lib/BryntumDatePicker.d.ts +12 -23
- package/lib/BryntumDatePicker.js +2 -5
- package/lib/BryntumDatePicker.js.map +1 -1
- package/lib/BryntumDateRangeField.d.ts +12 -19
- package/lib/BryntumDateRangeField.js +2 -2
- package/lib/BryntumDateRangeField.js.map +1 -1
- package/lib/BryntumDateTimeField.d.ts +9 -16
- package/lib/BryntumDateTimeField.js +2 -2
- package/lib/BryntumDateTimeField.js.map +1 -1
- package/lib/BryntumDemoCodeEditor.d.ts +12 -23
- package/lib/BryntumDemoCodeEditor.js +2 -5
- package/lib/BryntumDemoCodeEditor.js.map +1 -1
- package/lib/BryntumDisplayField.d.ts +9 -16
- package/lib/BryntumDisplayField.js +2 -2
- package/lib/BryntumDisplayField.js.map +1 -1
- package/lib/BryntumDurationField.d.ts +9 -16
- package/lib/BryntumDurationField.js +2 -2
- package/lib/BryntumDurationField.js.map +1 -1
- package/lib/BryntumEditor.d.ts +14 -24
- package/lib/BryntumEditor.js +2 -5
- package/lib/BryntumEditor.js.map +1 -1
- package/lib/BryntumFieldFilterPicker.d.ts +8 -15
- package/lib/BryntumFieldFilterPicker.js +2 -5
- package/lib/BryntumFieldFilterPicker.js.map +1 -1
- package/lib/BryntumFieldFilterPickerGroup.d.ts +9 -16
- package/lib/BryntumFieldFilterPickerGroup.js +2 -5
- package/lib/BryntumFieldFilterPickerGroup.js.map +1 -1
- package/lib/BryntumFieldSet.d.ts +12 -24
- package/lib/BryntumFieldSet.js +2 -6
- package/lib/BryntumFieldSet.js.map +1 -1
- package/lib/BryntumFileField.d.ts +9 -16
- package/lib/BryntumFileField.js +2 -2
- package/lib/BryntumFileField.js.map +1 -1
- package/lib/BryntumFilePicker.d.ts +8 -15
- package/lib/BryntumFilePicker.js +2 -5
- package/lib/BryntumFilePicker.js.map +1 -1
- package/lib/BryntumFilterField.d.ts +9 -16
- package/lib/BryntumFilterField.js +2 -2
- package/lib/BryntumFilterField.js.map +1 -1
- package/lib/BryntumHint.d.ts +24 -33
- package/lib/BryntumHint.js +2 -5
- package/lib/BryntumHint.js.map +1 -1
- package/lib/BryntumLabel.d.ts +7 -15
- package/lib/BryntumLabel.js +1 -2
- package/lib/BryntumLabel.js.map +1 -1
- package/lib/BryntumList.d.ts +8 -16
- package/lib/BryntumList.js +1 -2
- package/lib/BryntumList.js.map +1 -1
- package/lib/BryntumMenu.d.ts +23 -28
- package/lib/BryntumMenu.js +2 -6
- package/lib/BryntumMenu.js.map +1 -1
- package/lib/BryntumMonthPicker.d.ts +12 -23
- package/lib/BryntumMonthPicker.js +2 -5
- package/lib/BryntumMonthPicker.js.map +1 -1
- package/lib/BryntumNumberField.d.ts +9 -16
- package/lib/BryntumNumberField.js +2 -2
- package/lib/BryntumNumberField.js.map +1 -1
- package/lib/BryntumPagingToolbar.d.ts +12 -19
- package/lib/BryntumPagingToolbar.js +2 -5
- package/lib/BryntumPagingToolbar.js.map +1 -1
- package/lib/BryntumPanel.d.ts +12 -23
- package/lib/BryntumPanel.js +2 -5
- package/lib/BryntumPanel.js.map +1 -1
- package/lib/BryntumPasswordField.d.ts +9 -16
- package/lib/BryntumPasswordField.js +2 -2
- package/lib/BryntumPasswordField.js.map +1 -1
- package/lib/BryntumProgressBar.d.ts +7 -15
- package/lib/BryntumProgressBar.js +1 -2
- package/lib/BryntumProgressBar.js.map +1 -1
- package/lib/BryntumRadio.d.ts +10 -17
- package/lib/BryntumRadio.js +2 -2
- package/lib/BryntumRadio.js.map +1 -1
- package/lib/BryntumRadioGroup.d.ts +12 -24
- package/lib/BryntumRadioGroup.js +2 -6
- package/lib/BryntumRadioGroup.js.map +1 -1
- package/lib/BryntumSlideToggle.d.ts +10 -17
- package/lib/BryntumSlideToggle.js +2 -2
- package/lib/BryntumSlideToggle.js.map +1 -1
- package/lib/BryntumSlider.d.ts +8 -15
- package/lib/BryntumSlider.js +2 -2
- package/lib/BryntumSlider.js.map +1 -1
- package/lib/BryntumSplitter.d.ts +7 -15
- package/lib/BryntumSplitter.js +1 -2
- package/lib/BryntumSplitter.js.map +1 -1
- package/lib/BryntumTabPanel.d.ts +13 -24
- package/lib/BryntumTabPanel.js +2 -5
- package/lib/BryntumTabPanel.js.map +1 -1
- package/lib/BryntumTextAreaField.d.ts +10 -16
- package/lib/BryntumTextAreaField.js +3 -2
- package/lib/BryntumTextAreaField.js.map +1 -1
- package/lib/BryntumTextAreaPickerField.d.ts +10 -17
- package/lib/BryntumTextAreaPickerField.js +2 -2
- package/lib/BryntumTextAreaPickerField.js.map +1 -1
- package/lib/BryntumTextField.d.ts +9 -16
- package/lib/BryntumTextField.js +2 -2
- package/lib/BryntumTextField.js.map +1 -1
- package/lib/BryntumTimeField.d.ts +10 -17
- package/lib/BryntumTimeField.js +2 -2
- package/lib/BryntumTimeField.js.map +1 -1
- package/lib/BryntumTimePicker.d.ts +8 -15
- package/lib/BryntumTimePicker.js +2 -5
- package/lib/BryntumTimePicker.js.map +1 -1
- package/lib/BryntumToolbar.d.ts +12 -19
- package/lib/BryntumToolbar.js +2 -5
- package/lib/BryntumToolbar.js.map +1 -1
- package/lib/BryntumWidget.d.ts +7 -15
- package/lib/BryntumWidget.js +1 -2
- package/lib/BryntumWidget.js.map +1 -1
- package/lib/BryntumYearPicker.d.ts +12 -23
- 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 +1190 -0
- package/src/BryntumButton.tsx +72 -118
- package/src/BryntumButtonGroup.tsx +79 -124
- package/src/BryntumChatPanel.tsx +142 -172
- package/src/BryntumCheckbox.tsx +85 -119
- package/src/BryntumCheckboxGroup.tsx +112 -182
- package/src/BryntumChipView.tsx +67 -107
- package/src/BryntumCodeEditor.tsx +109 -170
- package/src/BryntumColorField.tsx +84 -118
- package/src/BryntumCombo.tsx +103 -153
- package/src/BryntumContainer.tsx +79 -125
- package/src/BryntumDateField.tsx +91 -124
- package/src/BryntumDatePicker.tsx +122 -196
- package/src/BryntumDateRangeField.tsx +90 -127
- package/src/BryntumDateTimeField.tsx +84 -118
- package/src/BryntumDemoCodeEditor.tsx +109 -170
- package/src/BryntumDisplayField.tsx +85 -120
- package/src/BryntumDurationField.tsx +91 -126
- package/src/BryntumEditor.tsx +95 -145
- package/src/BryntumFieldFilterPicker.tsx +81 -129
- package/src/BryntumFieldFilterPickerGroup.tsx +84 -134
- package/src/BryntumFieldSet.tsx +108 -175
- package/src/BryntumFileField.tsx +84 -118
- package/src/BryntumFilePicker.tsx +79 -125
- package/src/BryntumFilterField.tsx +87 -124
- package/src/BryntumHint.tsx +136 -193
- package/src/BryntumLabel.tsx +60 -96
- package/src/BryntumList.tsx +64 -103
- package/src/BryntumMenu.tsx +131 -191
- package/src/BryntumMonthPicker.tsx +109 -170
- package/src/BryntumNumberField.tsx +88 -122
- package/src/BryntumPagingToolbar.tsx +84 -131
- package/src/BryntumPanel.tsx +109 -170
- package/src/BryntumPasswordField.tsx +84 -118
- package/src/BryntumProgressBar.tsx +59 -94
- package/src/BryntumRadio.tsx +85 -119
- package/src/BryntumRadioGroup.tsx +112 -181
- package/src/BryntumSlideToggle.tsx +85 -119
- package/src/BryntumSlider.tsx +68 -102
- package/src/BryntumSplitter.tsx +62 -100
- package/src/BryntumTabPanel.tsx +111 -173
- package/src/BryntumTextAreaField.tsx +92 -120
- package/src/BryntumTextAreaPickerField.tsx +86 -121
- package/src/BryntumTextField.tsx +85 -120
- package/src/BryntumTimeField.tsx +90 -121
- package/src/BryntumTimePicker.tsx +79 -125
- package/src/BryntumToolbar.tsx +84 -131
- package/src/BryntumWidget.tsx +60 -96
- package/src/BryntumYearPicker.tsx +110 -172
- package/src/WrapperHelper.tsx +2 -2
- package/src/index.ts +1 -0
package/src/BryntumEditor.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, Color, Container, CoreContainerItemConfig, CoreContainerLayoutConfig, DomConfig, Editor, EditorListeners, CoreInputFieldConfig, KeyMapConfig, Layout, MaskConfig, MenuItemConfig, MenuItemEntry, Model, Rectangle, Scroller, ScrollerConfig, TabConfig, ToolbarItems, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
|
|
6
|
+
import { AlignSpec, Base, Color, Container, CoreContainerItemConfig, CoreContainerLayoutConfig, DomConfig, Editor, EditorListeners, CoreInputFieldConfig, KeyMapConfig, Layout, MaskConfig, MenuItemConfig, MenuItemEntry, Model, ReactJSX, Rectangle, Scroller, ScrollerConfig, TabConfig, ToolbarItems, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
|
|
7
7
|
|
|
8
8
|
import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
|
|
9
9
|
|
|
@@ -12,8 +12,7 @@ export type BryntumEditorProps = {
|
|
|
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/Editor#config-adopt)
|
|
15
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-adopt)
|
|
17
16
|
*/
|
|
18
17
|
adopt? : HTMLElement|string
|
|
19
18
|
/**
|
|
@@ -43,15 +42,13 @@ export type BryntumEditorProps = {
|
|
|
43
42
|
/**
|
|
44
43
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
|
|
45
44
|
* into an element which will be linked using the `aria-describedby` attribute.
|
|
46
|
-
* ...
|
|
47
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-ariaDescription)
|
|
45
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-ariaDescription)
|
|
48
46
|
*/
|
|
49
47
|
ariaDescription? : string
|
|
50
48
|
/**
|
|
51
49
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
|
|
52
50
|
* the `aria-label` attribute.
|
|
53
|
-
* ...
|
|
54
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-ariaLabel)
|
|
51
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-ariaLabel)
|
|
55
52
|
*/
|
|
56
53
|
ariaLabel? : string
|
|
57
54
|
/**
|
|
@@ -71,27 +68,23 @@ export type BryntumEditorProps = {
|
|
|
71
68
|
/**
|
|
72
69
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
73
70
|
* hierarchy when triggered.
|
|
74
|
-
* ...
|
|
75
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-bubbleEvents)
|
|
71
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-bubbleEvents)
|
|
76
72
|
*/
|
|
77
73
|
bubbleEvents? : object
|
|
78
74
|
/**
|
|
79
75
|
* Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
80
|
-
* ...
|
|
81
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-callOnFunctions)
|
|
76
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-callOnFunctions)
|
|
82
77
|
*/
|
|
83
78
|
callOnFunctions? : boolean
|
|
84
79
|
/**
|
|
85
80
|
* The name of the `key` which cancels the edit.
|
|
86
|
-
* ...
|
|
87
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-cancelKey)
|
|
81
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-cancelKey)
|
|
88
82
|
*/
|
|
89
83
|
cancelKey? : string
|
|
90
84
|
/**
|
|
91
85
|
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
92
86
|
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
93
|
-
* ...
|
|
94
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-catchEventHandlerExceptions)
|
|
87
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-catchEventHandlerExceptions)
|
|
95
88
|
*/
|
|
96
89
|
catchEventHandlerExceptions? : boolean
|
|
97
90
|
/**
|
|
@@ -103,15 +96,13 @@ export type BryntumEditorProps = {
|
|
|
103
96
|
* Custom CSS classes to add to element.
|
|
104
97
|
* May be specified as a space separated string, or as an object in which property names
|
|
105
98
|
* with truthy values are used as the class names:
|
|
106
|
-
* ...
|
|
107
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-cls)
|
|
99
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-cls)
|
|
108
100
|
*/
|
|
109
101
|
cls? : string|object
|
|
110
102
|
/**
|
|
111
103
|
* Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
|
|
112
104
|
* `style` block.
|
|
113
|
-
* ...
|
|
114
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-color)
|
|
105
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-color)
|
|
115
106
|
*/
|
|
116
107
|
color? : Color
|
|
117
108
|
/**
|
|
@@ -120,8 +111,7 @@ export type BryntumEditorProps = {
|
|
|
120
111
|
column? : number
|
|
121
112
|
/**
|
|
122
113
|
* The name of the `key` which completes the edit.
|
|
123
|
-
* ...
|
|
124
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-completeKey)
|
|
114
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-completeKey)
|
|
125
115
|
*/
|
|
126
116
|
completeKey? : string
|
|
127
117
|
/**
|
|
@@ -145,8 +135,7 @@ export type BryntumEditorProps = {
|
|
|
145
135
|
* Custom CSS classes to add to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
|
|
146
136
|
* May be specified as a space separated string, or as an object in which property names
|
|
147
137
|
* with truthy values are used as the class names:
|
|
148
|
-
* ...
|
|
149
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-contentElementCls)
|
|
138
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-contentElementCls)
|
|
150
139
|
*/
|
|
151
140
|
contentElementCls? : string|object
|
|
152
141
|
/**
|
|
@@ -166,8 +155,7 @@ export type BryntumEditorProps = {
|
|
|
166
155
|
/**
|
|
167
156
|
* A [query](https://bryntum.com/products/core/docs/api/Core/widget/Container#function-query) selector function which can identify the descendant widget to which
|
|
168
157
|
* focus should be directed by default.
|
|
169
|
-
* ...
|
|
170
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-defaultFocus)
|
|
158
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-defaultFocus)
|
|
171
159
|
* @param {Core.widget.Widget} widget Widget passed to method
|
|
172
160
|
* @returns {boolean} truthy value if widget is the default one
|
|
173
161
|
*/
|
|
@@ -177,16 +165,15 @@ export type BryntumEditorProps = {
|
|
|
177
165
|
*/
|
|
178
166
|
defaults? : CoreContainerItemConfig
|
|
179
167
|
/**
|
|
180
|
-
* Check for CSS compatibility issues
|
|
181
|
-
*
|
|
182
|
-
* [
|
|
168
|
+
* Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
|
|
169
|
+
* checks:
|
|
170
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-detectCSSCompatibilityIssues)
|
|
183
171
|
*/
|
|
184
172
|
detectCSSCompatibilityIssues? : boolean
|
|
185
173
|
/**
|
|
186
174
|
* 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
|
|
187
175
|
* cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
|
|
188
|
-
* ...
|
|
189
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-disabled)
|
|
176
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-disabled)
|
|
190
177
|
*/
|
|
191
178
|
disabled? : boolean|'inert'
|
|
192
179
|
/**
|
|
@@ -194,25 +181,21 @@ export type BryntumEditorProps = {
|
|
|
194
181
|
* [strips collection](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
|
|
195
182
|
* `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
|
|
196
183
|
* body. Such widgets are called "edge strips".
|
|
197
|
-
* ...
|
|
198
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-dock)
|
|
184
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-dock)
|
|
199
185
|
*/
|
|
200
186
|
dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
201
187
|
/**
|
|
202
188
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
203
189
|
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
|
|
204
190
|
* property which controls when a drag should start.
|
|
205
|
-
* ...
|
|
206
|
-
*
|
|
191
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-draggable)
|
|
192
|
+
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
207
193
|
*/
|
|
208
|
-
draggable? : boolean|
|
|
209
|
-
handleSelector?: string
|
|
210
|
-
}
|
|
194
|
+
draggable? : boolean|object
|
|
211
195
|
/**
|
|
212
196
|
* An object specifying attributes to assign to the root element of this widget.
|
|
213
197
|
* Set `null` value to attribute to remove it.
|
|
214
|
-
* ...
|
|
215
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-elementAttributes)
|
|
198
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-elementAttributes)
|
|
216
199
|
*/
|
|
217
200
|
elementAttributes? : Record<string, string|null>
|
|
218
201
|
extraData? : any
|
|
@@ -247,8 +230,7 @@ export type BryntumEditorProps = {
|
|
|
247
230
|
hidden? : boolean
|
|
248
231
|
/**
|
|
249
232
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
250
|
-
* ...
|
|
251
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-hideAnimation)
|
|
233
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-hideAnimation)
|
|
252
234
|
*/
|
|
253
235
|
hideAnimation? : boolean|object
|
|
254
236
|
/**
|
|
@@ -258,18 +240,15 @@ export type BryntumEditorProps = {
|
|
|
258
240
|
/**
|
|
259
241
|
* Specify `true` to make this container hide when it has no visible children (Either empty
|
|
260
242
|
* or all children hidden).
|
|
261
|
-
* ...
|
|
262
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-hideWhenEmpty)
|
|
243
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-hideWhenEmpty)
|
|
263
244
|
*/
|
|
264
245
|
hideWhenEmpty? : boolean
|
|
265
246
|
/**
|
|
266
247
|
* The HTML to display initially or a function returning the markup (called at widget construction time).
|
|
267
|
-
* ...
|
|
268
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-html)
|
|
248
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-html)
|
|
269
249
|
* @param {Core.widget.Widget} widget The calling Widget
|
|
270
|
-
* @returns {string}
|
|
271
250
|
*/
|
|
272
|
-
html? : string|((widget: Widget) =>
|
|
251
|
+
html? : string|((widget: Widget) => void)|DomConfig|DomConfig[]|VueConfig|ReactJSX
|
|
273
252
|
/**
|
|
274
253
|
* The CSS class(es) to add when HTML content is being applied to this widget.
|
|
275
254
|
*/
|
|
@@ -280,21 +259,19 @@ export type BryntumEditorProps = {
|
|
|
280
259
|
id? : string
|
|
281
260
|
/**
|
|
282
261
|
* Determines if the widgets read-only state should be controlled by its parent.
|
|
283
|
-
* ...
|
|
284
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-ignoreParentReadOnly)
|
|
262
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-ignoreParentReadOnly)
|
|
285
263
|
*/
|
|
286
264
|
ignoreParentReadOnly? : boolean
|
|
287
265
|
/**
|
|
288
266
|
* A config object, or the `type` string of the widget (usually a [Field](https://bryntum.com/products/core/docs/api/Core/widget/Field) subclass,
|
|
289
267
|
* i.e. [TextField](https://bryntum.com/products/core/docs/api/Core/widget/TextField)) which this editor will encapsulate.
|
|
290
268
|
*/
|
|
291
|
-
inputField? : CoreInputFieldConfig|string
|
|
269
|
+
inputField? : CoreInputFieldConfig|string
|
|
292
270
|
/**
|
|
293
271
|
* Convenience setting to align input fields of child widgets. By default, the Field input element is
|
|
294
272
|
* placed immediately following the `label`. If you prefer to have all input fields aligned to the
|
|
295
273
|
* right, set this config to `'end'`.
|
|
296
|
-
* ...
|
|
297
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-inputFieldAlign)
|
|
274
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-inputFieldAlign)
|
|
298
275
|
*/
|
|
299
276
|
inputFieldAlign? : 'start'|'end'
|
|
300
277
|
/**
|
|
@@ -307,8 +284,7 @@ export type BryntumEditorProps = {
|
|
|
307
284
|
insertFirst? : HTMLElement|string
|
|
308
285
|
/**
|
|
309
286
|
* How to handle a request to complete the edit if the field is invalid. There are three choices:
|
|
310
|
-
* ...
|
|
311
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-invalidAction)
|
|
287
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-invalidAction)
|
|
312
288
|
*/
|
|
313
289
|
invalidAction? : 'block'|'allow'|'revert'
|
|
314
290
|
/**
|
|
@@ -318,55 +294,52 @@ export type BryntumEditorProps = {
|
|
|
318
294
|
/**
|
|
319
295
|
* An object containing typed child widget config objects or Widgets. May also be specified
|
|
320
296
|
* as an array.
|
|
321
|
-
* ...
|
|
322
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-items)
|
|
297
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-items)
|
|
323
298
|
*/
|
|
324
299
|
items? : Record<string, CoreContainerItemConfig|MenuItemEntry>|(CoreContainerItemConfig|MenuItemEntry|Widget)[]
|
|
325
300
|
/**
|
|
326
301
|
* An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
|
|
327
302
|
* and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
|
|
328
303
|
* are the name of the instance method to call when the keystroke is received.
|
|
329
|
-
* ...
|
|
330
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-keyMap)
|
|
304
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-keyMap)
|
|
331
305
|
*/
|
|
332
306
|
keyMap? : Record<string, KeyMapConfig>
|
|
333
307
|
/**
|
|
334
308
|
* Convenience setting to use same label placement on all child widgets.
|
|
335
|
-
* ...
|
|
336
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-labelPosition)
|
|
309
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-labelPosition)
|
|
337
310
|
*/
|
|
338
311
|
labelPosition? : 'before'|'above'|'align-before'|'auto'|null
|
|
312
|
+
/**
|
|
313
|
+
* Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
|
|
314
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-labelWidth)
|
|
315
|
+
*/
|
|
316
|
+
labelWidth? : number|null
|
|
339
317
|
/**
|
|
340
318
|
* The short name of a helper class which manages rendering and styling of child items.
|
|
341
|
-
* ...
|
|
342
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-layout)
|
|
319
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-layout)
|
|
343
320
|
*/
|
|
344
321
|
layout? : string|CoreContainerLayoutConfig
|
|
345
322
|
/**
|
|
346
323
|
* The CSS style properties to apply to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
|
|
347
|
-
* ...
|
|
348
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-layoutStyle)
|
|
324
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-layoutStyle)
|
|
349
325
|
*/
|
|
350
326
|
layoutStyle? : object
|
|
351
327
|
/**
|
|
352
328
|
* 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
|
|
353
329
|
* instances only when this Container is rendered, rather than eagerly at construct time.
|
|
354
|
-
* ...
|
|
355
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-lazyItems)
|
|
330
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-lazyItems)
|
|
356
331
|
*/
|
|
357
332
|
lazyItems? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|Widget[]
|
|
358
333
|
/**
|
|
359
334
|
* The listener set for this object.
|
|
360
|
-
* ...
|
|
361
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-listeners)
|
|
335
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-listeners)
|
|
362
336
|
*/
|
|
363
337
|
listeners? : EditorListeners
|
|
364
338
|
/**
|
|
365
339
|
* A class translations of which are used for translating this entity.
|
|
366
340
|
* This is often used when translations of an item are defined on its container class.
|
|
367
341
|
* For example:
|
|
368
|
-
* ...
|
|
369
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-localeClass)
|
|
342
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-localeClass)
|
|
370
343
|
*/
|
|
371
344
|
localeClass? : typeof Base
|
|
372
345
|
/**
|
|
@@ -378,8 +351,7 @@ export type BryntumEditorProps = {
|
|
|
378
351
|
* In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
|
|
379
352
|
* you could use 'localeKey' meta configuration.
|
|
380
353
|
* Example:
|
|
381
|
-
* ...
|
|
382
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-localizableProperties)
|
|
354
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-localizableProperties)
|
|
383
355
|
*/
|
|
384
356
|
localizableProperties? : string[]
|
|
385
357
|
/**
|
|
@@ -405,13 +377,11 @@ export type BryntumEditorProps = {
|
|
|
405
377
|
/**
|
|
406
378
|
* By default, an Editor matches both dimensions, width and height of the element it is targeted at in the
|
|
407
379
|
* [startEdit](https://bryntum.com/products/core/docs/api/Core/widget/Editor#function-startEdit) function.
|
|
408
|
-
* ...
|
|
409
|
-
*
|
|
380
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-matchSize)
|
|
381
|
+
* @property {boolean} width `true` to match width
|
|
382
|
+
* @property {boolean} height `true`to match height
|
|
410
383
|
*/
|
|
411
|
-
matchSize? : boolean|
|
|
412
|
-
width?: boolean
|
|
413
|
-
height?: boolean
|
|
414
|
-
}
|
|
384
|
+
matchSize? : boolean|object
|
|
415
385
|
/**
|
|
416
386
|
* The element's maxHeight. Can be either a String or a Number (which will have 'px' appended). Note that
|
|
417
387
|
* like [height](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
|
|
@@ -419,8 +389,7 @@ export type BryntumEditorProps = {
|
|
|
419
389
|
maxHeight? : string|number
|
|
420
390
|
/**
|
|
421
391
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
422
|
-
* ...
|
|
423
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-maximizeOnMobile)
|
|
392
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-maximizeOnMobile)
|
|
424
393
|
*/
|
|
425
394
|
maximizeOnMobile? : number|string
|
|
426
395
|
/**
|
|
@@ -442,26 +411,22 @@ export type BryntumEditorProps = {
|
|
|
442
411
|
* When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
|
|
443
412
|
* is used to monitor this element for size changes caused by either style manipulation, or by CSS
|
|
444
413
|
* layout.
|
|
445
|
-
* ...
|
|
446
|
-
*
|
|
414
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-monitorResize)
|
|
415
|
+
* @property {boolean} immediate Set to `true` to receive resize notifications immediately.
|
|
447
416
|
*/
|
|
448
|
-
monitorResize? : boolean|
|
|
449
|
-
immediate?: boolean
|
|
450
|
-
}
|
|
417
|
+
monitorResize? : boolean|object
|
|
451
418
|
/**
|
|
452
419
|
* 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)
|
|
453
420
|
* config. For example, a specialized [Menu](https://bryntum.com/products/core/docs/api/Core/widget/Menu) subclass may have a `namedItems` default
|
|
454
421
|
* value defined like this:
|
|
455
|
-
* ...
|
|
456
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-namedItems)
|
|
422
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-namedItems)
|
|
457
423
|
*/
|
|
458
424
|
namedItems? : Record<string, CoreContainerItemConfig>
|
|
459
425
|
/**
|
|
460
426
|
* 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
|
|
461
427
|
* not participate in the standard layout of that widget, and must be positioned relatively to that
|
|
462
428
|
* widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
|
|
463
|
-
* ...
|
|
464
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-positioned)
|
|
429
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-positioned)
|
|
465
430
|
*/
|
|
466
431
|
positioned? : boolean
|
|
467
432
|
/**
|
|
@@ -472,45 +437,45 @@ export type BryntumEditorProps = {
|
|
|
472
437
|
/**
|
|
473
438
|
* Whether this widget is read-only. This is only valid if the widget is an input
|
|
474
439
|
* field, <strong>or contains input fields at any depth</strong>.
|
|
475
|
-
* ...
|
|
476
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-readOnly)
|
|
440
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-readOnly)
|
|
477
441
|
*/
|
|
478
442
|
readOnly? : boolean
|
|
479
443
|
/**
|
|
480
444
|
* [Record](https://bryntum.com/products/core/docs/api/Core/data/Model) whose values will be used to populate fields in the container.
|
|
481
|
-
* ...
|
|
482
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-record)
|
|
445
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-record)
|
|
483
446
|
*/
|
|
484
447
|
record? : Model
|
|
485
448
|
relayStoreEvents? : boolean
|
|
486
449
|
/**
|
|
487
450
|
* Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
|
|
488
451
|
* `type`.
|
|
489
|
-
* ...
|
|
490
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-rendition)
|
|
452
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-rendition)
|
|
491
453
|
*/
|
|
492
454
|
rendition? : string|Record<string, string>|null
|
|
493
455
|
/**
|
|
494
456
|
* Configure as `true` to have the component display a translucent ripple when its
|
|
495
457
|
* [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
|
|
496
458
|
* current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
|
|
497
|
-
* ...
|
|
498
|
-
* [
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
459
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-ripple)
|
|
460
|
+
* @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
|
|
461
|
+
* @property {string} [color] A CSS color name or specification.
|
|
462
|
+
* @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
|
|
463
|
+
* @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.
|
|
464
|
+
*/
|
|
465
|
+
ripple? : boolean|object
|
|
466
|
+
/**
|
|
467
|
+
* The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
|
|
468
|
+
* accidentally applying a role which may interfere with screen readers.
|
|
469
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-role)
|
|
470
|
+
*/
|
|
471
|
+
role? : string
|
|
506
472
|
/**
|
|
507
473
|
* 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`
|
|
508
474
|
*/
|
|
509
475
|
rootElement? : ShadowRoot|HTMLElement
|
|
510
476
|
/**
|
|
511
477
|
* This may be configured as `true` to make the widget's element use the `direction:rtl` style.
|
|
512
|
-
* ...
|
|
513
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-rtl)
|
|
478
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-rtl)
|
|
514
479
|
*/
|
|
515
480
|
rtl? : boolean
|
|
516
481
|
/**
|
|
@@ -518,8 +483,7 @@ export type BryntumEditorProps = {
|
|
|
518
483
|
* in both axes. May be an object containing boolean `overflowX` and `overflowY` properties which are
|
|
519
484
|
* applied to CSS style properties `overflowX` and `overflowY`. If they are boolean, they are translated to
|
|
520
485
|
* CSS overflow properties thus:
|
|
521
|
-
* ...
|
|
522
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-scrollable)
|
|
486
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-scrollable)
|
|
523
487
|
*/
|
|
524
488
|
scrollable? : boolean|ScrollerConfig|Scroller
|
|
525
489
|
/**
|
|
@@ -529,8 +493,7 @@ export type BryntumEditorProps = {
|
|
|
529
493
|
scrollAction? : 'hide'|'realign'|null
|
|
530
494
|
/**
|
|
531
495
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
532
|
-
* ...
|
|
533
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-showAnimation)
|
|
496
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-showAnimation)
|
|
534
497
|
*/
|
|
535
498
|
showAnimation? : boolean|object
|
|
536
499
|
/**
|
|
@@ -550,15 +513,13 @@ export type BryntumEditorProps = {
|
|
|
550
513
|
* 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
|
|
551
514
|
* [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
|
|
552
515
|
* this widget:
|
|
553
|
-
* ...
|
|
554
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-tab)
|
|
516
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-tab)
|
|
555
517
|
*/
|
|
556
518
|
tab? : boolean|TabConfig
|
|
557
519
|
/**
|
|
558
520
|
* When this container is used as a tab in a TabPanel, these items are added to the
|
|
559
521
|
* [TabBar](https://bryntum.com/products/core/docs/api/Core/widget/TabBar) when this container is the active tab.
|
|
560
|
-
* ...
|
|
561
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-tabBarItems)
|
|
522
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-tabBarItems)
|
|
562
523
|
*/
|
|
563
524
|
tabBarItems? : ToolbarItems[]|Widget[]
|
|
564
525
|
/**
|
|
@@ -567,15 +528,13 @@ export type BryntumEditorProps = {
|
|
|
567
528
|
tag? : string
|
|
568
529
|
/**
|
|
569
530
|
* Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
|
|
570
|
-
* ...
|
|
571
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-textAlign)
|
|
531
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-textAlign)
|
|
572
532
|
*/
|
|
573
533
|
textAlign? : 'left'|'center'|'right'|'start'|'end'
|
|
574
534
|
/**
|
|
575
535
|
* Specify `true` for a container used to show text markup. It will apply the CSS class `b-text-content`
|
|
576
536
|
* which specifies a default max-width that makes long text more readable.
|
|
577
|
-
* ...
|
|
578
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-textContent)
|
|
537
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-textContent)
|
|
579
538
|
*/
|
|
580
539
|
textContent? : boolean
|
|
581
540
|
/**
|
|
@@ -584,8 +543,7 @@ export type BryntumEditorProps = {
|
|
|
584
543
|
title? : string
|
|
585
544
|
/**
|
|
586
545
|
* Tooltip for the widget, either as a string or as a Tooltip config object.
|
|
587
|
-
* ...
|
|
588
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-tooltip)
|
|
546
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-tooltip)
|
|
589
547
|
*/
|
|
590
548
|
tooltip? : string|TooltipConfig|null
|
|
591
549
|
type? : 'Editor'|'editor'
|
|
@@ -593,8 +551,7 @@ export type BryntumEditorProps = {
|
|
|
593
551
|
* Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
|
|
594
552
|
* as a space separated string, an array of strings, or as an object in which property names with truthy
|
|
595
553
|
* values are used as the class names.
|
|
596
|
-
* ...
|
|
597
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-ui)
|
|
554
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-ui)
|
|
598
555
|
*/
|
|
599
556
|
ui? : string|object
|
|
600
557
|
/**
|
|
@@ -610,14 +567,12 @@ export type BryntumEditorProps = {
|
|
|
610
567
|
width? : string|number
|
|
611
568
|
/**
|
|
612
569
|
* The x position for the widget.
|
|
613
|
-
* ...
|
|
614
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-x)
|
|
570
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-x)
|
|
615
571
|
*/
|
|
616
572
|
x? : number
|
|
617
573
|
/**
|
|
618
574
|
* The y position for the widget.
|
|
619
|
-
* ...
|
|
620
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-y)
|
|
575
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-y)
|
|
621
576
|
*/
|
|
622
577
|
y? : number
|
|
623
578
|
|
|
@@ -626,7 +581,7 @@ export type BryntumEditorProps = {
|
|
|
626
581
|
* Fired after the editor is finalized and hidden, regardless whether it was completed or aborted.
|
|
627
582
|
* @param {object} event Event object
|
|
628
583
|
* @param {Core.widget.Editor} event.source The Editor that triggered the event.
|
|
629
|
-
* @param {Core.data.Model} event.record The record that was edited.
|
|
584
|
+
* @param {Core.data.Model} [event.record] The record that was edited.
|
|
630
585
|
*/
|
|
631
586
|
onAfterEdit? : ((event: { source: Editor, record?: Model }) => void)|string
|
|
632
587
|
/**
|
|
@@ -638,7 +593,7 @@ export type BryntumEditorProps = {
|
|
|
638
593
|
* @param {Event} event.event Included if the cancellation was triggered by a DOM event
|
|
639
594
|
* @param {Core.widget.Editor} event.source The Editor that triggered the event.
|
|
640
595
|
*/
|
|
641
|
-
onBeforeCancel? : ((event: { oldValue: object, value: object, event: Event, source: Editor }) =>
|
|
596
|
+
onBeforeCancel? : ((event: { oldValue: object, value: object, event: Event, source: Editor }) => boolean|void)|string
|
|
642
597
|
/**
|
|
643
598
|
* Fired when an edit completion has been requested, either by <kbd>Enter</kbd>, or focus loss (if configured to complete on blur).
|
|
644
599
|
* The completion may be vetoed, in which case, focus is moved back into the editor.
|
|
@@ -646,10 +601,10 @@ export type BryntumEditorProps = {
|
|
|
646
601
|
* @param {object} event.oldValue The original value.
|
|
647
602
|
* @param {object} event.value The new value.
|
|
648
603
|
* @param {Core.widget.Editor} event.source The Editor that triggered the event.
|
|
649
|
-
* @param {Function} event.finalize An async function may be injected into this property which performs asynchronous finalization tasks such as complex validation of confirmation. The value `true` or `false` must be returned.
|
|
650
|
-
* @param {object} event.finalize.context An object describing the editing context upon requested completion of the edit.
|
|
604
|
+
* @param {Function} [event.finalize] An async function may be injected into this property which performs asynchronous finalization tasks such as complex validation of confirmation. The value `true` or `false` must be returned.
|
|
605
|
+
* @param {object} [event.finalize.context] An object describing the editing context upon requested completion of the edit.
|
|
651
606
|
*/
|
|
652
|
-
onBeforeComplete? : ((event: { oldValue: object, value: object, source: Editor, finalize: { context?: object } }) =>
|
|
607
|
+
onBeforeComplete? : ((event: { oldValue: object, value: object, source: Editor, finalize: { context?: object } }) => boolean|void)|string
|
|
653
608
|
/**
|
|
654
609
|
* Fires before an object is destroyed.
|
|
655
610
|
* @param {object} event Event object
|
|
@@ -661,7 +616,7 @@ export type BryntumEditorProps = {
|
|
|
661
616
|
* @param {object} event Event object
|
|
662
617
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
663
618
|
*/
|
|
664
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
619
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
665
620
|
/**
|
|
666
621
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
667
622
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -679,9 +634,9 @@ export type BryntumEditorProps = {
|
|
|
679
634
|
/**
|
|
680
635
|
* Fired before the editor is shown to start an edit operation. Returning `false` from a handler vetoes the edit operation.
|
|
681
636
|
* @param {object} event Event object
|
|
682
|
-
* @param {
|
|
683
|
-
* @param {Core.data.Model} event.record The record being edited.
|
|
684
|
-
* @param {string} event.field The name of the field if a record is being edited.
|
|
637
|
+
* @param {Element} event.target The element which the Editor is to overlay to edit its content.
|
|
638
|
+
* @param {Core.data.Model} [event.record] The record being edited.
|
|
639
|
+
* @param {string} [event.field] The name of the field if a record is being edited.
|
|
685
640
|
* @param {object} event.value The value to be edited.
|
|
686
641
|
* @param {string,AlignSpec} event.align How to align the editor.
|
|
687
642
|
* @param {boolean} event.hideTarget `true` if the target is to be hidden during the edit.
|
|
@@ -691,7 +646,7 @@ export type BryntumEditorProps = {
|
|
|
691
646
|
* @param {boolean} event.matchFont Whether to match the target's font. See [matchFont](https://bryntum.com/products/core/docs/api/Core/widget/Editor#config-matchFont)
|
|
692
647
|
* @param {boolean} event.focus Whether to focus the editor's field.
|
|
693
648
|
*/
|
|
694
|
-
onBeforeStart? : ((event: { target:
|
|
649
|
+
onBeforeStart? : ((event: { target: Element, record?: Model, field?: string, value: object, align: string|AlignSpec, hideTarget: boolean, matchSize: { width: boolean, height: boolean }, matchFont: boolean, focus: boolean }) => boolean|void)|string
|
|
695
650
|
/**
|
|
696
651
|
* Edit has been canceled without updating the associated record or element.
|
|
697
652
|
* @param {object} event Event object
|
|
@@ -703,8 +658,7 @@ export type BryntumEditorProps = {
|
|
|
703
658
|
onCancel? : ((event: { oldValue: object, value: object, event: Event, source: Editor }) => void)|string
|
|
704
659
|
/**
|
|
705
660
|
* Fires when any other event is fired from the object.
|
|
706
|
-
* ...
|
|
707
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#event-catchAll)
|
|
661
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#event-catchAll)
|
|
708
662
|
* @param {object} event Event object
|
|
709
663
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
710
664
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -776,8 +730,7 @@ export type BryntumEditorProps = {
|
|
|
776
730
|
/**
|
|
777
731
|
* Triggered when a widget which had been in a non-visible state for any reason
|
|
778
732
|
* achieves visibility.
|
|
779
|
-
* ...
|
|
780
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#event-paint)
|
|
733
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#event-paint)
|
|
781
734
|
* @param {object} event Event object
|
|
782
735
|
* @param {Core.widget.Widget} event.source The widget being painted.
|
|
783
736
|
* @param {boolean} event.firstPaint `true` if this is the first paint.
|
|
@@ -879,6 +832,7 @@ export class BryntumEditor extends React.Component<BryntumEditorProps> {
|
|
|
879
832
|
'preventTooltipOnTouch',
|
|
880
833
|
'relayStoreEvents',
|
|
881
834
|
'ripple',
|
|
835
|
+
'role',
|
|
882
836
|
'rootElement',
|
|
883
837
|
'scrollAction',
|
|
884
838
|
'showAnimation',
|
|
@@ -917,6 +871,7 @@ export class BryntumEditor extends React.Component<BryntumEditorProps> {
|
|
|
917
871
|
'items',
|
|
918
872
|
'keyMap',
|
|
919
873
|
'labelPosition',
|
|
874
|
+
'labelWidth',
|
|
920
875
|
'layout',
|
|
921
876
|
'layoutStyle',
|
|
922
877
|
'margin',
|
|
@@ -963,11 +918,6 @@ export class BryntumEditor extends React.Component<BryntumEditorProps> {
|
|
|
963
918
|
];
|
|
964
919
|
|
|
965
920
|
static propertyNames = [
|
|
966
|
-
'anchorSize',
|
|
967
|
-
'focusVisible',
|
|
968
|
-
'hasChanges',
|
|
969
|
-
'isSettingValues',
|
|
970
|
-
'isValid',
|
|
971
921
|
'parent',
|
|
972
922
|
'values'
|
|
973
923
|
];
|