@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/BryntumButton.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, Button, ButtonListeners, Color, CoreContainerItemConfig, DomConfig, KeyMapConfig, MaskConfig, Menu, MenuConfig, MenuItemEntry, PopupConfig, Rectangle, Scroller, ScrollerConfig, TabConfig, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
|
|
6
|
+
import { AlignSpec, Base, Button, ButtonListeners, Color, CoreContainerItemConfig, DomConfig, KeyMapConfig, MaskConfig, Menu, MenuConfig, MenuItemEntry, PopupConfig, ReactJSX, Rectangle, Scroller, ScrollerConfig, TabConfig, 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 BryntumButtonProps = {
|
|
|
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/Button#config-adopt)
|
|
15
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#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/Button#config-align)
|
|
20
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-align)
|
|
23
21
|
*/
|
|
24
22
|
align? : AlignSpec|string
|
|
25
23
|
/**
|
|
@@ -41,15 +39,13 @@ export type BryntumButtonProps = {
|
|
|
41
39
|
/**
|
|
42
40
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
|
|
43
41
|
* 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/Button#config-ariaDescription)
|
|
42
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-ariaDescription)
|
|
46
43
|
*/
|
|
47
44
|
ariaDescription? : string
|
|
48
45
|
/**
|
|
49
46
|
* A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
|
|
50
47
|
* the `aria-label` attribute.
|
|
51
|
-
* ...
|
|
52
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-ariaLabel)
|
|
48
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-ariaLabel)
|
|
53
49
|
*/
|
|
54
50
|
ariaLabel? : string
|
|
55
51
|
/**
|
|
@@ -63,21 +59,18 @@ export type BryntumButtonProps = {
|
|
|
63
59
|
/**
|
|
64
60
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
65
61
|
* hierarchy when triggered.
|
|
66
|
-
* ...
|
|
67
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-bubbleEvents)
|
|
62
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-bubbleEvents)
|
|
68
63
|
*/
|
|
69
64
|
bubbleEvents? : object
|
|
70
65
|
/**
|
|
71
66
|
* Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
72
|
-
* ...
|
|
73
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-callOnFunctions)
|
|
67
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-callOnFunctions)
|
|
74
68
|
*/
|
|
75
69
|
callOnFunctions? : boolean
|
|
76
70
|
/**
|
|
77
71
|
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
78
72
|
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
79
|
-
* ...
|
|
80
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-catchEventHandlerExceptions)
|
|
73
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-catchEventHandlerExceptions)
|
|
81
74
|
*/
|
|
82
75
|
catchEventHandlerExceptions? : boolean
|
|
83
76
|
/**
|
|
@@ -89,15 +82,13 @@ export type BryntumButtonProps = {
|
|
|
89
82
|
* Custom CSS classes to add to element.
|
|
90
83
|
* May be specified as a space separated string, or as an object in which property names
|
|
91
84
|
* with truthy values are used as the class names:
|
|
92
|
-
* ...
|
|
93
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-cls)
|
|
85
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-cls)
|
|
94
86
|
*/
|
|
95
87
|
cls? : string|object
|
|
96
88
|
/**
|
|
97
89
|
* Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
|
|
98
90
|
* `style` block.
|
|
99
|
-
* ...
|
|
100
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-color)
|
|
91
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-color)
|
|
101
92
|
*/
|
|
102
93
|
color? : Color
|
|
103
94
|
/**
|
|
@@ -121,8 +112,7 @@ export type BryntumButtonProps = {
|
|
|
121
112
|
* Custom CSS classes to add to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
|
|
122
113
|
* May be specified as a space separated string, or as an object in which property names
|
|
123
114
|
* with truthy values are used as the class names:
|
|
124
|
-
* ...
|
|
125
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-contentElementCls)
|
|
115
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-contentElementCls)
|
|
126
116
|
*/
|
|
127
117
|
contentElementCls? : string|object
|
|
128
118
|
/**
|
|
@@ -140,16 +130,15 @@ export type BryntumButtonProps = {
|
|
|
140
130
|
*/
|
|
141
131
|
defaultBindProperty? : string
|
|
142
132
|
/**
|
|
143
|
-
* Check for CSS compatibility issues
|
|
144
|
-
*
|
|
145
|
-
* [
|
|
133
|
+
* Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
|
|
134
|
+
* checks:
|
|
135
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-detectCSSCompatibilityIssues)
|
|
146
136
|
*/
|
|
147
137
|
detectCSSCompatibilityIssues? : boolean
|
|
148
138
|
/**
|
|
149
139
|
* 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
|
|
150
140
|
* cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
|
|
151
|
-
* ...
|
|
152
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-disabled)
|
|
141
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-disabled)
|
|
153
142
|
*/
|
|
154
143
|
disabled? : boolean|'inert'
|
|
155
144
|
/**
|
|
@@ -157,25 +146,21 @@ export type BryntumButtonProps = {
|
|
|
157
146
|
* [strips collection](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
|
|
158
147
|
* `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
|
|
159
148
|
* body. Such widgets are called "edge strips".
|
|
160
|
-
* ...
|
|
161
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-dock)
|
|
149
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-dock)
|
|
162
150
|
*/
|
|
163
151
|
dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
164
152
|
/**
|
|
165
153
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
166
154
|
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
|
|
167
155
|
* property which controls when a drag should start.
|
|
168
|
-
* ...
|
|
169
|
-
*
|
|
156
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-draggable)
|
|
157
|
+
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
170
158
|
*/
|
|
171
|
-
draggable? : boolean|
|
|
172
|
-
handleSelector?: string
|
|
173
|
-
}
|
|
159
|
+
draggable? : boolean|object
|
|
174
160
|
/**
|
|
175
161
|
* An object specifying attributes to assign to the root element of this widget.
|
|
176
162
|
* Set `null` value to attribute to remove it.
|
|
177
|
-
* ...
|
|
178
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-elementAttributes)
|
|
163
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-elementAttributes)
|
|
179
164
|
*/
|
|
180
165
|
elementAttributes? : Record<string, string|null>
|
|
181
166
|
extraData? : any
|
|
@@ -204,32 +189,27 @@ export type BryntumButtonProps = {
|
|
|
204
189
|
hidden? : boolean
|
|
205
190
|
/**
|
|
206
191
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
207
|
-
* ...
|
|
208
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-hideAnimation)
|
|
192
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-hideAnimation)
|
|
209
193
|
*/
|
|
210
194
|
hideAnimation? : boolean|object
|
|
211
195
|
/**
|
|
212
196
|
* If provided, turns the button into a link.
|
|
213
|
-
* ...
|
|
214
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-href)
|
|
197
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-href)
|
|
215
198
|
*/
|
|
216
199
|
href? : string
|
|
217
200
|
/**
|
|
218
201
|
* The HTML to display initially or a function returning the markup (called at widget construction time).
|
|
219
|
-
* ...
|
|
220
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-html)
|
|
202
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-html)
|
|
221
203
|
* @param {Core.widget.Widget} widget The calling Widget
|
|
222
|
-
* @returns {string}
|
|
223
204
|
*/
|
|
224
|
-
html? : string|((widget: Widget) =>
|
|
205
|
+
html? : string|((widget: Widget) => void)|DomConfig|DomConfig[]|VueConfig|ReactJSX
|
|
225
206
|
/**
|
|
226
207
|
* The CSS class(es) to add when HTML content is being applied to this widget.
|
|
227
208
|
*/
|
|
228
209
|
htmlCls? : string|object
|
|
229
210
|
/**
|
|
230
211
|
* Button icon class, a developer-defined CSS class string which results in the desired icon.
|
|
231
|
-
* ...
|
|
232
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-icon)
|
|
212
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-icon)
|
|
233
213
|
*/
|
|
234
214
|
icon? : string
|
|
235
215
|
/**
|
|
@@ -242,8 +222,7 @@ export type BryntumButtonProps = {
|
|
|
242
222
|
id? : string
|
|
243
223
|
/**
|
|
244
224
|
* Determines if the widgets read-only state should be controlled by its parent.
|
|
245
|
-
* ...
|
|
246
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-ignoreParentReadOnly)
|
|
225
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-ignoreParentReadOnly)
|
|
247
226
|
*/
|
|
248
227
|
ignoreParentReadOnly? : boolean
|
|
249
228
|
/**
|
|
@@ -258,22 +237,19 @@ export type BryntumButtonProps = {
|
|
|
258
237
|
* An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
|
|
259
238
|
* and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
|
|
260
239
|
* are the name of the instance method to call when the keystroke is received.
|
|
261
|
-
* ...
|
|
262
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-keyMap)
|
|
240
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-keyMap)
|
|
263
241
|
*/
|
|
264
242
|
keyMap? : Record<string, KeyMapConfig>
|
|
265
243
|
/**
|
|
266
244
|
* The listener set for this object.
|
|
267
|
-
* ...
|
|
268
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-listeners)
|
|
245
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-listeners)
|
|
269
246
|
*/
|
|
270
247
|
listeners? : ButtonListeners
|
|
271
248
|
/**
|
|
272
249
|
* A class translations of which are used for translating this entity.
|
|
273
250
|
* This is often used when translations of an item are defined on its container class.
|
|
274
251
|
* For example:
|
|
275
|
-
* ...
|
|
276
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-localeClass)
|
|
252
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-localeClass)
|
|
277
253
|
*/
|
|
278
254
|
localeClass? : typeof Base
|
|
279
255
|
/**
|
|
@@ -285,8 +261,7 @@ export type BryntumButtonProps = {
|
|
|
285
261
|
* In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
|
|
286
262
|
* you could use 'localeKey' meta configuration.
|
|
287
263
|
* Example:
|
|
288
|
-
* ...
|
|
289
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-localizableProperties)
|
|
264
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-localizableProperties)
|
|
290
265
|
*/
|
|
291
266
|
localizableProperties? : string[]
|
|
292
267
|
/**
|
|
@@ -312,8 +287,7 @@ export type BryntumButtonProps = {
|
|
|
312
287
|
maxHeight? : string|number
|
|
313
288
|
/**
|
|
314
289
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
315
|
-
* ...
|
|
316
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-maximizeOnMobile)
|
|
290
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-maximizeOnMobile)
|
|
317
291
|
*/
|
|
318
292
|
maximizeOnMobile? : number|string
|
|
319
293
|
/**
|
|
@@ -324,14 +298,12 @@ export type BryntumButtonProps = {
|
|
|
324
298
|
/**
|
|
325
299
|
* A submenu configuration object, or an array of MenuItem configuration objects from which to create a
|
|
326
300
|
* submenu which is shown when this button is pressed.
|
|
327
|
-
* ...
|
|
328
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-menu)
|
|
301
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-menu)
|
|
329
302
|
*/
|
|
330
303
|
menu? : Record<string, MenuItemEntry|CoreContainerItemConfig>|(MenuItemEntry|CoreContainerItemConfig)[]|MenuConfig|PopupConfig
|
|
331
304
|
/**
|
|
332
305
|
* The menu icon class to show when the button has a menu. Set to `null` to not show a menu icon.
|
|
333
|
-
* ...
|
|
334
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-menuIcon)
|
|
306
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-menuIcon)
|
|
335
307
|
*/
|
|
336
308
|
menuIcon? : string
|
|
337
309
|
/**
|
|
@@ -348,24 +320,20 @@ export type BryntumButtonProps = {
|
|
|
348
320
|
* When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
|
|
349
321
|
* is used to monitor this element for size changes caused by either style manipulation, or by CSS
|
|
350
322
|
* layout.
|
|
351
|
-
* ...
|
|
352
|
-
*
|
|
323
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-monitorResize)
|
|
324
|
+
* @property {boolean} immediate Set to `true` to receive resize notifications immediately.
|
|
353
325
|
*/
|
|
354
|
-
monitorResize? : boolean|
|
|
355
|
-
immediate?: boolean
|
|
356
|
-
}
|
|
326
|
+
monitorResize? : boolean|object
|
|
357
327
|
/**
|
|
358
328
|
* 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
|
|
359
329
|
* not participate in the standard layout of that widget, and must be positioned relatively to that
|
|
360
330
|
* widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
|
|
361
|
-
* ...
|
|
362
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-positioned)
|
|
331
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-positioned)
|
|
363
332
|
*/
|
|
364
333
|
positioned? : boolean
|
|
365
334
|
/**
|
|
366
335
|
* Initially pressed or not. Only applies with `toggleable = true`.
|
|
367
|
-
* ...
|
|
368
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-pressed)
|
|
336
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-pressed)
|
|
369
337
|
*/
|
|
370
338
|
pressed? : boolean
|
|
371
339
|
/**
|
|
@@ -376,8 +344,7 @@ export type BryntumButtonProps = {
|
|
|
376
344
|
/**
|
|
377
345
|
* Icon class for the buttons pressed state, a developer-defined CSS class string which results in the
|
|
378
346
|
* desired icon. Only applies to toggle buttons
|
|
379
|
-
* ...
|
|
380
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-pressedIcon)
|
|
347
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-pressedIcon)
|
|
381
348
|
*/
|
|
382
349
|
pressedIcon? : string
|
|
383
350
|
/**
|
|
@@ -388,38 +355,39 @@ export type BryntumButtonProps = {
|
|
|
388
355
|
/**
|
|
389
356
|
* Whether this widget is read-only. This is only valid if the widget is an input
|
|
390
357
|
* field, <strong>or contains input fields at any depth</strong>.
|
|
391
|
-
* ...
|
|
392
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-readOnly)
|
|
358
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-readOnly)
|
|
393
359
|
*/
|
|
394
360
|
readOnly? : boolean
|
|
395
361
|
relayStoreEvents? : boolean
|
|
396
362
|
/**
|
|
397
363
|
* Predefined style to use for the button. Possible values are:
|
|
398
|
-
* ...
|
|
399
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-rendition)
|
|
364
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-rendition)
|
|
400
365
|
*/
|
|
401
366
|
rendition? : 'elevated'|'filled'|'tonal'|'outlined'|'text'|string
|
|
402
367
|
/**
|
|
403
368
|
* Configure as `true` to have the component display a translucent ripple when its
|
|
404
369
|
* [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
|
|
405
370
|
* current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
|
|
406
|
-
* ...
|
|
407
|
-
* [
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
371
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-ripple)
|
|
372
|
+
* @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
|
|
373
|
+
* @property {string} [color] A CSS color name or specification.
|
|
374
|
+
* @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
|
|
375
|
+
* @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.
|
|
376
|
+
*/
|
|
377
|
+
ripple? : boolean|object
|
|
378
|
+
/**
|
|
379
|
+
* The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
|
|
380
|
+
* accidentally applying a role which may interfere with screen readers.
|
|
381
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-role)
|
|
382
|
+
*/
|
|
383
|
+
role? : string
|
|
415
384
|
/**
|
|
416
385
|
* 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`
|
|
417
386
|
*/
|
|
418
387
|
rootElement? : ShadowRoot|HTMLElement
|
|
419
388
|
/**
|
|
420
389
|
* This may be configured as `true` to make the widget's element use the `direction:rtl` style.
|
|
421
|
-
* ...
|
|
422
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-rtl)
|
|
390
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-rtl)
|
|
423
391
|
*/
|
|
424
392
|
rtl? : boolean
|
|
425
393
|
/**
|
|
@@ -427,8 +395,7 @@ export type BryntumButtonProps = {
|
|
|
427
395
|
* in both axes. May be an object containing boolean `overflowX` and `overflowY` properties which are
|
|
428
396
|
* applied to CSS style properties `overflowX` and `overflowY`. If they are boolean, they are translated to
|
|
429
397
|
* CSS overflow properties thus:
|
|
430
|
-
* ...
|
|
431
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-scrollable)
|
|
398
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-scrollable)
|
|
432
399
|
*/
|
|
433
400
|
scrollable? : boolean|ScrollerConfig|Scroller
|
|
434
401
|
/**
|
|
@@ -438,8 +405,7 @@ export type BryntumButtonProps = {
|
|
|
438
405
|
scrollAction? : 'hide'|'realign'|null
|
|
439
406
|
/**
|
|
440
407
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
441
|
-
* ...
|
|
442
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-showAnimation)
|
|
408
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-showAnimation)
|
|
443
409
|
*/
|
|
444
410
|
showAnimation? : boolean|object
|
|
445
411
|
/**
|
|
@@ -452,8 +418,7 @@ export type BryntumButtonProps = {
|
|
|
452
418
|
span? : number
|
|
453
419
|
/**
|
|
454
420
|
* Set to `true` to create a split button. A split button has a main action and a dropdown arrow to show a menu.
|
|
455
|
-
* ...
|
|
456
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-split)
|
|
421
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-split)
|
|
457
422
|
*/
|
|
458
423
|
split? : boolean|'mouseover'|'hover'
|
|
459
424
|
/**
|
|
@@ -465,8 +430,7 @@ export type BryntumButtonProps = {
|
|
|
465
430
|
* 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
|
|
466
431
|
* [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
|
|
467
432
|
* this widget:
|
|
468
|
-
* ...
|
|
469
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-tab)
|
|
433
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-tab)
|
|
470
434
|
*/
|
|
471
435
|
tab? : boolean|TabConfig
|
|
472
436
|
/**
|
|
@@ -474,8 +438,7 @@ export type BryntumButtonProps = {
|
|
|
474
438
|
* to natural tab order, but is unnecessary for buttons since they are naturally tabbable (i.e., accessible
|
|
475
439
|
* via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set to the element
|
|
476
440
|
* programmatically.
|
|
477
|
-
* ...
|
|
478
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-tabIndex)
|
|
441
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-tabIndex)
|
|
479
442
|
*/
|
|
480
443
|
tabIndex? : number
|
|
481
444
|
/**
|
|
@@ -493,8 +456,7 @@ export type BryntumButtonProps = {
|
|
|
493
456
|
text? : string|DomConfig|DomConfig[]
|
|
494
457
|
/**
|
|
495
458
|
* Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
|
|
496
|
-
* ...
|
|
497
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-textAlign)
|
|
459
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-textAlign)
|
|
498
460
|
*/
|
|
499
461
|
textAlign? : 'left'|'center'|'right'|'start'|'end'
|
|
500
462
|
/**
|
|
@@ -508,14 +470,12 @@ export type BryntumButtonProps = {
|
|
|
508
470
|
/**
|
|
509
471
|
* Indicates that this button is part of a group where only one button can be pressed. Assigning a value
|
|
510
472
|
* also sets `toggleable` to `true`.
|
|
511
|
-
* ...
|
|
512
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-toggleGroup)
|
|
473
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-toggleGroup)
|
|
513
474
|
*/
|
|
514
475
|
toggleGroup? : string
|
|
515
476
|
/**
|
|
516
477
|
* Tooltip for the widget, either as a string or as a Tooltip config object.
|
|
517
|
-
* ...
|
|
518
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-tooltip)
|
|
478
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-tooltip)
|
|
519
479
|
*/
|
|
520
480
|
tooltip? : string|TooltipConfig|null
|
|
521
481
|
type? : 'button'
|
|
@@ -523,8 +483,7 @@ export type BryntumButtonProps = {
|
|
|
523
483
|
* Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
|
|
524
484
|
* as a space separated string, an array of strings, or as an object in which property names with truthy
|
|
525
485
|
* values are used as the class names.
|
|
526
|
-
* ...
|
|
527
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-ui)
|
|
486
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-ui)
|
|
528
487
|
*/
|
|
529
488
|
ui? : string|object
|
|
530
489
|
/**
|
|
@@ -540,14 +499,12 @@ export type BryntumButtonProps = {
|
|
|
540
499
|
width? : string|number
|
|
541
500
|
/**
|
|
542
501
|
* The x position for the widget.
|
|
543
|
-
* ...
|
|
544
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-x)
|
|
502
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-x)
|
|
545
503
|
*/
|
|
546
504
|
x? : number
|
|
547
505
|
/**
|
|
548
506
|
* The y position for the widget.
|
|
549
|
-
* ...
|
|
550
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-y)
|
|
507
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-y)
|
|
551
508
|
*/
|
|
552
509
|
y? : number
|
|
553
510
|
|
|
@@ -601,8 +558,7 @@ export type BryntumButtonProps = {
|
|
|
601
558
|
onBeforeToggle? : ((event: { source: Button, pressed: boolean, userAction: boolean, domEvent: Event }) => Promise<boolean>|boolean|void)|string
|
|
602
559
|
/**
|
|
603
560
|
* Fires when any other event is fired from the object.
|
|
604
|
-
* ...
|
|
605
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#event-catchAll)
|
|
561
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#event-catchAll)
|
|
606
562
|
* @param {object} event Event object
|
|
607
563
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
608
564
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -661,8 +617,7 @@ export type BryntumButtonProps = {
|
|
|
661
617
|
/**
|
|
662
618
|
* Triggered when a widget which had been in a non-visible state for any reason
|
|
663
619
|
* achieves visibility.
|
|
664
|
-
* ...
|
|
665
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#event-paint)
|
|
620
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#event-paint)
|
|
666
621
|
* @param {object} event Event object
|
|
667
622
|
* @param {Core.widget.Widget} event.source The widget being painted.
|
|
668
623
|
* @param {boolean} event.firstPaint `true` if this is the first paint.
|
|
@@ -750,6 +705,7 @@ export class BryntumButton extends React.Component<BryntumButtonProps> {
|
|
|
750
705
|
'preventTooltipOnTouch',
|
|
751
706
|
'relayStoreEvents',
|
|
752
707
|
'ripple',
|
|
708
|
+
'role',
|
|
753
709
|
'rootElement',
|
|
754
710
|
'scrollAction',
|
|
755
711
|
'showAnimation',
|
|
@@ -836,8 +792,6 @@ export class BryntumButton extends React.Component<BryntumButtonProps> {
|
|
|
836
792
|
];
|
|
837
793
|
|
|
838
794
|
static propertyNames = [
|
|
839
|
-
'anchorSize',
|
|
840
|
-
'focusVisible',
|
|
841
795
|
'parent'
|
|
842
796
|
];
|
|
843
797
|
|