@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/BryntumPanel.tsx
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
5
5
|
import React, { RefObject } from 'react';
|
|
6
|
-
import { AlignSpec, Base, Color, Container, CoreContainerItemConfig, CoreContainerLayoutConfig, DomConfig, KeyMapConfig, Layout, MaskConfig, MenuItemConfig, MenuItemEntry, Model, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, PanelListeners, Rectangle, Scroller, ScrollerConfig, StateProvider, TabConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
|
|
6
|
+
import { AlignSpec, Base, Color, Container, CoreContainerItemConfig, CoreContainerLayoutConfig, DomConfig, KeyMapConfig, Layout, MaskConfig, MenuItemConfig, MenuItemEntry, Model, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, PanelListeners, 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 BryntumPanelProps = {
|
|
|
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/Panel#config-adopt)
|
|
15
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#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/Panel#config-align)
|
|
20
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-align)
|
|
23
21
|
*/
|
|
24
22
|
align? : AlignSpec|string
|
|
25
23
|
/**
|
|
@@ -41,15 +39,13 @@ export type BryntumPanelProps = {
|
|
|
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/Panel#config-ariaDescription)
|
|
42
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#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/Panel#config-ariaLabel)
|
|
48
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-ariaLabel)
|
|
53
49
|
*/
|
|
54
50
|
ariaLabel? : string
|
|
55
51
|
/**
|
|
@@ -59,14 +55,12 @@ export type BryntumPanelProps = {
|
|
|
59
55
|
/**
|
|
60
56
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/core/docs/api/Core/widget/Toolbar),
|
|
61
57
|
* 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).
|
|
62
|
-
* ...
|
|
63
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-bbar)
|
|
58
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-bbar)
|
|
64
59
|
*/
|
|
65
60
|
bbar? : (CoreContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
66
61
|
/**
|
|
67
62
|
* Custom CSS classes to add to the panel's body element.
|
|
68
|
-
* ...
|
|
69
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-bodyCls)
|
|
63
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-bodyCls)
|
|
70
64
|
*/
|
|
71
65
|
bodyCls? : string|object
|
|
72
66
|
/**
|
|
@@ -76,21 +70,18 @@ export type BryntumPanelProps = {
|
|
|
76
70
|
/**
|
|
77
71
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
78
72
|
* hierarchy when triggered.
|
|
79
|
-
* ...
|
|
80
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-bubbleEvents)
|
|
73
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-bubbleEvents)
|
|
81
74
|
*/
|
|
82
75
|
bubbleEvents? : object
|
|
83
76
|
/**
|
|
84
77
|
* Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
85
|
-
* ...
|
|
86
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-callOnFunctions)
|
|
78
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-callOnFunctions)
|
|
87
79
|
*/
|
|
88
80
|
callOnFunctions? : boolean
|
|
89
81
|
/**
|
|
90
82
|
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
91
83
|
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
92
|
-
* ...
|
|
93
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-catchEventHandlerExceptions)
|
|
84
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-catchEventHandlerExceptions)
|
|
94
85
|
*/
|
|
95
86
|
catchEventHandlerExceptions? : boolean
|
|
96
87
|
/**
|
|
@@ -102,8 +93,7 @@ export type BryntumPanelProps = {
|
|
|
102
93
|
* Custom CSS classes to add to element.
|
|
103
94
|
* May be specified as a space separated string, or as an object in which property names
|
|
104
95
|
* with truthy values are used as the class names:
|
|
105
|
-
* ...
|
|
106
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-cls)
|
|
96
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-cls)
|
|
107
97
|
*/
|
|
108
98
|
cls? : string|object
|
|
109
99
|
/**
|
|
@@ -113,15 +103,13 @@ export type BryntumPanelProps = {
|
|
|
113
103
|
collapsed? : boolean
|
|
114
104
|
/**
|
|
115
105
|
* This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-collapsed).
|
|
116
|
-
* ...
|
|
117
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-collapsible)
|
|
106
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-collapsible)
|
|
118
107
|
*/
|
|
119
108
|
collapsible? : boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
|
|
120
109
|
/**
|
|
121
110
|
* Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
|
|
122
111
|
* `style` block.
|
|
123
|
-
* ...
|
|
124
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-color)
|
|
112
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-color)
|
|
125
113
|
*/
|
|
126
114
|
color? : Color
|
|
127
115
|
/**
|
|
@@ -145,8 +133,7 @@ export type BryntumPanelProps = {
|
|
|
145
133
|
* Custom CSS classes to add to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
|
|
146
134
|
* May be specified as a space separated string, or as an object in which property names
|
|
147
135
|
* with truthy values are used as the class names:
|
|
148
|
-
* ...
|
|
149
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-contentElementCls)
|
|
136
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-contentElementCls)
|
|
150
137
|
*/
|
|
151
138
|
contentElementCls? : string|object
|
|
152
139
|
/**
|
|
@@ -166,8 +153,7 @@ export type BryntumPanelProps = {
|
|
|
166
153
|
/**
|
|
167
154
|
* A [query](https://bryntum.com/products/core/docs/api/Core/widget/Container#function-query) selector function which can identify the descendant widget to which
|
|
168
155
|
* focus should be directed by default.
|
|
169
|
-
* ...
|
|
170
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-defaultFocus)
|
|
156
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-defaultFocus)
|
|
171
157
|
* @param {Core.widget.Widget} widget Widget passed to method
|
|
172
158
|
* @returns {boolean} truthy value if widget is the default one
|
|
173
159
|
*/
|
|
@@ -177,16 +163,15 @@ export type BryntumPanelProps = {
|
|
|
177
163
|
*/
|
|
178
164
|
defaults? : CoreContainerItemConfig
|
|
179
165
|
/**
|
|
180
|
-
* Check for CSS compatibility issues
|
|
181
|
-
*
|
|
182
|
-
* [
|
|
166
|
+
* Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
|
|
167
|
+
* checks:
|
|
168
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-detectCSSCompatibilityIssues)
|
|
183
169
|
*/
|
|
184
170
|
detectCSSCompatibilityIssues? : boolean
|
|
185
171
|
/**
|
|
186
172
|
* Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
|
|
187
173
|
* cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
|
|
188
|
-
* ...
|
|
189
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-disabled)
|
|
174
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-disabled)
|
|
190
175
|
*/
|
|
191
176
|
disabled? : boolean|'inert'
|
|
192
177
|
/**
|
|
@@ -194,39 +179,34 @@ export type BryntumPanelProps = {
|
|
|
194
179
|
* [strips collection](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
|
|
195
180
|
* `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
|
|
196
181
|
* body. Such widgets are called "edge strips".
|
|
197
|
-
* ...
|
|
198
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-dock)
|
|
182
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-dock)
|
|
199
183
|
*/
|
|
200
184
|
dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
201
185
|
/**
|
|
202
186
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
203
187
|
* Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
|
|
204
188
|
* property which controls when a drag should start.
|
|
205
|
-
* ...
|
|
206
|
-
*
|
|
189
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-draggable)
|
|
190
|
+
* @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
|
|
207
191
|
*/
|
|
208
|
-
draggable? : boolean|
|
|
209
|
-
handleSelector?: string
|
|
210
|
-
}
|
|
192
|
+
draggable? : boolean|object
|
|
211
193
|
/**
|
|
212
194
|
* Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
|
|
213
|
-
* ...
|
|
214
|
-
* [
|
|
215
|
-
* @param {
|
|
216
|
-
* @param {
|
|
217
|
-
* @param {boolean}
|
|
218
|
-
* @param {boolean,
|
|
219
|
-
* @param {boolean,string} autoClose.
|
|
220
|
-
* @param {
|
|
221
|
-
* @param {
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
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/Panel#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 }
|
|
225
206
|
/**
|
|
226
207
|
* An object specifying attributes to assign to the root element of this widget.
|
|
227
208
|
* Set `null` value to attribute to remove it.
|
|
228
|
-
* ...
|
|
229
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-elementAttributes)
|
|
209
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-elementAttributes)
|
|
230
210
|
*/
|
|
231
211
|
elementAttributes? : Record<string, string|null>
|
|
232
212
|
extraData? : any
|
|
@@ -246,18 +226,15 @@ export type BryntumPanelProps = {
|
|
|
246
226
|
/**
|
|
247
227
|
* Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
|
|
248
228
|
* 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).
|
|
249
|
-
* ...
|
|
250
|
-
*
|
|
229
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-footer)
|
|
230
|
+
* @property {'top','right','bottom','left','start','end'} dock Where to dock
|
|
231
|
+
* @property {string} html Html to populate the footer with
|
|
232
|
+
* @property {string} cls CSS class to add to the footer
|
|
251
233
|
*/
|
|
252
|
-
footer? :
|
|
253
|
-
dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
|
|
254
|
-
html?: string
|
|
255
|
-
cls?: string
|
|
256
|
-
}|string
|
|
234
|
+
footer? : object|string
|
|
257
235
|
/**
|
|
258
236
|
* 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`.
|
|
259
|
-
* ...
|
|
260
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-header)
|
|
237
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-header)
|
|
261
238
|
*/
|
|
262
239
|
header? : string|boolean|PanelHeader
|
|
263
240
|
/**
|
|
@@ -272,25 +249,21 @@ export type BryntumPanelProps = {
|
|
|
272
249
|
hidden? : boolean
|
|
273
250
|
/**
|
|
274
251
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
275
|
-
* ...
|
|
276
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-hideAnimation)
|
|
252
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-hideAnimation)
|
|
277
253
|
*/
|
|
278
254
|
hideAnimation? : boolean|object
|
|
279
255
|
/**
|
|
280
256
|
* Specify `true` to make this container hide when it has no visible children (Either empty
|
|
281
257
|
* or all children hidden).
|
|
282
|
-
* ...
|
|
283
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-hideWhenEmpty)
|
|
258
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-hideWhenEmpty)
|
|
284
259
|
*/
|
|
285
260
|
hideWhenEmpty? : boolean
|
|
286
261
|
/**
|
|
287
262
|
* The HTML to display initially or a function returning the markup (called at widget construction time).
|
|
288
|
-
* ...
|
|
289
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-html)
|
|
263
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-html)
|
|
290
264
|
* @param {Core.widget.Widget} widget The calling Widget
|
|
291
|
-
* @returns {string}
|
|
292
265
|
*/
|
|
293
|
-
html? : string|((widget: Widget) =>
|
|
266
|
+
html? : string|((widget: Widget) => void)|DomConfig|DomConfig[]|VueConfig|ReactJSX
|
|
294
267
|
/**
|
|
295
268
|
* The CSS class(es) to add when HTML content is being applied to this widget.
|
|
296
269
|
*/
|
|
@@ -306,16 +279,14 @@ export type BryntumPanelProps = {
|
|
|
306
279
|
id? : string
|
|
307
280
|
/**
|
|
308
281
|
* Determines if the widgets read-only state should be controlled by its parent.
|
|
309
|
-
* ...
|
|
310
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-ignoreParentReadOnly)
|
|
282
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-ignoreParentReadOnly)
|
|
311
283
|
*/
|
|
312
284
|
ignoreParentReadOnly? : boolean
|
|
313
285
|
/**
|
|
314
286
|
* Convenience setting to align input fields of child widgets. By default, the Field input element is
|
|
315
287
|
* placed immediately following the `label`. If you prefer to have all input fields aligned to the
|
|
316
288
|
* right, set this config to `'end'`.
|
|
317
|
-
* ...
|
|
318
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-inputFieldAlign)
|
|
289
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-inputFieldAlign)
|
|
319
290
|
*/
|
|
320
291
|
inputFieldAlign? : 'start'|'end'
|
|
321
292
|
/**
|
|
@@ -333,55 +304,52 @@ export type BryntumPanelProps = {
|
|
|
333
304
|
/**
|
|
334
305
|
* An object containing typed child widget config objects or Widgets. May also be specified
|
|
335
306
|
* as an array.
|
|
336
|
-
* ...
|
|
337
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-items)
|
|
307
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-items)
|
|
338
308
|
*/
|
|
339
309
|
items? : Record<string, CoreContainerItemConfig|MenuItemEntry>|(CoreContainerItemConfig|MenuItemEntry|Widget)[]
|
|
340
310
|
/**
|
|
341
311
|
* An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
|
|
342
312
|
* and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
|
|
343
313
|
* are the name of the instance method to call when the keystroke is received.
|
|
344
|
-
* ...
|
|
345
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-keyMap)
|
|
314
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-keyMap)
|
|
346
315
|
*/
|
|
347
316
|
keyMap? : Record<string, KeyMapConfig>
|
|
348
317
|
/**
|
|
349
318
|
* Convenience setting to use same label placement on all child widgets.
|
|
350
|
-
* ...
|
|
351
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-labelPosition)
|
|
319
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-labelPosition)
|
|
352
320
|
*/
|
|
353
321
|
labelPosition? : 'before'|'above'|'align-before'|'auto'|null
|
|
322
|
+
/**
|
|
323
|
+
* Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
|
|
324
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-labelWidth)
|
|
325
|
+
*/
|
|
326
|
+
labelWidth? : number|null
|
|
354
327
|
/**
|
|
355
328
|
* The short name of a helper class which manages rendering and styling of child items.
|
|
356
|
-
* ...
|
|
357
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-layout)
|
|
329
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-layout)
|
|
358
330
|
*/
|
|
359
331
|
layout? : string|CoreContainerLayoutConfig
|
|
360
332
|
/**
|
|
361
333
|
* The CSS style properties to apply to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
|
|
362
|
-
* ...
|
|
363
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-layoutStyle)
|
|
334
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-layoutStyle)
|
|
364
335
|
*/
|
|
365
336
|
layoutStyle? : object
|
|
366
337
|
/**
|
|
367
338
|
* 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
|
|
368
339
|
* instances only when this Container is rendered, rather than eagerly at construct time.
|
|
369
|
-
* ...
|
|
370
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-lazyItems)
|
|
340
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-lazyItems)
|
|
371
341
|
*/
|
|
372
342
|
lazyItems? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|Widget[]
|
|
373
343
|
/**
|
|
374
344
|
* The listener set for this object.
|
|
375
|
-
* ...
|
|
376
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-listeners)
|
|
345
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-listeners)
|
|
377
346
|
*/
|
|
378
347
|
listeners? : PanelListeners
|
|
379
348
|
/**
|
|
380
349
|
* A class translations of which are used for translating this entity.
|
|
381
350
|
* This is often used when translations of an item are defined on its container class.
|
|
382
351
|
* For example:
|
|
383
|
-
* ...
|
|
384
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-localeClass)
|
|
352
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-localeClass)
|
|
385
353
|
*/
|
|
386
354
|
localeClass? : typeof Base
|
|
387
355
|
/**
|
|
@@ -393,8 +361,7 @@ export type BryntumPanelProps = {
|
|
|
393
361
|
* In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
|
|
394
362
|
* you could use 'localeKey' meta configuration.
|
|
395
363
|
* Example:
|
|
396
|
-
* ...
|
|
397
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-localizableProperties)
|
|
364
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-localizableProperties)
|
|
398
365
|
*/
|
|
399
366
|
localizableProperties? : string[]
|
|
400
367
|
/**
|
|
@@ -420,8 +387,7 @@ export type BryntumPanelProps = {
|
|
|
420
387
|
maxHeight? : string|number
|
|
421
388
|
/**
|
|
422
389
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
423
|
-
* ...
|
|
424
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-maximizeOnMobile)
|
|
390
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-maximizeOnMobile)
|
|
425
391
|
*/
|
|
426
392
|
maximizeOnMobile? : number|string
|
|
427
393
|
/**
|
|
@@ -443,26 +409,22 @@ export type BryntumPanelProps = {
|
|
|
443
409
|
* When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
|
|
444
410
|
* is used to monitor this element for size changes caused by either style manipulation, or by CSS
|
|
445
411
|
* layout.
|
|
446
|
-
* ...
|
|
447
|
-
*
|
|
412
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-monitorResize)
|
|
413
|
+
* @property {boolean} immediate Set to `true` to receive resize notifications immediately.
|
|
448
414
|
*/
|
|
449
|
-
monitorResize? : boolean|
|
|
450
|
-
immediate?: boolean
|
|
451
|
-
}
|
|
415
|
+
monitorResize? : boolean|object
|
|
452
416
|
/**
|
|
453
417
|
* 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)
|
|
454
418
|
* config. For example, a specialized [Menu](https://bryntum.com/products/core/docs/api/Core/widget/Menu) subclass may have a `namedItems` default
|
|
455
419
|
* value defined like this:
|
|
456
|
-
* ...
|
|
457
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-namedItems)
|
|
420
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-namedItems)
|
|
458
421
|
*/
|
|
459
422
|
namedItems? : Record<string, CoreContainerItemConfig>
|
|
460
423
|
/**
|
|
461
424
|
* 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
|
|
462
425
|
* not participate in the standard layout of that widget, and must be positioned relatively to that
|
|
463
426
|
* widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
|
|
464
|
-
* ...
|
|
465
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-positioned)
|
|
427
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-positioned)
|
|
466
428
|
*/
|
|
467
429
|
positioned? : boolean
|
|
468
430
|
/**
|
|
@@ -473,45 +435,45 @@ export type BryntumPanelProps = {
|
|
|
473
435
|
/**
|
|
474
436
|
* Whether this widget is read-only. This is only valid if the widget is an input
|
|
475
437
|
* field, <strong>or contains input fields at any depth</strong>.
|
|
476
|
-
* ...
|
|
477
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-readOnly)
|
|
438
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-readOnly)
|
|
478
439
|
*/
|
|
479
440
|
readOnly? : boolean
|
|
480
441
|
/**
|
|
481
442
|
* [Record](https://bryntum.com/products/core/docs/api/Core/data/Model) whose values will be used to populate fields in the container.
|
|
482
|
-
* ...
|
|
483
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-record)
|
|
443
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-record)
|
|
484
444
|
*/
|
|
485
445
|
record? : Model
|
|
486
446
|
relayStoreEvents? : boolean
|
|
487
447
|
/**
|
|
488
448
|
* Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
|
|
489
449
|
* `type`.
|
|
490
|
-
* ...
|
|
491
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-rendition)
|
|
450
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-rendition)
|
|
492
451
|
*/
|
|
493
452
|
rendition? : string|Record<string, string>|null
|
|
494
453
|
/**
|
|
495
454
|
* Configure as `true` to have the component display a translucent ripple when its
|
|
496
455
|
* [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
|
|
497
456
|
* current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
|
|
498
|
-
* ...
|
|
499
|
-
* [
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
457
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-ripple)
|
|
458
|
+
* @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
|
|
459
|
+
* @property {string} [color] A CSS color name or specification.
|
|
460
|
+
* @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
|
|
461
|
+
* @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.
|
|
462
|
+
*/
|
|
463
|
+
ripple? : boolean|object
|
|
464
|
+
/**
|
|
465
|
+
* The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
|
|
466
|
+
* accidentally applying a role which may interfere with screen readers.
|
|
467
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-role)
|
|
468
|
+
*/
|
|
469
|
+
role? : string
|
|
507
470
|
/**
|
|
508
471
|
* 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`
|
|
509
472
|
*/
|
|
510
473
|
rootElement? : ShadowRoot|HTMLElement
|
|
511
474
|
/**
|
|
512
475
|
* This may be configured as `true` to make the widget's element use the `direction:rtl` style.
|
|
513
|
-
* ...
|
|
514
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-rtl)
|
|
476
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-rtl)
|
|
515
477
|
*/
|
|
516
478
|
rtl? : boolean
|
|
517
479
|
/**
|
|
@@ -519,8 +481,7 @@ export type BryntumPanelProps = {
|
|
|
519
481
|
* in both axes. May be an object containing boolean `overflowX` and `overflowY` properties which are
|
|
520
482
|
* applied to CSS style properties `overflowX` and `overflowY`. If they are boolean, they are translated to
|
|
521
483
|
* CSS overflow properties thus:
|
|
522
|
-
* ...
|
|
523
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-scrollable)
|
|
484
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-scrollable)
|
|
524
485
|
*/
|
|
525
486
|
scrollable? : boolean|ScrollerConfig|Scroller
|
|
526
487
|
/**
|
|
@@ -530,8 +491,7 @@ export type BryntumPanelProps = {
|
|
|
530
491
|
scrollAction? : 'hide'|'realign'|null
|
|
531
492
|
/**
|
|
532
493
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
533
|
-
* ...
|
|
534
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-showAnimation)
|
|
494
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-showAnimation)
|
|
535
495
|
*/
|
|
536
496
|
showAnimation? : boolean|object
|
|
537
497
|
/**
|
|
@@ -544,30 +504,26 @@ export type BryntumPanelProps = {
|
|
|
544
504
|
span? : number
|
|
545
505
|
/**
|
|
546
506
|
* This value can be one of the following:
|
|
547
|
-
* ...
|
|
548
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-stateful)
|
|
507
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-stateful)
|
|
549
508
|
*/
|
|
550
509
|
stateful? : boolean|object|string[]
|
|
551
510
|
/**
|
|
552
511
|
* The events that, when fired by this component, should trigger it to save its state by calling
|
|
553
512
|
* [saveState](https://bryntum.com/products/core/docs/api/Core/mixin/State#function-saveState).
|
|
554
|
-
* ...
|
|
555
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-statefulEvents)
|
|
513
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-statefulEvents)
|
|
556
514
|
*/
|
|
557
515
|
statefulEvents? : object|string[]
|
|
558
516
|
/**
|
|
559
517
|
* 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
|
|
560
518
|
* 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)
|
|
561
519
|
* (if explicitly specified) will be used as the `stateId`.
|
|
562
|
-
* ...
|
|
563
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-stateId)
|
|
520
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-stateId)
|
|
564
521
|
*/
|
|
565
522
|
stateId? : string
|
|
566
523
|
/**
|
|
567
524
|
* 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`
|
|
568
525
|
* will be saved using the [default state provider](https://bryntum.com/products/core/docs/api/Core/state/StateProvider#property-instance-static).
|
|
569
|
-
* ...
|
|
570
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-stateProvider)
|
|
526
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-stateProvider)
|
|
571
527
|
*/
|
|
572
528
|
stateProvider? : StateProvider
|
|
573
529
|
/**
|
|
@@ -579,23 +535,20 @@ export type BryntumPanelProps = {
|
|
|
579
535
|
* An object containing widgets keyed by name. By default (when no `type` is given), strips are
|
|
580
536
|
* [toolbars](https://bryntum.com/products/core/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
|
|
581
537
|
* the toolbar's [items](https://bryntum.com/products/core/docs/api/Core/widget/Container#config-items).
|
|
582
|
-
* ...
|
|
583
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-strips)
|
|
538
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-strips)
|
|
584
539
|
*/
|
|
585
540
|
strips? : Record<string, CoreContainerItemConfig>
|
|
586
541
|
/**
|
|
587
542
|
* 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
|
|
588
543
|
* [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
|
|
589
544
|
* this widget:
|
|
590
|
-
* ...
|
|
591
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-tab)
|
|
545
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-tab)
|
|
592
546
|
*/
|
|
593
547
|
tab? : boolean|TabConfig
|
|
594
548
|
/**
|
|
595
549
|
* When this container is used as a tab in a TabPanel, these items are added to the
|
|
596
550
|
* [TabBar](https://bryntum.com/products/core/docs/api/Core/widget/TabBar) when this container is the active tab.
|
|
597
|
-
* ...
|
|
598
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-tabBarItems)
|
|
551
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-tabBarItems)
|
|
599
552
|
*/
|
|
600
553
|
tabBarItems? : ToolbarItems[]|Widget[]
|
|
601
554
|
/**
|
|
@@ -606,42 +559,36 @@ export type BryntumPanelProps = {
|
|
|
606
559
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/core/docs/api/Core/widget/Toolbar),
|
|
607
560
|
* or array of config objects representing the child items of a Toolbar.
|
|
608
561
|
* This creates a toolbar docked to the top of the panel immediately below the header.
|
|
609
|
-
* ...
|
|
610
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-tbar)
|
|
562
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-tbar)
|
|
611
563
|
*/
|
|
612
564
|
tbar? : (CoreContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
613
565
|
/**
|
|
614
566
|
* Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
|
|
615
|
-
* ...
|
|
616
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-textAlign)
|
|
567
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-textAlign)
|
|
617
568
|
*/
|
|
618
569
|
textAlign? : 'left'|'center'|'right'|'start'|'end'
|
|
619
570
|
/**
|
|
620
571
|
* Specify `true` for a container used to show text markup. It will apply the CSS class `b-text-content`
|
|
621
572
|
* which specifies a default max-width that makes long text more readable.
|
|
622
|
-
* ...
|
|
623
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-textContent)
|
|
573
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-textContent)
|
|
624
574
|
*/
|
|
625
575
|
textContent? : boolean
|
|
626
576
|
/**
|
|
627
577
|
* A title to display in the header or owning TabPanel. Causes creation and docking of a header
|
|
628
578
|
* to the top if no header is configured.
|
|
629
|
-
* ...
|
|
630
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-title)
|
|
579
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-title)
|
|
631
580
|
*/
|
|
632
581
|
title? : string
|
|
633
582
|
/**
|
|
634
583
|
* 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
|
|
635
584
|
* property name is the reference by which an instantiated tool may be retrieved from the live
|
|
636
585
|
* `[tools](https://bryntum.com/products/core/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
|
|
637
|
-
* ...
|
|
638
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-tools)
|
|
586
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-tools)
|
|
639
587
|
*/
|
|
640
588
|
tools? : Record<string, ToolConfig>|null
|
|
641
589
|
/**
|
|
642
590
|
* Tooltip for the widget, either as a string or as a Tooltip config object.
|
|
643
|
-
* ...
|
|
644
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-tooltip)
|
|
591
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-tooltip)
|
|
645
592
|
*/
|
|
646
593
|
tooltip? : string|TooltipConfig|null
|
|
647
594
|
/**
|
|
@@ -655,8 +602,7 @@ export type BryntumPanelProps = {
|
|
|
655
602
|
* Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
|
|
656
603
|
* as a space separated string, an array of strings, or as an object in which property names with truthy
|
|
657
604
|
* values are used as the class names.
|
|
658
|
-
* ...
|
|
659
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-ui)
|
|
605
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-ui)
|
|
660
606
|
*/
|
|
661
607
|
ui? : 'plain'|'toolbar'|string|object
|
|
662
608
|
/**
|
|
@@ -672,14 +618,12 @@ export type BryntumPanelProps = {
|
|
|
672
618
|
width? : string|number
|
|
673
619
|
/**
|
|
674
620
|
* The x position for the widget.
|
|
675
|
-
* ...
|
|
676
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-x)
|
|
621
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-x)
|
|
677
622
|
*/
|
|
678
623
|
x? : number
|
|
679
624
|
/**
|
|
680
625
|
* The y position for the widget.
|
|
681
|
-
* ...
|
|
682
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-y)
|
|
626
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-y)
|
|
683
627
|
*/
|
|
684
628
|
y? : number
|
|
685
629
|
|
|
@@ -724,8 +668,7 @@ export type BryntumPanelProps = {
|
|
|
724
668
|
onBeforeStateSave? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
|
|
725
669
|
/**
|
|
726
670
|
* Fires when any other event is fired from the object.
|
|
727
|
-
* ...
|
|
728
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#event-catchAll)
|
|
671
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#event-catchAll)
|
|
729
672
|
* @param {object} event Event object
|
|
730
673
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
731
674
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -795,8 +738,7 @@ export type BryntumPanelProps = {
|
|
|
795
738
|
/**
|
|
796
739
|
* Triggered when a widget which had been in a non-visible state for any reason
|
|
797
740
|
* achieves visibility.
|
|
798
|
-
* ...
|
|
799
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#event-paint)
|
|
741
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#event-paint)
|
|
800
742
|
* @param {object} event Event object
|
|
801
743
|
* @param {Core.widget.Widget} event.source The widget being painted.
|
|
802
744
|
* @param {boolean} event.firstPaint `true` if this is the first paint.
|
|
@@ -895,6 +837,7 @@ export class BryntumPanel extends React.Component<BryntumPanelProps> {
|
|
|
895
837
|
'preventTooltipOnTouch',
|
|
896
838
|
'relayStoreEvents',
|
|
897
839
|
'ripple',
|
|
840
|
+
'role',
|
|
898
841
|
'rootElement',
|
|
899
842
|
'scrollAction',
|
|
900
843
|
'showAnimation',
|
|
@@ -939,6 +882,7 @@ export class BryntumPanel extends React.Component<BryntumPanelProps> {
|
|
|
939
882
|
'items',
|
|
940
883
|
'keyMap',
|
|
941
884
|
'labelPosition',
|
|
885
|
+
'labelWidth',
|
|
942
886
|
'layout',
|
|
943
887
|
'layoutStyle',
|
|
944
888
|
'margin',
|
|
@@ -984,11 +928,6 @@ export class BryntumPanel extends React.Component<BryntumPanelProps> {
|
|
|
984
928
|
];
|
|
985
929
|
|
|
986
930
|
static propertyNames = [
|
|
987
|
-
'anchorSize',
|
|
988
|
-
'focusVisible',
|
|
989
|
-
'hasChanges',
|
|
990
|
-
'isSettingValues',
|
|
991
|
-
'isValid',
|
|
992
931
|
'parent',
|
|
993
932
|
'state',
|
|
994
933
|
'values'
|