@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/BryntumMenu.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, Menu, MenuItem, MenuItemConfig, MenuItemEntry, MenuListeners, Model, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, Popup, Rectangle, 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, Menu, MenuItem, MenuItemConfig, MenuItemEntry, MenuListeners, Model, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, Popup, ReactJSX, Rectangle, 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 BryntumMenuProps = {
|
|
|
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/Menu#config-adopt)
|
|
15
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#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/Menu#config-align)
|
|
20
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-align)
|
|
23
21
|
*/
|
|
24
22
|
align? : AlignSpec|string
|
|
25
23
|
/**
|
|
@@ -41,22 +39,19 @@ export type BryntumMenuProps = {
|
|
|
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/Menu#config-ariaDescription)
|
|
42
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#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/Menu#config-ariaLabel)
|
|
48
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-ariaLabel)
|
|
53
49
|
*/
|
|
54
50
|
ariaLabel? : string
|
|
55
51
|
/**
|
|
56
52
|
* By default, a Popup is transient, and will [close](https://bryntum.com/products/core/docs/api/Core/widget/Popup#function-close) when the user clicks or
|
|
57
53
|
* taps outside its owned widgets and when focus moves outside its owned widgets.
|
|
58
|
-
* ...
|
|
59
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-autoClose)
|
|
54
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-autoClose)
|
|
60
55
|
*/
|
|
61
56
|
autoClose? : boolean
|
|
62
57
|
/**
|
|
@@ -71,14 +66,12 @@ export type BryntumMenuProps = {
|
|
|
71
66
|
/**
|
|
72
67
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/core/docs/api/Core/widget/Toolbar),
|
|
73
68
|
* 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).
|
|
74
|
-
* ...
|
|
75
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-bbar)
|
|
69
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-bbar)
|
|
76
70
|
*/
|
|
77
71
|
bbar? : (CoreContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
78
72
|
/**
|
|
79
73
|
* Custom CSS classes to add to the panel's body element.
|
|
80
|
-
* ...
|
|
81
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-bodyCls)
|
|
74
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-bodyCls)
|
|
82
75
|
*/
|
|
83
76
|
bodyCls? : string|object
|
|
84
77
|
/**
|
|
@@ -88,21 +81,18 @@ export type BryntumMenuProps = {
|
|
|
88
81
|
/**
|
|
89
82
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
90
83
|
* hierarchy when triggered.
|
|
91
|
-
* ...
|
|
92
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-bubbleEvents)
|
|
84
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-bubbleEvents)
|
|
93
85
|
*/
|
|
94
86
|
bubbleEvents? : object
|
|
95
87
|
/**
|
|
96
88
|
* Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
97
|
-
* ...
|
|
98
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-callOnFunctions)
|
|
89
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-callOnFunctions)
|
|
99
90
|
*/
|
|
100
91
|
callOnFunctions? : boolean
|
|
101
92
|
/**
|
|
102
93
|
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
103
94
|
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
104
|
-
* ...
|
|
105
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-catchEventHandlerExceptions)
|
|
95
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-catchEventHandlerExceptions)
|
|
106
96
|
*/
|
|
107
97
|
catchEventHandlerExceptions? : boolean
|
|
108
98
|
/**
|
|
@@ -120,8 +110,7 @@ export type BryntumMenuProps = {
|
|
|
120
110
|
/**
|
|
121
111
|
* The action to take when calling the [close](https://bryntum.com/products/core/docs/api/Core/widget/Popup#function-close) method.
|
|
122
112
|
* By default, the popup is hidden.
|
|
123
|
-
* ...
|
|
124
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-closeAction)
|
|
113
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-closeAction)
|
|
125
114
|
*/
|
|
126
115
|
closeAction? : 'hide'|'destroy'
|
|
127
116
|
/**
|
|
@@ -132,8 +121,7 @@ export type BryntumMenuProps = {
|
|
|
132
121
|
* Custom CSS classes to add to element.
|
|
133
122
|
* May be specified as a space separated string, or as an object in which property names
|
|
134
123
|
* with truthy values are used as the class names:
|
|
135
|
-
* ...
|
|
136
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-cls)
|
|
124
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-cls)
|
|
137
125
|
*/
|
|
138
126
|
cls? : string|object
|
|
139
127
|
/**
|
|
@@ -143,15 +131,13 @@ export type BryntumMenuProps = {
|
|
|
143
131
|
collapsed? : boolean
|
|
144
132
|
/**
|
|
145
133
|
* This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-collapsed).
|
|
146
|
-
* ...
|
|
147
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-collapsible)
|
|
134
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-collapsible)
|
|
148
135
|
*/
|
|
149
136
|
collapsible? : boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
|
|
150
137
|
/**
|
|
151
138
|
* Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
|
|
152
139
|
* `style` block.
|
|
153
|
-
* ...
|
|
154
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-color)
|
|
140
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-color)
|
|
155
141
|
*/
|
|
156
142
|
color? : Color
|
|
157
143
|
/**
|
|
@@ -175,8 +161,7 @@ export type BryntumMenuProps = {
|
|
|
175
161
|
* Custom CSS classes to add to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
|
|
176
162
|
* May be specified as a space separated string, or as an object in which property names
|
|
177
163
|
* with truthy values are used as the class names:
|
|
178
|
-
* ...
|
|
179
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-contentElementCls)
|
|
164
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-contentElementCls)
|
|
180
165
|
*/
|
|
181
166
|
contentElementCls? : string|object
|
|
182
167
|
/**
|
|
@@ -196,8 +181,7 @@ export type BryntumMenuProps = {
|
|
|
196
181
|
/**
|
|
197
182
|
* A [query](https://bryntum.com/products/core/docs/api/Core/widget/Container#function-query) selector function which can identify the descendant widget to which
|
|
198
183
|
* focus should be directed by default.
|
|
199
|
-
* ...
|
|
200
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-defaultFocus)
|
|
184
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-defaultFocus)
|
|
201
185
|
* @param {Core.widget.Widget} widget Widget passed to method
|
|
202
186
|
* @returns {boolean} truthy value if widget is the default one
|
|
203
187
|
*/
|
|
@@ -207,16 +191,15 @@ export type BryntumMenuProps = {
|
|
|
207
191
|
*/
|
|
208
192
|
defaults? : CoreContainerItemConfig
|
|
209
193
|
/**
|
|
210
|
-
* Check for CSS compatibility issues
|
|
211
|
-
*
|
|
212
|
-
* [
|
|
194
|
+
* Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
|
|
195
|
+
* checks:
|
|
196
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-detectCSSCompatibilityIssues)
|
|
213
197
|
*/
|
|
214
198
|
detectCSSCompatibilityIssues? : boolean
|
|
215
199
|
/**
|
|
216
200
|
* 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
|
|
217
201
|
* cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
|
|
218
|
-
* ...
|
|
219
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-disabled)
|
|
202
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-disabled)
|
|
220
203
|
*/
|
|
221
204
|
disabled? : boolean|'inert'
|
|
222
205
|
/**
|
|
@@ -224,35 +207,31 @@ export type BryntumMenuProps = {
|
|
|
224
207
|
* [strips collection](https://bryntum.com/products/core/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
|
|
225
208
|
* `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
|
|
226
209
|
* body. Such widgets are called "edge strips".
|
|
227
|
-
* ...
|
|
228
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-dock)
|
|
210
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-dock)
|
|
229
211
|
*/
|
|
230
212
|
dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
|
|
231
213
|
/**
|
|
232
214
|
* Set to `false` to prevent dragging the popup element.
|
|
215
|
+
* @property {string} handleSelector CSS selector used to determine if a drag operation can be started from a mouse-downed element inside the popup
|
|
233
216
|
*/
|
|
234
|
-
draggable? : boolean|
|
|
235
|
-
handleSelector?: string
|
|
236
|
-
}
|
|
217
|
+
draggable? : boolean|object
|
|
237
218
|
/**
|
|
238
219
|
* Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
|
|
239
|
-
* ...
|
|
240
|
-
* [
|
|
241
|
-
* @param {
|
|
242
|
-
* @param {
|
|
243
|
-
* @param {boolean}
|
|
244
|
-
* @param {boolean,
|
|
245
|
-
* @param {boolean,string} autoClose.
|
|
246
|
-
* @param {
|
|
247
|
-
* @param {
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
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}
|
|
220
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-drawer)
|
|
221
|
+
* @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.
|
|
222
|
+
* @param {string,number} [size] The size of the drawer in its collapsible axis.
|
|
223
|
+
* @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.
|
|
224
|
+
* @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.
|
|
225
|
+
* @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.
|
|
226
|
+
* @param {boolean,string} [autoClose.focusout] If focus moves outside of the drawer, the drawer will automatically be hidden.
|
|
227
|
+
* @param {string} [autoClose.mouseout] Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
|
|
228
|
+
* @param {number} [autoCloseDelay] When using `mouseout`, this is the delay in milliseconds
|
|
229
|
+
*/
|
|
230
|
+
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 }
|
|
251
231
|
/**
|
|
252
232
|
* An object specifying attributes to assign to the root element of this widget.
|
|
253
233
|
* Set `null` value to attribute to remove it.
|
|
254
|
-
* ...
|
|
255
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-elementAttributes)
|
|
234
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-elementAttributes)
|
|
256
235
|
*/
|
|
257
236
|
elementAttributes? : Record<string, string|null>
|
|
258
237
|
extraData? : any
|
|
@@ -281,22 +260,19 @@ export type BryntumMenuProps = {
|
|
|
281
260
|
/**
|
|
282
261
|
* Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
|
|
283
262
|
* 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).
|
|
284
|
-
* ...
|
|
285
|
-
*
|
|
263
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-footer)
|
|
264
|
+
* @property {'top','right','bottom','left','start','end'} dock Where to dock
|
|
265
|
+
* @property {string} html Html to populate the footer with
|
|
266
|
+
* @property {string} cls CSS class to add to the footer
|
|
286
267
|
*/
|
|
287
|
-
footer? :
|
|
288
|
-
dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
|
|
289
|
-
html?: string
|
|
290
|
-
cls?: string
|
|
291
|
-
}|string
|
|
268
|
+
footer? : object|string
|
|
292
269
|
/**
|
|
293
270
|
* DOM element to attach popup.
|
|
294
271
|
*/
|
|
295
272
|
forElement? : HTMLElement
|
|
296
273
|
/**
|
|
297
274
|
* 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`.
|
|
298
|
-
* ...
|
|
299
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-header)
|
|
275
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-header)
|
|
300
276
|
*/
|
|
301
277
|
header? : string|boolean|PanelHeader
|
|
302
278
|
/**
|
|
@@ -311,25 +287,21 @@ export type BryntumMenuProps = {
|
|
|
311
287
|
hidden? : boolean
|
|
312
288
|
/**
|
|
313
289
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
314
|
-
* ...
|
|
315
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-hideAnimation)
|
|
290
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-hideAnimation)
|
|
316
291
|
*/
|
|
317
292
|
hideAnimation? : boolean|object
|
|
318
293
|
/**
|
|
319
294
|
* Specify `true` to make this container hide when it has no visible children (Either empty
|
|
320
295
|
* or all children hidden).
|
|
321
|
-
* ...
|
|
322
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-hideWhenEmpty)
|
|
296
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-hideWhenEmpty)
|
|
323
297
|
*/
|
|
324
298
|
hideWhenEmpty? : boolean
|
|
325
299
|
/**
|
|
326
300
|
* The HTML to display initially or a function returning the markup (called at widget construction time).
|
|
327
|
-
* ...
|
|
328
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-html)
|
|
301
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-html)
|
|
329
302
|
* @param {Core.widget.Widget} widget The calling Widget
|
|
330
|
-
* @returns {string}
|
|
331
303
|
*/
|
|
332
|
-
html? : string|((widget: Widget) =>
|
|
304
|
+
html? : string|((widget: Widget) => void)|DomConfig|DomConfig[]|VueConfig|ReactJSX
|
|
333
305
|
/**
|
|
334
306
|
* The CSS class(es) to add when HTML content is being applied to this widget.
|
|
335
307
|
*/
|
|
@@ -345,16 +317,14 @@ export type BryntumMenuProps = {
|
|
|
345
317
|
id? : string
|
|
346
318
|
/**
|
|
347
319
|
* Determines if the widgets read-only state should be controlled by its parent.
|
|
348
|
-
* ...
|
|
349
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-ignoreParentReadOnly)
|
|
320
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-ignoreParentReadOnly)
|
|
350
321
|
*/
|
|
351
322
|
ignoreParentReadOnly? : boolean
|
|
352
323
|
/**
|
|
353
324
|
* Convenience setting to align input fields of child widgets. By default, the Field input element is
|
|
354
325
|
* placed immediately following the `label`. If you prefer to have all input fields aligned to the
|
|
355
326
|
* right, set this config to `'end'`.
|
|
356
|
-
* ...
|
|
357
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-inputFieldAlign)
|
|
327
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-inputFieldAlign)
|
|
358
328
|
*/
|
|
359
329
|
inputFieldAlign? : 'start'|'end'
|
|
360
330
|
/**
|
|
@@ -372,55 +342,52 @@ export type BryntumMenuProps = {
|
|
|
372
342
|
/**
|
|
373
343
|
* An object containing typed child widget config objects or Widgets. May also be specified
|
|
374
344
|
* as an array.
|
|
375
|
-
* ...
|
|
376
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-items)
|
|
345
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-items)
|
|
377
346
|
*/
|
|
378
347
|
items? : Record<string, CoreContainerItemConfig|MenuItemEntry>|(CoreContainerItemConfig|MenuItemEntry|Widget)[]
|
|
379
348
|
/**
|
|
380
349
|
* An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
|
|
381
350
|
* and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
|
|
382
351
|
* are the name of the instance method to call when the keystroke is received.
|
|
383
|
-
* ...
|
|
384
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-keyMap)
|
|
352
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-keyMap)
|
|
385
353
|
*/
|
|
386
354
|
keyMap? : Record<string, KeyMapConfig>
|
|
387
355
|
/**
|
|
388
356
|
* Convenience setting to use same label placement on all child widgets.
|
|
389
|
-
* ...
|
|
390
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-labelPosition)
|
|
357
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-labelPosition)
|
|
391
358
|
*/
|
|
392
359
|
labelPosition? : 'before'|'above'|'align-before'|'auto'|null
|
|
360
|
+
/**
|
|
361
|
+
* Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
|
|
362
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-labelWidth)
|
|
363
|
+
*/
|
|
364
|
+
labelWidth? : number|null
|
|
393
365
|
/**
|
|
394
366
|
* The short name of a helper class which manages rendering and styling of child items.
|
|
395
|
-
* ...
|
|
396
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-layout)
|
|
367
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-layout)
|
|
397
368
|
*/
|
|
398
369
|
layout? : string|CoreContainerLayoutConfig
|
|
399
370
|
/**
|
|
400
371
|
* The CSS style properties to apply to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
|
|
401
|
-
* ...
|
|
402
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-layoutStyle)
|
|
372
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-layoutStyle)
|
|
403
373
|
*/
|
|
404
374
|
layoutStyle? : object
|
|
405
375
|
/**
|
|
406
376
|
* 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
|
|
407
377
|
* instances only when this Container is rendered, rather than eagerly at construct time.
|
|
408
|
-
* ...
|
|
409
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-lazyItems)
|
|
378
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-lazyItems)
|
|
410
379
|
*/
|
|
411
380
|
lazyItems? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|Widget[]
|
|
412
381
|
/**
|
|
413
382
|
* The listener set for this object.
|
|
414
|
-
* ...
|
|
415
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-listeners)
|
|
383
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-listeners)
|
|
416
384
|
*/
|
|
417
385
|
listeners? : MenuListeners
|
|
418
386
|
/**
|
|
419
387
|
* A class translations of which are used for translating this entity.
|
|
420
388
|
* This is often used when translations of an item are defined on its container class.
|
|
421
389
|
* For example:
|
|
422
|
-
* ...
|
|
423
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-localeClass)
|
|
390
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-localeClass)
|
|
424
391
|
*/
|
|
425
392
|
localeClass? : typeof Base
|
|
426
393
|
/**
|
|
@@ -432,8 +399,7 @@ export type BryntumMenuProps = {
|
|
|
432
399
|
* In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
|
|
433
400
|
* you could use 'localeKey' meta configuration.
|
|
434
401
|
* Example:
|
|
435
|
-
* ...
|
|
436
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-localizableProperties)
|
|
402
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-localizableProperties)
|
|
437
403
|
*/
|
|
438
404
|
localizableProperties? : string[]
|
|
439
405
|
/**
|
|
@@ -467,8 +433,7 @@ export type BryntumMenuProps = {
|
|
|
467
433
|
maximized? : boolean
|
|
468
434
|
/**
|
|
469
435
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
470
|
-
* ...
|
|
471
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-maximizeOnMobile)
|
|
436
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-maximizeOnMobile)
|
|
472
437
|
*/
|
|
473
438
|
maximizeOnMobile? : number|string
|
|
474
439
|
/**
|
|
@@ -489,37 +454,31 @@ export type BryntumMenuProps = {
|
|
|
489
454
|
/**
|
|
490
455
|
* Optionally show an opaque mask below this Popup when shown.
|
|
491
456
|
* Configure this as `true` to show the mask.
|
|
492
|
-
* ...
|
|
493
|
-
* [
|
|
457
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-modal)
|
|
458
|
+
* @property {boolean} [closeOnMaskTap] Specify as `true` to close when mask is tapped.
|
|
459
|
+
* @property {boolean} [transparent] Specify as `true` to use a transparent mask.
|
|
494
460
|
*/
|
|
495
|
-
modal? : boolean|
|
|
496
|
-
closeOnMaskTap?: boolean
|
|
497
|
-
transparent?: boolean
|
|
498
|
-
}
|
|
461
|
+
modal? : boolean|object
|
|
499
462
|
/**
|
|
500
463
|
* When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
|
|
501
464
|
* is used to monitor this element for size changes caused by either style manipulation, or by CSS
|
|
502
465
|
* layout.
|
|
503
|
-
* ...
|
|
504
|
-
*
|
|
466
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-monitorResize)
|
|
467
|
+
* @property {boolean} immediate Set to `true` to receive resize notifications immediately.
|
|
505
468
|
*/
|
|
506
|
-
monitorResize? : boolean|
|
|
507
|
-
immediate?: boolean
|
|
508
|
-
}
|
|
469
|
+
monitorResize? : boolean|object
|
|
509
470
|
/**
|
|
510
471
|
* 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)
|
|
511
472
|
* config. For example, a specialized [Menu](https://bryntum.com/products/core/docs/api/Core/widget/Menu) subclass may have a `namedItems` default
|
|
512
473
|
* value defined like this:
|
|
513
|
-
* ...
|
|
514
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-namedItems)
|
|
474
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-namedItems)
|
|
515
475
|
*/
|
|
516
476
|
namedItems? : Record<string, CoreContainerItemConfig>
|
|
517
477
|
/**
|
|
518
478
|
* 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
|
|
519
479
|
* not participate in the standard layout of that widget, and must be positioned relatively to that
|
|
520
480
|
* widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
|
|
521
|
-
* ...
|
|
522
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-positioned)
|
|
481
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-positioned)
|
|
523
482
|
*/
|
|
524
483
|
positioned? : boolean
|
|
525
484
|
/**
|
|
@@ -530,58 +489,64 @@ export type BryntumMenuProps = {
|
|
|
530
489
|
/**
|
|
531
490
|
* Whether this widget is read-only. This is only valid if the widget is an input
|
|
532
491
|
* field, <strong>or contains input fields at any depth</strong>.
|
|
533
|
-
* ...
|
|
534
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-readOnly)
|
|
492
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-readOnly)
|
|
535
493
|
*/
|
|
536
494
|
readOnly? : boolean
|
|
537
495
|
/**
|
|
538
496
|
* [Record](https://bryntum.com/products/core/docs/api/Core/data/Model) whose values will be used to populate fields in the container.
|
|
539
|
-
* ...
|
|
540
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-record)
|
|
497
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-record)
|
|
541
498
|
*/
|
|
542
499
|
record? : Model
|
|
543
500
|
relayStoreEvents? : boolean
|
|
544
501
|
/**
|
|
545
502
|
* Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
|
|
546
503
|
* `type`.
|
|
547
|
-
* ...
|
|
548
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-rendition)
|
|
504
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-rendition)
|
|
549
505
|
*/
|
|
550
506
|
rendition? : string|Record<string, string>|null
|
|
551
507
|
/**
|
|
552
508
|
* Configure this property to allow the widget/component to be resized. Pressing <kbd>Shift</kbd> while resizing will
|
|
553
509
|
* constrain the aspect ratio.
|
|
554
|
-
* ...
|
|
555
|
-
* [
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
510
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-resizable)
|
|
511
|
+
* @property {number} [resizable.minWidth] The minimum width of the element.
|
|
512
|
+
* @property {number} [resizable.maxWidth] The maximum width of the element.
|
|
513
|
+
* @property {number} [resizable.minHeight] The minimum height of the element.
|
|
514
|
+
* @property {number} [resizable.maxHeight] The maximum height of the element
|
|
515
|
+
* @property {object} [resizable.handles] An object controlling which edges/corners are resizable.
|
|
516
|
+
* @property {boolean} [resizable.handles.topStart] Resizable from top-start corner
|
|
517
|
+
* @property {boolean} [resizable.handles.top] Resizable from top edge
|
|
518
|
+
* @property {boolean} [resizable.handles.topEnd] Resizable from top-end corner
|
|
519
|
+
* @property {boolean} [resizable.handles.end] Resizable from end edge
|
|
520
|
+
* @property {boolean} [resizable.handles.bottomEnd] Resizable from bottom-end corner
|
|
521
|
+
* @property {boolean} [resizable.handles.bottom] Resizable from bottom edge
|
|
522
|
+
* @property {boolean} [resizable.handles.bottomStart] Resizable from bottom-start corner
|
|
523
|
+
* @property {boolean} [resizable.handles.start] Resizable from start edge
|
|
524
|
+
*/
|
|
525
|
+
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 } }
|
|
564
526
|
/**
|
|
565
527
|
* Configure as `true` to have the component display a translucent ripple when its
|
|
566
528
|
* [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
|
|
567
529
|
* current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
|
|
568
|
-
* ...
|
|
569
|
-
* [
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
530
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-ripple)
|
|
531
|
+
* @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
|
|
532
|
+
* @property {string} [color] A CSS color name or specification.
|
|
533
|
+
* @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
|
|
534
|
+
* @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.
|
|
535
|
+
*/
|
|
536
|
+
ripple? : boolean|object
|
|
537
|
+
/**
|
|
538
|
+
* The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
|
|
539
|
+
* accidentally applying a role which may interfere with screen readers.
|
|
540
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-role)
|
|
541
|
+
*/
|
|
542
|
+
role? : string
|
|
577
543
|
/**
|
|
578
544
|
* 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`
|
|
579
545
|
*/
|
|
580
546
|
rootElement? : ShadowRoot|HTMLElement
|
|
581
547
|
/**
|
|
582
548
|
* This may be configured as `true` to make the widget's element use the `direction:rtl` style.
|
|
583
|
-
* ...
|
|
584
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-rtl)
|
|
549
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-rtl)
|
|
585
550
|
*/
|
|
586
551
|
rtl? : boolean
|
|
587
552
|
/**
|
|
@@ -591,8 +556,7 @@ export type BryntumMenuProps = {
|
|
|
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/Menu#config-showAnimation)
|
|
559
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-showAnimation)
|
|
596
560
|
*/
|
|
597
561
|
showAnimation? : boolean|object
|
|
598
562
|
/**
|
|
@@ -610,30 +574,26 @@ export type BryntumMenuProps = {
|
|
|
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/Menu#config-stateful)
|
|
577
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#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/Menu#config-statefulEvents)
|
|
583
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#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/Menu#config-stateId)
|
|
590
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#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/Menu#config-stateProvider)
|
|
596
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-stateProvider)
|
|
637
597
|
*/
|
|
638
598
|
stateProvider? : StateProvider
|
|
639
599
|
/**
|
|
@@ -645,23 +605,20 @@ export type BryntumMenuProps = {
|
|
|
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/Menu#config-strips)
|
|
608
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#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/Menu#config-tab)
|
|
615
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#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/Menu#config-tabBarItems)
|
|
621
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-tabBarItems)
|
|
665
622
|
*/
|
|
666
623
|
tabBarItems? : ToolbarItems[]|Widget[]
|
|
667
624
|
/**
|
|
@@ -672,42 +629,36 @@ export type BryntumMenuProps = {
|
|
|
672
629
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/core/docs/api/Core/widget/Toolbar),
|
|
673
630
|
* or array of config objects representing the child items of a Toolbar.
|
|
674
631
|
* This creates a toolbar docked to the top of the panel immediately below the header.
|
|
675
|
-
* ...
|
|
676
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-tbar)
|
|
632
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-tbar)
|
|
677
633
|
*/
|
|
678
634
|
tbar? : (CoreContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
679
635
|
/**
|
|
680
636
|
* Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
|
|
681
|
-
* ...
|
|
682
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-textAlign)
|
|
637
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-textAlign)
|
|
683
638
|
*/
|
|
684
639
|
textAlign? : 'left'|'center'|'right'|'start'|'end'
|
|
685
640
|
/**
|
|
686
641
|
* Specify `true` for a container used to show text markup. It will apply the CSS class `b-text-content`
|
|
687
642
|
* which specifies a default max-width that makes long text more readable.
|
|
688
|
-
* ...
|
|
689
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-textContent)
|
|
643
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-textContent)
|
|
690
644
|
*/
|
|
691
645
|
textContent? : boolean
|
|
692
646
|
/**
|
|
693
647
|
* A title to display in the header or owning TabPanel. Causes creation and docking of a header
|
|
694
648
|
* to the top if no header is configured.
|
|
695
|
-
* ...
|
|
696
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-title)
|
|
649
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-title)
|
|
697
650
|
*/
|
|
698
651
|
title? : string
|
|
699
652
|
/**
|
|
700
653
|
* 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
|
|
701
654
|
* property name is the reference by which an instantiated tool may be retrieved from the live
|
|
702
655
|
* `[tools](https://bryntum.com/products/core/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
|
|
703
|
-
* ...
|
|
704
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-tools)
|
|
656
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-tools)
|
|
705
657
|
*/
|
|
706
658
|
tools? : Record<string, ToolConfig>|null
|
|
707
659
|
/**
|
|
708
660
|
* Tooltip for the widget, either as a string or as a Tooltip config object.
|
|
709
|
-
* ...
|
|
710
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-tooltip)
|
|
661
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-tooltip)
|
|
711
662
|
*/
|
|
712
663
|
tooltip? : string|TooltipConfig|null
|
|
713
664
|
/**
|
|
@@ -720,8 +671,7 @@ export type BryntumMenuProps = {
|
|
|
720
671
|
* Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
|
|
721
672
|
* as a space separated string, an array of strings, or as an object in which property names with truthy
|
|
722
673
|
* values are used as the class names.
|
|
723
|
-
* ...
|
|
724
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-ui)
|
|
674
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-ui)
|
|
725
675
|
*/
|
|
726
676
|
ui? : 'plain'|'toolbar'|string|object
|
|
727
677
|
/**
|
|
@@ -737,14 +687,12 @@ export type BryntumMenuProps = {
|
|
|
737
687
|
width? : string|number
|
|
738
688
|
/**
|
|
739
689
|
* The x position for the widget.
|
|
740
|
-
* ...
|
|
741
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-x)
|
|
690
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-x)
|
|
742
691
|
*/
|
|
743
692
|
x? : number
|
|
744
693
|
/**
|
|
745
694
|
* The y position for the widget.
|
|
746
|
-
* ...
|
|
747
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-y)
|
|
695
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-y)
|
|
748
696
|
*/
|
|
749
697
|
y? : number
|
|
750
698
|
|
|
@@ -796,8 +744,7 @@ export type BryntumMenuProps = {
|
|
|
796
744
|
onBeforeStateSave? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
|
|
797
745
|
/**
|
|
798
746
|
* Fires when any other event is fired from the object.
|
|
799
|
-
* ...
|
|
800
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#event-catchAll)
|
|
747
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#event-catchAll)
|
|
801
748
|
* @param {object} event Event object
|
|
802
749
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
803
750
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -866,8 +813,7 @@ export type BryntumMenuProps = {
|
|
|
866
813
|
onHide? : ((event: { source: Widget }) => void)|string
|
|
867
814
|
/**
|
|
868
815
|
* A descendant menu item has been activated.
|
|
869
|
-
* ...
|
|
870
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#event-item)
|
|
816
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#event-item)
|
|
871
817
|
* @param {object} event Event object
|
|
872
818
|
* @param {Core.widget.MenuItem} event.item The menu item which is being actioned.
|
|
873
819
|
* @param {Core.widget.Menu} event.menu Menu containing the menu item
|
|
@@ -876,8 +822,7 @@ export type BryntumMenuProps = {
|
|
|
876
822
|
/**
|
|
877
823
|
* Triggered when a widget which had been in a non-visible state for any reason
|
|
878
824
|
* achieves visibility.
|
|
879
|
-
* ...
|
|
880
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#event-paint)
|
|
825
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#event-paint)
|
|
881
826
|
* @param {object} event Event object
|
|
882
827
|
* @param {Core.widget.Widget} event.source The widget being painted.
|
|
883
828
|
* @param {boolean} event.firstPaint `true` if this is the first paint.
|
|
@@ -912,8 +857,7 @@ export type BryntumMenuProps = {
|
|
|
912
857
|
onShow? : ((event: { source: Widget }) => void)|string
|
|
913
858
|
/**
|
|
914
859
|
* The checked state of a descendant menu item has changed.
|
|
915
|
-
* ...
|
|
916
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#event-toggle)
|
|
860
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#event-toggle)
|
|
917
861
|
* @param {object} event Event object
|
|
918
862
|
* @param {Core.widget.MenuItem} event.item The menu item whose checked state changed.
|
|
919
863
|
* @param {Core.widget.Menu} event.menu Menu containing the menu item
|
|
@@ -996,6 +940,7 @@ export class BryntumMenu extends React.Component<BryntumMenuProps> {
|
|
|
996
940
|
'preventTooltipOnTouch',
|
|
997
941
|
'relayStoreEvents',
|
|
998
942
|
'ripple',
|
|
943
|
+
'role',
|
|
999
944
|
'rootElement',
|
|
1000
945
|
'scrollAction',
|
|
1001
946
|
'showAnimation',
|
|
@@ -1041,6 +986,7 @@ export class BryntumMenu extends React.Component<BryntumMenuProps> {
|
|
|
1041
986
|
'items',
|
|
1042
987
|
'keyMap',
|
|
1043
988
|
'labelPosition',
|
|
989
|
+
'labelWidth',
|
|
1044
990
|
'layout',
|
|
1045
991
|
'layoutStyle',
|
|
1046
992
|
'margin',
|
|
@@ -1090,13 +1036,7 @@ export class BryntumMenu extends React.Component<BryntumMenuProps> {
|
|
|
1090
1036
|
];
|
|
1091
1037
|
|
|
1092
1038
|
static propertyNames = [
|
|
1093
|
-
'anchorSize',
|
|
1094
|
-
'focusVisible',
|
|
1095
|
-
'hasChanges',
|
|
1096
|
-
'isSettingValues',
|
|
1097
|
-
'isValid',
|
|
1098
1039
|
'parent',
|
|
1099
|
-
'parentMenu',
|
|
1100
1040
|
'selectedElement',
|
|
1101
1041
|
'state',
|
|
1102
1042
|
'values'
|