@bryntum/core-react-thin 7.2.3 → 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/BryntumHint.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, ButtonConfig, Color, Container, CoreContainerItemConfig, CoreContainerLayoutConfig, DomConfig, Hint, HintActions, HintListeners, KeyMapConfig, Layout, MaskConfig, MenuItemConfig, MenuItemEntry, Model, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, Popup, Rectangle, Scroller, ScrollerConfig, StateProvider, TabConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
|
|
6
|
+
import { AlignSpec, Base, ButtonConfig, Color, Container, CoreContainerItemConfig, CoreContainerLayoutConfig, DomConfig, Hint, HintActions, HintListeners, KeyMapConfig, Layout, MaskConfig, MenuItemConfig, MenuItemEntry, Model, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, Popup, 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 BryntumHintProps = {
|
|
|
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/Hint#config-adopt)
|
|
15
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#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/Hint#config-align)
|
|
20
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-align)
|
|
23
21
|
*/
|
|
24
22
|
align? : AlignSpec|string
|
|
25
23
|
/**
|
|
@@ -41,15 +39,13 @@ export type BryntumHintProps = {
|
|
|
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/Hint#config-ariaDescription)
|
|
42
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#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/Hint#config-ariaLabel)
|
|
48
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-ariaLabel)
|
|
53
49
|
*/
|
|
54
50
|
ariaLabel? : string
|
|
55
51
|
/**
|
|
@@ -64,14 +60,12 @@ export type BryntumHintProps = {
|
|
|
64
60
|
/**
|
|
65
61
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/core/docs/api/Core/widget/Toolbar),
|
|
66
62
|
* 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).
|
|
67
|
-
* ...
|
|
68
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-bbar)
|
|
63
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-bbar)
|
|
69
64
|
*/
|
|
70
65
|
bbar? : (CoreContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
71
66
|
/**
|
|
72
67
|
* Custom CSS classes to add to the panel's body element.
|
|
73
|
-
* ...
|
|
74
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-bodyCls)
|
|
68
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-bodyCls)
|
|
75
69
|
*/
|
|
76
70
|
bodyCls? : string|object
|
|
77
71
|
/**
|
|
@@ -81,27 +75,25 @@ export type BryntumHintProps = {
|
|
|
81
75
|
/**
|
|
82
76
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
83
77
|
* hierarchy when triggered.
|
|
84
|
-
* ...
|
|
85
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-bubbleEvents)
|
|
78
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-bubbleEvents)
|
|
86
79
|
*/
|
|
87
80
|
bubbleEvents? : object
|
|
88
81
|
/**
|
|
89
82
|
* Overrides for buttons to show in the hint.
|
|
90
|
-
* ...
|
|
91
|
-
*
|
|
83
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-buttons)
|
|
84
|
+
* @property {ButtonConfig} next Override the 'Next' button
|
|
85
|
+
* @property {ButtonConfig} previous Override the 'Previous' button
|
|
92
86
|
*/
|
|
93
87
|
buttons? : Record<string, ButtonConfig>
|
|
94
88
|
/**
|
|
95
89
|
* Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
96
|
-
* ...
|
|
97
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-callOnFunctions)
|
|
90
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-callOnFunctions)
|
|
98
91
|
*/
|
|
99
92
|
callOnFunctions? : boolean
|
|
100
93
|
/**
|
|
101
94
|
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
102
95
|
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
103
|
-
* ...
|
|
104
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-catchEventHandlerExceptions)
|
|
96
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-catchEventHandlerExceptions)
|
|
105
97
|
*/
|
|
106
98
|
catchEventHandlerExceptions? : boolean
|
|
107
99
|
/**
|
|
@@ -112,8 +104,7 @@ export type BryntumHintProps = {
|
|
|
112
104
|
* Custom CSS classes to add to element.
|
|
113
105
|
* May be specified as a space separated string, or as an object in which property names
|
|
114
106
|
* with truthy values are used as the class names:
|
|
115
|
-
* ...
|
|
116
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-cls)
|
|
107
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-cls)
|
|
117
108
|
*/
|
|
118
109
|
cls? : string|object
|
|
119
110
|
/**
|
|
@@ -123,15 +114,13 @@ export type BryntumHintProps = {
|
|
|
123
114
|
collapsed? : boolean
|
|
124
115
|
/**
|
|
125
116
|
* 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/Hint#config-collapsible)
|
|
117
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-collapsible)
|
|
128
118
|
*/
|
|
129
119
|
collapsible? : boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
|
|
130
120
|
/**
|
|
131
121
|
* Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
|
|
132
122
|
* `style` block.
|
|
133
|
-
* ...
|
|
134
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-color)
|
|
123
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-color)
|
|
135
124
|
*/
|
|
136
125
|
color? : Color
|
|
137
126
|
/**
|
|
@@ -155,8 +144,7 @@ export type BryntumHintProps = {
|
|
|
155
144
|
* Custom CSS classes to add to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
|
|
156
145
|
* May be specified as a space separated string, or as an object in which property names
|
|
157
146
|
* with truthy values are used as the class names:
|
|
158
|
-
* ...
|
|
159
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-contentElementCls)
|
|
147
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-contentElementCls)
|
|
160
148
|
*/
|
|
161
149
|
contentElementCls? : string|object
|
|
162
150
|
/**
|
|
@@ -178,16 +166,15 @@ export type BryntumHintProps = {
|
|
|
178
166
|
*/
|
|
179
167
|
defaults? : CoreContainerItemConfig
|
|
180
168
|
/**
|
|
181
|
-
* Check for CSS compatibility issues
|
|
182
|
-
*
|
|
183
|
-
* [
|
|
169
|
+
* Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
|
|
170
|
+
* checks:
|
|
171
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-detectCSSCompatibilityIssues)
|
|
184
172
|
*/
|
|
185
173
|
detectCSSCompatibilityIssues? : boolean
|
|
186
174
|
/**
|
|
187
175
|
* 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
|
|
188
176
|
* cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
|
|
189
|
-
* ...
|
|
190
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-disabled)
|
|
177
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-disabled)
|
|
191
178
|
*/
|
|
192
179
|
disabled? : boolean|'inert'
|
|
193
180
|
/**
|
|
@@ -195,35 +182,31 @@ export type BryntumHintProps = {
|
|
|
195
182
|
* [strips collection](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
|
|
196
183
|
* `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
|
|
197
184
|
* body. Such widgets are called "edge strips".
|
|
198
|
-
* ...
|
|
199
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-dock)
|
|
185
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-dock)
|
|
200
186
|
*/
|
|
201
187
|
dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
202
188
|
/**
|
|
203
189
|
* Set to `false` to prevent dragging the popup element.
|
|
190
|
+
* @property {string} handleSelector CSS selector used to determine if a drag operation can be started from a mouse-downed element inside the popup
|
|
204
191
|
*/
|
|
205
|
-
draggable? : boolean|
|
|
206
|
-
handleSelector?: string
|
|
207
|
-
}
|
|
192
|
+
draggable? : boolean|object
|
|
208
193
|
/**
|
|
209
194
|
* Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
|
|
210
|
-
* ...
|
|
211
|
-
* [
|
|
212
|
-
* @param {
|
|
213
|
-
* @param {
|
|
214
|
-
* @param {boolean}
|
|
215
|
-
* @param {boolean,
|
|
216
|
-
* @param {boolean,string} autoClose.
|
|
217
|
-
* @param {
|
|
218
|
-
* @param {
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
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}
|
|
195
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-drawer)
|
|
196
|
+
* @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.
|
|
197
|
+
* @param {string,number} [size] The size of the drawer in its collapsible axis.
|
|
198
|
+
* @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.
|
|
199
|
+
* @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.
|
|
200
|
+
* @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.
|
|
201
|
+
* @param {boolean,string} [autoClose.focusout] If focus moves outside of the drawer, the drawer will automatically be hidden.
|
|
202
|
+
* @param {string} [autoClose.mouseout] Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
|
|
203
|
+
* @param {number} [autoCloseDelay] When using `mouseout`, this is the delay in milliseconds
|
|
204
|
+
*/
|
|
205
|
+
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 }
|
|
222
206
|
/**
|
|
223
207
|
* An object specifying attributes to assign to the root element of this widget.
|
|
224
208
|
* Set `null` value to attribute to remove it.
|
|
225
|
-
* ...
|
|
226
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-elementAttributes)
|
|
209
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-elementAttributes)
|
|
227
210
|
*/
|
|
228
211
|
elementAttributes? : Record<string, string|null>
|
|
229
212
|
extraData? : any
|
|
@@ -248,22 +231,19 @@ export type BryntumHintProps = {
|
|
|
248
231
|
/**
|
|
249
232
|
* Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
|
|
250
233
|
* 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).
|
|
251
|
-
* ...
|
|
252
|
-
*
|
|
234
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-footer)
|
|
235
|
+
* @property {'top','right','bottom','left','start','end'} dock Where to dock
|
|
236
|
+
* @property {string} html Html to populate the footer with
|
|
237
|
+
* @property {string} cls CSS class to add to the footer
|
|
253
238
|
*/
|
|
254
|
-
footer? :
|
|
255
|
-
dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
|
|
256
|
-
html?: string
|
|
257
|
-
cls?: string
|
|
258
|
-
}|string
|
|
239
|
+
footer? : object|string
|
|
259
240
|
/**
|
|
260
241
|
* DOM element to attach popup.
|
|
261
242
|
*/
|
|
262
243
|
forElement? : HTMLElement
|
|
263
244
|
/**
|
|
264
245
|
* 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`.
|
|
265
|
-
* ...
|
|
266
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-header)
|
|
246
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-header)
|
|
267
247
|
*/
|
|
268
248
|
header? : string|boolean|PanelHeader
|
|
269
249
|
/**
|
|
@@ -278,33 +258,28 @@ export type BryntumHintProps = {
|
|
|
278
258
|
hidden? : boolean
|
|
279
259
|
/**
|
|
280
260
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
281
|
-
* ...
|
|
282
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-hideAnimation)
|
|
261
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-hideAnimation)
|
|
283
262
|
*/
|
|
284
263
|
hideAnimation? : boolean|object
|
|
285
264
|
/**
|
|
286
265
|
* Specify `true` to make this container hide when it has no visible children (Either empty
|
|
287
266
|
* or all children hidden).
|
|
288
|
-
* ...
|
|
289
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-hideWhenEmpty)
|
|
267
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-hideWhenEmpty)
|
|
290
268
|
*/
|
|
291
269
|
hideWhenEmpty? : boolean
|
|
292
270
|
/**
|
|
293
271
|
* Specify as a truthy value to highlight the target element with a bright outline.
|
|
272
|
+
* @property {boolean} [ping] Specify as `true` to have the outline expand repeatedly with a "ping" animation.
|
|
273
|
+
* @property {string} [center] Specify as a CSS color to use as the color of a 20 pixel diameter
|
|
274
|
+
* @property {number,number[]} inflate Arguments to [inflate](https://bryntum.com/products/core/docs/api/Core/helper/util/Rectangle#function-inflate). Specify as a number to inflate the target rect by that many pixels, or as an array of inflate values for each edge.
|
|
294
275
|
*/
|
|
295
|
-
highlightTarget? : boolean|
|
|
296
|
-
ping?: boolean
|
|
297
|
-
center?: string
|
|
298
|
-
inflate?: number|number[]
|
|
299
|
-
}
|
|
276
|
+
highlightTarget? : boolean|object
|
|
300
277
|
/**
|
|
301
278
|
* The HTML to display initially or a function returning the markup (called at widget construction time).
|
|
302
|
-
* ...
|
|
303
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-html)
|
|
279
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-html)
|
|
304
280
|
* @param {Core.widget.Widget} widget The calling Widget
|
|
305
|
-
* @returns {string}
|
|
306
281
|
*/
|
|
307
|
-
html? : string|((widget: Widget) =>
|
|
282
|
+
html? : string|((widget: Widget) => void)|DomConfig|DomConfig[]|VueConfig|ReactJSX
|
|
308
283
|
/**
|
|
309
284
|
* The CSS class(es) to add when HTML content is being applied to this widget.
|
|
310
285
|
*/
|
|
@@ -320,16 +295,14 @@ export type BryntumHintProps = {
|
|
|
320
295
|
id? : string
|
|
321
296
|
/**
|
|
322
297
|
* Determines if the widgets read-only state should be controlled by its parent.
|
|
323
|
-
* ...
|
|
324
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-ignoreParentReadOnly)
|
|
298
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-ignoreParentReadOnly)
|
|
325
299
|
*/
|
|
326
300
|
ignoreParentReadOnly? : boolean
|
|
327
301
|
/**
|
|
328
302
|
* Convenience setting to align input fields of child widgets. By default, the Field input element is
|
|
329
303
|
* placed immediately following the `label`. If you prefer to have all input fields aligned to the
|
|
330
304
|
* right, set this config to `'end'`.
|
|
331
|
-
* ...
|
|
332
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-inputFieldAlign)
|
|
305
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-inputFieldAlign)
|
|
333
306
|
*/
|
|
334
307
|
inputFieldAlign? : 'start'|'end'
|
|
335
308
|
/**
|
|
@@ -347,55 +320,52 @@ export type BryntumHintProps = {
|
|
|
347
320
|
/**
|
|
348
321
|
* An object containing typed child widget config objects or Widgets. May also be specified
|
|
349
322
|
* as an array.
|
|
350
|
-
* ...
|
|
351
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-items)
|
|
323
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-items)
|
|
352
324
|
*/
|
|
353
325
|
items? : Record<string, CoreContainerItemConfig|MenuItemEntry>|(CoreContainerItemConfig|MenuItemEntry|Widget)[]
|
|
354
326
|
/**
|
|
355
327
|
* The mapping of key names to hint actions.
|
|
356
328
|
* The actions are `previous`, `next`, and `stop`.
|
|
357
329
|
* By default, the following key mappings are used:
|
|
358
|
-
* ...
|
|
359
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-keyMap)
|
|
330
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-keyMap)
|
|
360
331
|
*/
|
|
361
332
|
keyMap? : Record<string, 'previous'|'next'|'stop'>
|
|
362
333
|
/**
|
|
363
334
|
* 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/Hint#config-labelPosition)
|
|
335
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-labelPosition)
|
|
366
336
|
*/
|
|
367
337
|
labelPosition? : 'before'|'above'|'align-before'|'auto'|null
|
|
338
|
+
/**
|
|
339
|
+
* Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
|
|
340
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-labelWidth)
|
|
341
|
+
*/
|
|
342
|
+
labelWidth? : number|null
|
|
368
343
|
/**
|
|
369
344
|
* 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/Hint#config-layout)
|
|
345
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-layout)
|
|
372
346
|
*/
|
|
373
347
|
layout? : string|CoreContainerLayoutConfig
|
|
374
348
|
/**
|
|
375
349
|
* 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/Hint#config-layoutStyle)
|
|
350
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-layoutStyle)
|
|
378
351
|
*/
|
|
379
352
|
layoutStyle? : object
|
|
380
353
|
/**
|
|
381
354
|
* 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
355
|
* 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/Hint#config-lazyItems)
|
|
356
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-lazyItems)
|
|
385
357
|
*/
|
|
386
358
|
lazyItems? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|Widget[]
|
|
387
359
|
/**
|
|
388
360
|
* The listener set for this object.
|
|
389
|
-
* ...
|
|
390
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-listeners)
|
|
361
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-listeners)
|
|
391
362
|
*/
|
|
392
363
|
listeners? : HintListeners
|
|
393
364
|
/**
|
|
394
365
|
* A class translations of which are used for translating this entity.
|
|
395
366
|
* This is often used when translations of an item are defined on its container class.
|
|
396
367
|
* For example:
|
|
397
|
-
* ...
|
|
398
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-localeClass)
|
|
368
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-localeClass)
|
|
399
369
|
*/
|
|
400
370
|
localeClass? : typeof Base
|
|
401
371
|
/**
|
|
@@ -407,8 +377,7 @@ export type BryntumHintProps = {
|
|
|
407
377
|
* In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
|
|
408
378
|
* you could use 'localeKey' meta configuration.
|
|
409
379
|
* Example:
|
|
410
|
-
* ...
|
|
411
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-localizableProperties)
|
|
380
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-localizableProperties)
|
|
412
381
|
*/
|
|
413
382
|
localizableProperties? : string[]
|
|
414
383
|
/**
|
|
@@ -442,8 +411,7 @@ export type BryntumHintProps = {
|
|
|
442
411
|
maximized? : boolean
|
|
443
412
|
/**
|
|
444
413
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
445
|
-
* ...
|
|
446
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-maximizeOnMobile)
|
|
414
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-maximizeOnMobile)
|
|
447
415
|
*/
|
|
448
416
|
maximizeOnMobile? : number|string
|
|
449
417
|
/**
|
|
@@ -468,43 +436,36 @@ export type BryntumHintProps = {
|
|
|
468
436
|
/**
|
|
469
437
|
* Optionally show an opaque mask below this Popup when shown.
|
|
470
438
|
* Configure this as `true` to show the mask.
|
|
471
|
-
* ...
|
|
472
|
-
* [
|
|
439
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-modal)
|
|
440
|
+
* @property {boolean} [closeOnMaskTap] Specify as `true` to close when mask is tapped.
|
|
441
|
+
* @property {boolean} [transparent] Specify as `true` to use a transparent mask.
|
|
473
442
|
*/
|
|
474
|
-
modal? : boolean|
|
|
475
|
-
closeOnMaskTap?: boolean
|
|
476
|
-
transparent?: boolean
|
|
477
|
-
}
|
|
443
|
+
modal? : boolean|object
|
|
478
444
|
/**
|
|
479
445
|
* When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
|
|
480
446
|
* is used to monitor this element for size changes caused by either style manipulation, or by CSS
|
|
481
447
|
* layout.
|
|
482
|
-
* ...
|
|
483
|
-
*
|
|
448
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-monitorResize)
|
|
449
|
+
* @property {boolean} immediate Set to `true` to receive resize notifications immediately.
|
|
484
450
|
*/
|
|
485
|
-
monitorResize? : boolean|
|
|
486
|
-
immediate?: boolean
|
|
487
|
-
}
|
|
451
|
+
monitorResize? : boolean|object
|
|
488
452
|
/**
|
|
489
453
|
* 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)
|
|
490
454
|
* config. For example, a specialized [Menu](https://bryntum.com/products/core/docs/api/Core/widget/Menu) subclass may have a `namedItems` default
|
|
491
455
|
* value defined like this:
|
|
492
|
-
* ...
|
|
493
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-namedItems)
|
|
456
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-namedItems)
|
|
494
457
|
*/
|
|
495
458
|
namedItems? : Record<string, CoreContainerItemConfig>
|
|
496
459
|
/**
|
|
497
460
|
* The actions to take when the 'Next' button is clicked.
|
|
498
|
-
* ...
|
|
499
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-nextAction)
|
|
461
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-nextAction)
|
|
500
462
|
*/
|
|
501
463
|
nextAction? : HintActions|HintActions[]
|
|
502
464
|
/**
|
|
503
465
|
* 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
|
|
504
466
|
* not participate in the standard layout of that widget, and must be positioned relatively to that
|
|
505
467
|
* widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
|
|
506
|
-
* ...
|
|
507
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-positioned)
|
|
468
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-positioned)
|
|
508
469
|
*/
|
|
509
470
|
positioned? : boolean
|
|
510
471
|
/**
|
|
@@ -514,65 +475,70 @@ export type BryntumHintProps = {
|
|
|
514
475
|
preventTooltipOnTouch? : boolean
|
|
515
476
|
/**
|
|
516
477
|
* The actions to take when the 'Previous' button is clicked.
|
|
517
|
-
* ...
|
|
518
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-previousAction)
|
|
478
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-previousAction)
|
|
519
479
|
*/
|
|
520
480
|
previousAction? : HintActions|HintActions[]
|
|
521
481
|
/**
|
|
522
482
|
* Whether this widget is read-only. This is only valid if the widget is an input
|
|
523
483
|
* field, <strong>or contains input fields at any depth</strong>.
|
|
524
|
-
* ...
|
|
525
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-readOnly)
|
|
484
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-readOnly)
|
|
526
485
|
*/
|
|
527
486
|
readOnly? : boolean
|
|
528
487
|
/**
|
|
529
488
|
* [Record](https://bryntum.com/products/core/docs/api/Core/data/Model) whose values will be used to populate fields in the container.
|
|
530
|
-
* ...
|
|
531
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-record)
|
|
489
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-record)
|
|
532
490
|
*/
|
|
533
491
|
record? : Model
|
|
534
492
|
relayStoreEvents? : boolean
|
|
535
493
|
/**
|
|
536
494
|
* Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
|
|
537
495
|
* `type`.
|
|
538
|
-
* ...
|
|
539
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-rendition)
|
|
496
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-rendition)
|
|
540
497
|
*/
|
|
541
498
|
rendition? : string|Record<string, string>|null
|
|
542
499
|
/**
|
|
543
500
|
* Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
|
|
544
501
|
* constrain the aspect ratio.
|
|
545
|
-
* ...
|
|
546
|
-
* [
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
502
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-resizable)
|
|
503
|
+
* @property {number} [resizable.minWidth] The minimum width of the element.
|
|
504
|
+
* @property {number} [resizable.maxWidth] The maximum width of the element.
|
|
505
|
+
* @property {number} [resizable.minHeight] The minimum height of the element.
|
|
506
|
+
* @property {number} [resizable.maxHeight] The maximum height of the element
|
|
507
|
+
* @property {object} [resizable.handles] An object controlling which edges/corners are resizable.
|
|
508
|
+
* @property {boolean} [resizable.handles.topStart] Resizable from top-start corner
|
|
509
|
+
* @property {boolean} [resizable.handles.top] Resizable from top edge
|
|
510
|
+
* @property {boolean} [resizable.handles.topEnd] Resizable from top-end corner
|
|
511
|
+
* @property {boolean} [resizable.handles.end] Resizable from end edge
|
|
512
|
+
* @property {boolean} [resizable.handles.bottomEnd] Resizable from bottom-end corner
|
|
513
|
+
* @property {boolean} [resizable.handles.bottom] Resizable from bottom edge
|
|
514
|
+
* @property {boolean} [resizable.handles.bottomStart] Resizable from bottom-start corner
|
|
515
|
+
* @property {boolean} [resizable.handles.start] Resizable from start edge
|
|
516
|
+
*/
|
|
517
|
+
resizable? : boolean|{ minWidth?: number, maxWidth?: number, minHeight?: number, maxHeight?: number, handles?: { topStart?: boolean, top?: boolean, topEnd?: boolean, end?: boolean, bottomEnd?: boolean, bottom?: boolean, bottomStart?: boolean, start?: boolean } }
|
|
555
518
|
/**
|
|
556
519
|
* Configure as `true` to have the component display a translucent ripple when its
|
|
557
520
|
* [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
|
|
558
521
|
* current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
|
|
559
|
-
* ...
|
|
560
|
-
* [
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
522
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-ripple)
|
|
523
|
+
* @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
|
|
524
|
+
* @property {string} [color] A CSS color name or specification.
|
|
525
|
+
* @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
|
|
526
|
+
* @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.
|
|
527
|
+
*/
|
|
528
|
+
ripple? : boolean|object
|
|
529
|
+
/**
|
|
530
|
+
* The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
|
|
531
|
+
* accidentally applying a role which may interfere with screen readers.
|
|
532
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-role)
|
|
533
|
+
*/
|
|
534
|
+
role? : string
|
|
568
535
|
/**
|
|
569
536
|
* 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`
|
|
570
537
|
*/
|
|
571
538
|
rootElement? : ShadowRoot|HTMLElement
|
|
572
539
|
/**
|
|
573
540
|
* This may be configured as `true` to make the widget's element use the `direction:rtl` style.
|
|
574
|
-
* ...
|
|
575
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-rtl)
|
|
541
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-rtl)
|
|
576
542
|
*/
|
|
577
543
|
rtl? : boolean
|
|
578
544
|
/**
|
|
@@ -580,8 +546,7 @@ export type BryntumHintProps = {
|
|
|
580
546
|
* in both axes. May be an object containing boolean `overflowX` and `overflowY` properties which are
|
|
581
547
|
* applied to CSS style properties `overflowX` and `overflowY`. If they are boolean, they are translated to
|
|
582
548
|
* CSS overflow properties thus:
|
|
583
|
-
* ...
|
|
584
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-scrollable)
|
|
549
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-scrollable)
|
|
585
550
|
*/
|
|
586
551
|
scrollable? : boolean|ScrollerConfig|Scroller
|
|
587
552
|
/**
|
|
@@ -591,8 +556,7 @@ export type BryntumHintProps = {
|
|
|
591
556
|
scrollAction? : 'hide'|'realign'|null
|
|
592
557
|
/**
|
|
593
558
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
594
|
-
* ...
|
|
595
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-showAnimation)
|
|
559
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-showAnimation)
|
|
596
560
|
*/
|
|
597
561
|
showAnimation? : boolean|object
|
|
598
562
|
/**
|
|
@@ -610,30 +574,26 @@ export type BryntumHintProps = {
|
|
|
610
574
|
span? : number
|
|
611
575
|
/**
|
|
612
576
|
* This value can be one of the following:
|
|
613
|
-
* ...
|
|
614
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-stateful)
|
|
577
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-stateful)
|
|
615
578
|
*/
|
|
616
579
|
stateful? : boolean|object|string[]
|
|
617
580
|
/**
|
|
618
581
|
* The events that, when fired by this component, should trigger it to save its state by calling
|
|
619
582
|
* [saveState](https://bryntum.com/products/core/docs/api/Core/mixin/State#function-saveState).
|
|
620
|
-
* ...
|
|
621
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-statefulEvents)
|
|
583
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-statefulEvents)
|
|
622
584
|
*/
|
|
623
585
|
statefulEvents? : object|string[]
|
|
624
586
|
/**
|
|
625
587
|
* 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
|
|
626
588
|
* 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)
|
|
627
589
|
* (if explicitly specified) will be used as the `stateId`.
|
|
628
|
-
* ...
|
|
629
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-stateId)
|
|
590
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-stateId)
|
|
630
591
|
*/
|
|
631
592
|
stateId? : string
|
|
632
593
|
/**
|
|
633
594
|
* 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`
|
|
634
595
|
* will be saved using the [default state provider](https://bryntum.com/products/core/docs/api/Core/state/StateProvider#property-instance-static).
|
|
635
|
-
* ...
|
|
636
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-stateProvider)
|
|
596
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-stateProvider)
|
|
637
597
|
*/
|
|
638
598
|
stateProvider? : StateProvider
|
|
639
599
|
/**
|
|
@@ -645,23 +605,20 @@ export type BryntumHintProps = {
|
|
|
645
605
|
* An object containing widgets keyed by name. By default (when no `type` is given), strips are
|
|
646
606
|
* [toolbars](https://bryntum.com/products/core/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
|
|
647
607
|
* the toolbar's [items](https://bryntum.com/products/core/docs/api/Core/widget/Container#config-items).
|
|
648
|
-
* ...
|
|
649
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-strips)
|
|
608
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-strips)
|
|
650
609
|
*/
|
|
651
610
|
strips? : Record<string, CoreContainerItemConfig>
|
|
652
611
|
/**
|
|
653
612
|
* 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
|
|
654
613
|
* [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
|
|
655
614
|
* this widget:
|
|
656
|
-
* ...
|
|
657
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-tab)
|
|
615
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-tab)
|
|
658
616
|
*/
|
|
659
617
|
tab? : boolean|TabConfig
|
|
660
618
|
/**
|
|
661
619
|
* When this container is used as a tab in a TabPanel, these items are added to the
|
|
662
620
|
* [TabBar](https://bryntum.com/products/core/docs/api/Core/widget/TabBar) when this container is the active tab.
|
|
663
|
-
* ...
|
|
664
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-tabBarItems)
|
|
621
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-tabBarItems)
|
|
665
622
|
*/
|
|
666
623
|
tabBarItems? : ToolbarItems[]|Widget[]
|
|
667
624
|
/**
|
|
@@ -676,42 +633,36 @@ export type BryntumHintProps = {
|
|
|
676
633
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/core/docs/api/Core/widget/Toolbar),
|
|
677
634
|
* or array of config objects representing the child items of a Toolbar.
|
|
678
635
|
* This creates a toolbar docked to the top of the panel immediately below the header.
|
|
679
|
-
* ...
|
|
680
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-tbar)
|
|
636
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-tbar)
|
|
681
637
|
*/
|
|
682
638
|
tbar? : (CoreContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
683
639
|
/**
|
|
684
640
|
* Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
|
|
685
|
-
* ...
|
|
686
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-textAlign)
|
|
641
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-textAlign)
|
|
687
642
|
*/
|
|
688
643
|
textAlign? : 'left'|'center'|'right'|'start'|'end'
|
|
689
644
|
/**
|
|
690
645
|
* Specify `true` for a container used to show text markup. It will apply the CSS class `b-text-content`
|
|
691
646
|
* which specifies a default max-width that makes long text more readable.
|
|
692
|
-
* ...
|
|
693
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-textContent)
|
|
647
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-textContent)
|
|
694
648
|
*/
|
|
695
649
|
textContent? : boolean
|
|
696
650
|
/**
|
|
697
651
|
* A title to display in the header or owning TabPanel. Causes creation and docking of a header
|
|
698
652
|
* to the top if no header is configured.
|
|
699
|
-
* ...
|
|
700
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-title)
|
|
653
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-title)
|
|
701
654
|
*/
|
|
702
655
|
title? : string
|
|
703
656
|
/**
|
|
704
657
|
* 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
|
|
705
658
|
* property name is the reference by which an instantiated tool may be retrieved from the live
|
|
706
659
|
* `[tools](https://bryntum.com/products/core/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
|
|
707
|
-
* ...
|
|
708
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-tools)
|
|
660
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-tools)
|
|
709
661
|
*/
|
|
710
662
|
tools? : Record<string, ToolConfig>|null
|
|
711
663
|
/**
|
|
712
664
|
* Tooltip for the widget, either as a string or as a Tooltip config object.
|
|
713
|
-
* ...
|
|
714
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-tooltip)
|
|
665
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-tooltip)
|
|
715
666
|
*/
|
|
716
667
|
tooltip? : string|TooltipConfig|null
|
|
717
668
|
/**
|
|
@@ -724,8 +675,7 @@ export type BryntumHintProps = {
|
|
|
724
675
|
* Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
|
|
725
676
|
* as a space separated string, an array of strings, or as an object in which property names with truthy
|
|
726
677
|
* values are used as the class names.
|
|
727
|
-
* ...
|
|
728
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-ui)
|
|
678
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-ui)
|
|
729
679
|
*/
|
|
730
680
|
ui? : 'plain'|'toolbar'|string|object
|
|
731
681
|
/**
|
|
@@ -741,14 +691,12 @@ export type BryntumHintProps = {
|
|
|
741
691
|
width? : string|number
|
|
742
692
|
/**
|
|
743
693
|
* The x position for the widget.
|
|
744
|
-
* ...
|
|
745
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-x)
|
|
694
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-x)
|
|
746
695
|
*/
|
|
747
696
|
x? : number
|
|
748
697
|
/**
|
|
749
698
|
* The y position for the widget.
|
|
750
|
-
* ...
|
|
751
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-y)
|
|
699
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-y)
|
|
752
700
|
*/
|
|
753
701
|
y? : number
|
|
754
702
|
|
|
@@ -800,8 +748,7 @@ export type BryntumHintProps = {
|
|
|
800
748
|
onBeforeStateSave? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
|
|
801
749
|
/**
|
|
802
750
|
* Fires when any other event is fired from the object.
|
|
803
|
-
* ...
|
|
804
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#event-catchAll)
|
|
751
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#event-catchAll)
|
|
805
752
|
* @param {object} event Event object
|
|
806
753
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
807
754
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -871,8 +818,7 @@ export type BryntumHintProps = {
|
|
|
871
818
|
/**
|
|
872
819
|
* Triggered when a widget which had been in a non-visible state for any reason
|
|
873
820
|
* achieves visibility.
|
|
874
|
-
* ...
|
|
875
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#event-paint)
|
|
821
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#event-paint)
|
|
876
822
|
* @param {object} event Event object
|
|
877
823
|
* @param {Core.widget.Widget} event.source The widget being painted.
|
|
878
824
|
* @param {boolean} event.firstPaint `true` if this is the first paint.
|
|
@@ -980,6 +926,7 @@ export class BryntumHint extends React.Component<BryntumHintProps> {
|
|
|
980
926
|
'previousAction',
|
|
981
927
|
'relayStoreEvents',
|
|
982
928
|
'ripple',
|
|
929
|
+
'role',
|
|
983
930
|
'rootElement',
|
|
984
931
|
'scrollAction',
|
|
985
932
|
'showAnimation',
|
|
@@ -1026,6 +973,7 @@ export class BryntumHint extends React.Component<BryntumHintProps> {
|
|
|
1026
973
|
'items',
|
|
1027
974
|
'keyMap',
|
|
1028
975
|
'labelPosition',
|
|
976
|
+
'labelWidth',
|
|
1029
977
|
'layout',
|
|
1030
978
|
'layoutStyle',
|
|
1031
979
|
'margin',
|
|
@@ -1074,11 +1022,6 @@ export class BryntumHint extends React.Component<BryntumHintProps> {
|
|
|
1074
1022
|
];
|
|
1075
1023
|
|
|
1076
1024
|
static propertyNames = [
|
|
1077
|
-
'anchorSize',
|
|
1078
|
-
'focusVisible',
|
|
1079
|
-
'hasChanges',
|
|
1080
|
-
'isSettingValues',
|
|
1081
|
-
'isValid',
|
|
1082
1025
|
'parent',
|
|
1083
1026
|
'state',
|
|
1084
1027
|
'values'
|