@bryntum/core-react-thin 7.2.4 → 7.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/BryntumBooleanCombo.d.ts +261 -0
- package/lib/BryntumBooleanCombo.js +204 -0
- package/lib/BryntumBooleanCombo.js.map +1 -0
- package/lib/BryntumButton.d.ts +6 -14
- package/lib/BryntumButton.js +1 -2
- package/lib/BryntumButton.js.map +1 -1
- package/lib/BryntumButtonGroup.d.ts +8 -15
- package/lib/BryntumButtonGroup.js +2 -5
- package/lib/BryntumButtonGroup.js.map +1 -1
- package/lib/BryntumChatPanel.d.ts +16 -20
- package/lib/BryntumChatPanel.js +7 -6
- package/lib/BryntumChatPanel.js.map +1 -1
- package/lib/BryntumCheckbox.d.ts +7 -15
- package/lib/BryntumCheckbox.js +1 -2
- package/lib/BryntumCheckbox.js.map +1 -1
- package/lib/BryntumCheckboxGroup.d.ts +9 -21
- package/lib/BryntumCheckboxGroup.js +2 -6
- package/lib/BryntumCheckboxGroup.js.map +1 -1
- package/lib/BryntumChipView.d.ts +6 -14
- package/lib/BryntumChipView.js +1 -2
- package/lib/BryntumChipView.js.map +1 -1
- package/lib/BryntumCodeEditor.d.ts +9 -20
- package/lib/BryntumCodeEditor.js +2 -5
- package/lib/BryntumCodeEditor.js.map +1 -1
- package/lib/BryntumColorField.d.ts +7 -15
- package/lib/BryntumColorField.js +1 -2
- package/lib/BryntumColorField.js.map +1 -1
- package/lib/BryntumCombo.d.ts +10 -18
- package/lib/BryntumCombo.js +1 -2
- package/lib/BryntumCombo.js.map +1 -1
- package/lib/BryntumContainer.d.ts +7 -14
- package/lib/BryntumContainer.js +2 -5
- package/lib/BryntumContainer.js.map +1 -1
- package/lib/BryntumDateField.d.ts +7 -15
- package/lib/BryntumDateField.js +1 -2
- package/lib/BryntumDateField.js.map +1 -1
- package/lib/BryntumDatePicker.d.ts +9 -20
- package/lib/BryntumDatePicker.js +2 -5
- package/lib/BryntumDatePicker.js.map +1 -1
- package/lib/BryntumDateRangeField.d.ts +10 -18
- package/lib/BryntumDateRangeField.js +1 -2
- package/lib/BryntumDateRangeField.js.map +1 -1
- package/lib/BryntumDateTimeField.d.ts +7 -15
- package/lib/BryntumDateTimeField.js +1 -2
- package/lib/BryntumDateTimeField.js.map +1 -1
- package/lib/BryntumDemoCodeEditor.d.ts +9 -20
- package/lib/BryntumDemoCodeEditor.js +2 -5
- package/lib/BryntumDemoCodeEditor.js.map +1 -1
- package/lib/BryntumDisplayField.d.ts +7 -15
- package/lib/BryntumDisplayField.js +1 -2
- package/lib/BryntumDisplayField.js.map +1 -1
- package/lib/BryntumDurationField.d.ts +7 -15
- package/lib/BryntumDurationField.js +1 -2
- package/lib/BryntumDurationField.js.map +1 -1
- package/lib/BryntumEditor.d.ts +9 -19
- package/lib/BryntumEditor.js +2 -5
- package/lib/BryntumEditor.js.map +1 -1
- package/lib/BryntumFieldFilterPicker.d.ts +7 -14
- package/lib/BryntumFieldFilterPicker.js +2 -5
- package/lib/BryntumFieldFilterPicker.js.map +1 -1
- package/lib/BryntumFieldFilterPickerGroup.d.ts +7 -14
- package/lib/BryntumFieldFilterPickerGroup.js +2 -5
- package/lib/BryntumFieldFilterPickerGroup.js.map +1 -1
- package/lib/BryntumFieldSet.d.ts +9 -21
- package/lib/BryntumFieldSet.js +2 -6
- package/lib/BryntumFieldSet.js.map +1 -1
- package/lib/BryntumFileField.d.ts +7 -15
- package/lib/BryntumFileField.js +1 -2
- package/lib/BryntumFileField.js.map +1 -1
- package/lib/BryntumFilePicker.d.ts +7 -14
- package/lib/BryntumFilePicker.js +2 -5
- package/lib/BryntumFilePicker.js.map +1 -1
- package/lib/BryntumFilterField.d.ts +7 -15
- package/lib/BryntumFilterField.js +1 -2
- package/lib/BryntumFilterField.js.map +1 -1
- package/lib/BryntumHint.d.ts +21 -30
- package/lib/BryntumHint.js +2 -5
- package/lib/BryntumHint.js.map +1 -1
- package/lib/BryntumLabel.d.ts +6 -14
- package/lib/BryntumLabel.js +1 -2
- package/lib/BryntumLabel.js.map +1 -1
- package/lib/BryntumList.d.ts +6 -14
- package/lib/BryntumList.js +1 -2
- package/lib/BryntumList.js.map +1 -1
- package/lib/BryntumMenu.d.ts +20 -25
- package/lib/BryntumMenu.js +2 -6
- package/lib/BryntumMenu.js.map +1 -1
- package/lib/BryntumMonthPicker.d.ts +9 -20
- package/lib/BryntumMonthPicker.js +2 -5
- package/lib/BryntumMonthPicker.js.map +1 -1
- package/lib/BryntumNumberField.d.ts +7 -15
- package/lib/BryntumNumberField.js +1 -2
- package/lib/BryntumNumberField.js.map +1 -1
- package/lib/BryntumPagingToolbar.d.ts +10 -17
- package/lib/BryntumPagingToolbar.js +2 -5
- package/lib/BryntumPagingToolbar.js.map +1 -1
- package/lib/BryntumPanel.d.ts +9 -20
- package/lib/BryntumPanel.js +2 -5
- package/lib/BryntumPanel.js.map +1 -1
- package/lib/BryntumPasswordField.d.ts +7 -15
- package/lib/BryntumPasswordField.js +1 -2
- package/lib/BryntumPasswordField.js.map +1 -1
- package/lib/BryntumProgressBar.d.ts +6 -14
- package/lib/BryntumProgressBar.js +1 -2
- package/lib/BryntumProgressBar.js.map +1 -1
- package/lib/BryntumRadio.d.ts +7 -15
- package/lib/BryntumRadio.js +1 -2
- package/lib/BryntumRadio.js.map +1 -1
- package/lib/BryntumRadioGroup.d.ts +9 -21
- package/lib/BryntumRadioGroup.js +2 -6
- package/lib/BryntumRadioGroup.js.map +1 -1
- package/lib/BryntumSlideToggle.d.ts +7 -15
- package/lib/BryntumSlideToggle.js +1 -2
- package/lib/BryntumSlideToggle.js.map +1 -1
- package/lib/BryntumSlider.d.ts +7 -14
- package/lib/BryntumSlider.js +2 -2
- package/lib/BryntumSlider.js.map +1 -1
- package/lib/BryntumSplitter.d.ts +6 -14
- package/lib/BryntumSplitter.js +1 -2
- package/lib/BryntumSplitter.js.map +1 -1
- package/lib/BryntumTabPanel.d.ts +9 -20
- package/lib/BryntumTabPanel.js +2 -5
- package/lib/BryntumTabPanel.js.map +1 -1
- package/lib/BryntumTextAreaField.d.ts +8 -15
- package/lib/BryntumTextAreaField.js +2 -2
- package/lib/BryntumTextAreaField.js.map +1 -1
- package/lib/BryntumTextAreaPickerField.d.ts +8 -16
- package/lib/BryntumTextAreaPickerField.js +1 -2
- package/lib/BryntumTextAreaPickerField.js.map +1 -1
- package/lib/BryntumTextField.d.ts +7 -15
- package/lib/BryntumTextField.js +1 -2
- package/lib/BryntumTextField.js.map +1 -1
- package/lib/BryntumTimeField.d.ts +8 -16
- package/lib/BryntumTimeField.js +1 -2
- package/lib/BryntumTimeField.js.map +1 -1
- package/lib/BryntumTimePicker.d.ts +7 -14
- package/lib/BryntumTimePicker.js +2 -5
- package/lib/BryntumTimePicker.js.map +1 -1
- package/lib/BryntumToolbar.d.ts +10 -17
- package/lib/BryntumToolbar.js +2 -5
- package/lib/BryntumToolbar.js.map +1 -1
- package/lib/BryntumWidget.d.ts +6 -14
- package/lib/BryntumWidget.js +1 -2
- package/lib/BryntumWidget.js.map +1 -1
- package/lib/BryntumYearPicker.d.ts +9 -20
- package/lib/BryntumYearPicker.js +2 -5
- package/lib/BryntumYearPicker.js.map +1 -1
- package/lib/WrapperHelper.js +2 -2
- package/lib/WrapperHelper.js.map +1 -1
- package/lib/index.d.ts +1 -0
- package/lib/index.js +1 -0
- package/lib/index.js.map +1 -1
- package/package.json +1 -1
- package/src/BryntumBooleanCombo.tsx +1180 -0
- package/src/BryntumButton.tsx +69 -115
- package/src/BryntumButtonGroup.tsx +78 -123
- package/src/BryntumChatPanel.tsx +139 -169
- package/src/BryntumCheckbox.tsx +73 -117
- package/src/BryntumCheckboxGroup.tsx +109 -179
- package/src/BryntumChipView.tsx +65 -105
- package/src/BryntumCodeEditor.tsx +106 -167
- package/src/BryntumColorField.tsx +73 -117
- package/src/BryntumCombo.tsx +92 -152
- package/src/BryntumContainer.tsx +78 -124
- package/src/BryntumDateField.tsx +80 -123
- package/src/BryntumDatePicker.tsx +119 -193
- package/src/BryntumDateRangeField.tsx +79 -126
- package/src/BryntumDateTimeField.tsx +73 -117
- package/src/BryntumDemoCodeEditor.tsx +106 -167
- package/src/BryntumDisplayField.tsx +74 -119
- package/src/BryntumDurationField.tsx +80 -125
- package/src/BryntumEditor.tsx +90 -140
- package/src/BryntumFieldFilterPicker.tsx +80 -128
- package/src/BryntumFieldFilterPickerGroup.tsx +82 -132
- package/src/BryntumFieldSet.tsx +105 -172
- package/src/BryntumFileField.tsx +73 -117
- package/src/BryntumFilePicker.tsx +78 -124
- package/src/BryntumFilterField.tsx +76 -123
- package/src/BryntumHint.tsx +133 -190
- package/src/BryntumLabel.tsx +59 -95
- package/src/BryntumList.tsx +62 -101
- package/src/BryntumMenu.tsx +128 -188
- package/src/BryntumMonthPicker.tsx +106 -167
- package/src/BryntumNumberField.tsx +77 -121
- package/src/BryntumPagingToolbar.tsx +82 -129
- package/src/BryntumPanel.tsx +106 -167
- package/src/BryntumPasswordField.tsx +73 -117
- package/src/BryntumProgressBar.tsx +58 -93
- package/src/BryntumRadio.tsx +73 -117
- package/src/BryntumRadioGroup.tsx +109 -178
- package/src/BryntumSlideToggle.tsx +73 -117
- package/src/BryntumSlider.tsx +67 -101
- package/src/BryntumSplitter.tsx +61 -99
- package/src/BryntumTabPanel.tsx +107 -169
- package/src/BryntumTextAreaField.tsx +81 -119
- package/src/BryntumTextAreaPickerField.tsx +75 -120
- package/src/BryntumTextField.tsx +74 -119
- package/src/BryntumTimeField.tsx +79 -120
- package/src/BryntumTimePicker.tsx +78 -124
- package/src/BryntumToolbar.tsx +82 -129
- package/src/BryntumWidget.tsx +59 -95
- package/src/BryntumYearPicker.tsx +107 -169
- package/src/WrapperHelper.tsx +2 -2
- package/src/index.ts +1 -0
|
@@ -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, CheckboxConfig, CheckboxGroup, CheckboxGroupListeners, Color, Container, CoreContainerItemConfig, CoreContainerLayoutConfig, DomConfig, KeyMapConfig, Layout, MaskConfig, MenuItemConfig, MenuItemEntry, Model, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, Rectangle, Scroller, ScrollerConfig, StateProvider, TabConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, VueConfig, Widget } from '@bryntum/core-thin';
|
|
6
|
+
import { AlignSpec, Base, CheckboxConfig, CheckboxGroup, CheckboxGroupListeners, Color, Container, CoreContainerItemConfig, CoreContainerLayoutConfig, DomConfig, KeyMapConfig, Layout, MaskConfig, MenuItemConfig, MenuItemEntry, Model, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, 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 BryntumCheckboxGroupProps = {
|
|
|
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/CheckboxGroup#config-adopt)
|
|
15
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#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/CheckboxGroup#config-align)
|
|
20
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-align)
|
|
23
21
|
*/
|
|
24
22
|
align? : AlignSpec|string
|
|
25
23
|
/**
|
|
@@ -41,15 +39,13 @@ export type BryntumCheckboxGroupProps = {
|
|
|
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/CheckboxGroup#config-ariaDescription)
|
|
42
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#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/CheckboxGroup#config-ariaLabel)
|
|
48
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-ariaLabel)
|
|
53
49
|
*/
|
|
54
50
|
ariaLabel? : string
|
|
55
51
|
/**
|
|
@@ -59,14 +55,12 @@ export type BryntumCheckboxGroupProps = {
|
|
|
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/CheckboxGroup#config-bbar)
|
|
58
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#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/CheckboxGroup#config-bodyCls)
|
|
63
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-bodyCls)
|
|
70
64
|
*/
|
|
71
65
|
bodyCls? : string|object
|
|
72
66
|
/**
|
|
@@ -76,21 +70,18 @@ export type BryntumCheckboxGroupProps = {
|
|
|
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/CheckboxGroup#config-bubbleEvents)
|
|
73
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#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/CheckboxGroup#config-callOnFunctions)
|
|
78
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#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/CheckboxGroup#config-catchEventHandlerExceptions)
|
|
84
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-catchEventHandlerExceptions)
|
|
94
85
|
*/
|
|
95
86
|
catchEventHandlerExceptions? : boolean
|
|
96
87
|
/**
|
|
@@ -102,8 +93,7 @@ export type BryntumCheckboxGroupProps = {
|
|
|
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/CheckboxGroup#config-cls)
|
|
96
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-cls)
|
|
107
97
|
*/
|
|
108
98
|
cls? : string|object
|
|
109
99
|
/**
|
|
@@ -113,15 +103,13 @@ export type BryntumCheckboxGroupProps = {
|
|
|
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/CheckboxGroup#config-collapsible)
|
|
106
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#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/CheckboxGroup#config-color)
|
|
112
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-color)
|
|
125
113
|
*/
|
|
126
114
|
color? : Color
|
|
127
115
|
/**
|
|
@@ -145,8 +133,7 @@ export type BryntumCheckboxGroupProps = {
|
|
|
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/CheckboxGroup#config-contentElementCls)
|
|
136
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-contentElementCls)
|
|
150
137
|
*/
|
|
151
138
|
contentElementCls? : string|object
|
|
152
139
|
/**
|
|
@@ -166,8 +153,7 @@ export type BryntumCheckboxGroupProps = {
|
|
|
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/CheckboxGroup#config-defaultFocus)
|
|
156
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#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 BryntumCheckboxGroupProps = {
|
|
|
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/CheckboxGroup#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/CheckboxGroup#config-disabled)
|
|
174
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-disabled)
|
|
190
175
|
*/
|
|
191
176
|
disabled? : boolean|'inert'
|
|
192
177
|
/**
|
|
@@ -194,39 +179,34 @@ export type BryntumCheckboxGroupProps = {
|
|
|
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/CheckboxGroup#config-dock)
|
|
182
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#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/CheckboxGroup#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/CheckboxGroup#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/CheckboxGroup#config-elementAttributes)
|
|
209
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-elementAttributes)
|
|
230
210
|
*/
|
|
231
211
|
elementAttributes? : Record<string, string|null>
|
|
232
212
|
extraData? : any
|
|
@@ -246,18 +226,15 @@ export type BryntumCheckboxGroupProps = {
|
|
|
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/CheckboxGroup#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/CheckboxGroup#config-header)
|
|
237
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-header)
|
|
261
238
|
*/
|
|
262
239
|
header? : string|boolean|PanelHeader
|
|
263
240
|
/**
|
|
@@ -272,25 +249,21 @@ export type BryntumCheckboxGroupProps = {
|
|
|
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/CheckboxGroup#config-hideAnimation)
|
|
252
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#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/CheckboxGroup#config-hideWhenEmpty)
|
|
258
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#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/CheckboxGroup#config-html)
|
|
263
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#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,23 +279,20 @@ export type BryntumCheckboxGroupProps = {
|
|
|
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/CheckboxGroup#config-ignoreParentReadOnly)
|
|
282
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-ignoreParentReadOnly)
|
|
311
283
|
*/
|
|
312
284
|
ignoreParentReadOnly? : boolean
|
|
313
285
|
/**
|
|
314
286
|
* Setting this config to `true` assigns a horizontal box layout (`flex-flow: row`) to the items in this
|
|
315
287
|
* container, while `false` assigns a vertical box layout (`flex-flow: column`).
|
|
316
|
-
* ...
|
|
317
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-inline)
|
|
288
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-inline)
|
|
318
289
|
*/
|
|
319
290
|
inline? : boolean
|
|
320
291
|
/**
|
|
321
292
|
* Convenience setting to align input fields of child widgets. By default, the Field input element is
|
|
322
293
|
* placed immediately following the `label`. If you prefer to have all input fields aligned to the
|
|
323
294
|
* right, set this config to `'end'`.
|
|
324
|
-
* ...
|
|
325
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-inputFieldAlign)
|
|
295
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-inputFieldAlign)
|
|
326
296
|
*/
|
|
327
297
|
inputFieldAlign? : 'start'|'end'
|
|
328
298
|
/**
|
|
@@ -340,16 +310,14 @@ export type BryntumCheckboxGroupProps = {
|
|
|
340
310
|
/**
|
|
341
311
|
* An object containing typed child widget config objects or Widgets. May also be specified
|
|
342
312
|
* as an array.
|
|
343
|
-
* ...
|
|
344
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-items)
|
|
313
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-items)
|
|
345
314
|
*/
|
|
346
315
|
items? : Record<string, CoreContainerItemConfig|MenuItemEntry>|(CoreContainerItemConfig|MenuItemEntry|Widget)[]
|
|
347
316
|
/**
|
|
348
317
|
* An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
|
|
349
318
|
* and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
|
|
350
319
|
* are the name of the instance method to call when the keystroke is received.
|
|
351
|
-
* ...
|
|
352
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-keyMap)
|
|
320
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-keyMap)
|
|
353
321
|
*/
|
|
354
322
|
keyMap? : Record<string, KeyMapConfig>
|
|
355
323
|
/**
|
|
@@ -362,45 +330,40 @@ export type BryntumCheckboxGroupProps = {
|
|
|
362
330
|
labelCls? : string|object
|
|
363
331
|
/**
|
|
364
332
|
* Convenience setting to use same label placement on all child widgets.
|
|
365
|
-
* ...
|
|
366
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-labelPosition)
|
|
333
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-labelPosition)
|
|
367
334
|
*/
|
|
368
335
|
labelPosition? : 'before'|'above'|'align-before'|'auto'|null
|
|
369
336
|
/**
|
|
370
|
-
*
|
|
337
|
+
* Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
|
|
338
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-labelWidth)
|
|
371
339
|
*/
|
|
372
|
-
labelWidth? :
|
|
340
|
+
labelWidth? : number|null
|
|
373
341
|
/**
|
|
374
342
|
* The short name of a helper class which manages rendering and styling of child items.
|
|
375
|
-
* ...
|
|
376
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-layout)
|
|
343
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-layout)
|
|
377
344
|
*/
|
|
378
345
|
layout? : string|CoreContainerLayoutConfig
|
|
379
346
|
/**
|
|
380
347
|
* The CSS style properties to apply to the [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
|
|
381
|
-
* ...
|
|
382
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-layoutStyle)
|
|
348
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-layoutStyle)
|
|
383
349
|
*/
|
|
384
350
|
layoutStyle? : object
|
|
385
351
|
/**
|
|
386
352
|
* 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
|
|
387
353
|
* instances only when this Container is rendered, rather than eagerly at construct time.
|
|
388
|
-
* ...
|
|
389
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-lazyItems)
|
|
354
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-lazyItems)
|
|
390
355
|
*/
|
|
391
356
|
lazyItems? : Record<string, CoreContainerItemConfig>|CoreContainerItemConfig[]|Widget[]
|
|
392
357
|
/**
|
|
393
358
|
* The listener set for this object.
|
|
394
|
-
* ...
|
|
395
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-listeners)
|
|
359
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-listeners)
|
|
396
360
|
*/
|
|
397
361
|
listeners? : CheckboxGroupListeners
|
|
398
362
|
/**
|
|
399
363
|
* A class translations of which are used for translating this entity.
|
|
400
364
|
* This is often used when translations of an item are defined on its container class.
|
|
401
365
|
* For example:
|
|
402
|
-
* ...
|
|
403
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-localeClass)
|
|
366
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-localeClass)
|
|
404
367
|
*/
|
|
405
368
|
localeClass? : typeof Base
|
|
406
369
|
/**
|
|
@@ -412,8 +375,7 @@ export type BryntumCheckboxGroupProps = {
|
|
|
412
375
|
* In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
|
|
413
376
|
* you could use 'localeKey' meta configuration.
|
|
414
377
|
* Example:
|
|
415
|
-
* ...
|
|
416
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-localizableProperties)
|
|
378
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-localizableProperties)
|
|
417
379
|
*/
|
|
418
380
|
localizableProperties? : string[]
|
|
419
381
|
/**
|
|
@@ -439,8 +401,7 @@ export type BryntumCheckboxGroupProps = {
|
|
|
439
401
|
maxHeight? : string|number
|
|
440
402
|
/**
|
|
441
403
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
442
|
-
* ...
|
|
443
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-maximizeOnMobile)
|
|
404
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-maximizeOnMobile)
|
|
444
405
|
*/
|
|
445
406
|
maximizeOnMobile? : number|string
|
|
446
407
|
/**
|
|
@@ -470,41 +431,35 @@ export type BryntumCheckboxGroupProps = {
|
|
|
470
431
|
* When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
|
|
471
432
|
* is used to monitor this element for size changes caused by either style manipulation, or by CSS
|
|
472
433
|
* layout.
|
|
473
|
-
* ...
|
|
474
|
-
*
|
|
434
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-monitorResize)
|
|
435
|
+
* @property {boolean} immediate Set to `true` to receive resize notifications immediately.
|
|
475
436
|
*/
|
|
476
|
-
monitorResize? : boolean|
|
|
477
|
-
immediate?: boolean
|
|
478
|
-
}
|
|
437
|
+
monitorResize? : boolean|object
|
|
479
438
|
/**
|
|
480
439
|
* The name by which this widget's [value](https://bryntum.com/products/core/docs/api/Core/widget/RadioGroup#property-value) is accessed using the parent container's
|
|
481
|
-
* [values](https://bryntum.com/products/core/docs/api/Core/widget/
|
|
482
|
-
* ...
|
|
483
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-name)
|
|
440
|
+
* [values](https://bryntum.com/products/core/docs/api/Core/widget/RadioGroup#property-values).
|
|
441
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-name)
|
|
484
442
|
*/
|
|
485
443
|
name? : string
|
|
486
444
|
/**
|
|
487
445
|
* 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)
|
|
488
446
|
* config. For example, a specialized [Menu](https://bryntum.com/products/core/docs/api/Core/widget/Menu) subclass may have a `namedItems` default
|
|
489
447
|
* value defined like this:
|
|
490
|
-
* ...
|
|
491
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-namedItems)
|
|
448
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-namedItems)
|
|
492
449
|
*/
|
|
493
450
|
namedItems? : Record<string, CoreContainerItemConfig>
|
|
494
451
|
/**
|
|
495
452
|
* The set of options for this checkbox group. The keys of this object hold the checkbox's
|
|
496
453
|
* [checkedValue](https://bryntum.com/products/core/docs/api/Core/widget/Checkbox#config-checkedValue) while the object values are a string for the checkbox's
|
|
497
454
|
* [text](https://bryntum.com/products/core/docs/api/Core/widget/Checkbox#config-text) or a config object for that checkbox.
|
|
498
|
-
* ...
|
|
499
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-options)
|
|
455
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-options)
|
|
500
456
|
*/
|
|
501
457
|
options? : Record<string, string|CheckboxConfig>
|
|
502
458
|
/**
|
|
503
459
|
* Set to `true` when a widget is rendered into another widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement), but must
|
|
504
460
|
* not participate in the standard layout of that widget, and must be positioned relatively to that
|
|
505
461
|
* widget's [contentElement](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-contentElement).
|
|
506
|
-
* ...
|
|
507
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-positioned)
|
|
462
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-positioned)
|
|
508
463
|
*/
|
|
509
464
|
positioned? : boolean
|
|
510
465
|
/**
|
|
@@ -515,22 +470,19 @@ export type BryntumCheckboxGroupProps = {
|
|
|
515
470
|
/**
|
|
516
471
|
* Whether this widget is read-only. This is only valid if the widget is an input
|
|
517
472
|
* field, <strong>or contains input fields at any depth</strong>.
|
|
518
|
-
* ...
|
|
519
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-readOnly)
|
|
473
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-readOnly)
|
|
520
474
|
*/
|
|
521
475
|
readOnly? : boolean
|
|
522
476
|
/**
|
|
523
477
|
* [Record](https://bryntum.com/products/core/docs/api/Core/data/Model) whose values will be used to populate fields in the container.
|
|
524
|
-
* ...
|
|
525
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-record)
|
|
478
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-record)
|
|
526
479
|
*/
|
|
527
480
|
record? : Model
|
|
528
481
|
relayStoreEvents? : boolean
|
|
529
482
|
/**
|
|
530
483
|
* Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
|
|
531
484
|
* `type`.
|
|
532
|
-
* ...
|
|
533
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-rendition)
|
|
485
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-rendition)
|
|
534
486
|
*/
|
|
535
487
|
rendition? : string|Record<string, string>|null
|
|
536
488
|
/**
|
|
@@ -543,23 +495,26 @@ export type BryntumCheckboxGroupProps = {
|
|
|
543
495
|
* Configure as `true` to have the component display a translucent ripple when its
|
|
544
496
|
* [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
|
|
545
497
|
* current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
|
|
546
|
-
* ...
|
|
547
|
-
* [
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
498
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-ripple)
|
|
499
|
+
* @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
|
|
500
|
+
* @property {string} [color] A CSS color name or specification.
|
|
501
|
+
* @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
|
|
502
|
+
* @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.
|
|
503
|
+
*/
|
|
504
|
+
ripple? : boolean|object
|
|
505
|
+
/**
|
|
506
|
+
* The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
|
|
507
|
+
* accidentally applying a role which may interfere with screen readers.
|
|
508
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-role)
|
|
509
|
+
*/
|
|
510
|
+
role? : string
|
|
555
511
|
/**
|
|
556
512
|
* 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`
|
|
557
513
|
*/
|
|
558
514
|
rootElement? : ShadowRoot|HTMLElement
|
|
559
515
|
/**
|
|
560
516
|
* This may be configured as `true` to make the widget's element use the `direction:rtl` style.
|
|
561
|
-
* ...
|
|
562
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-rtl)
|
|
517
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-rtl)
|
|
563
518
|
*/
|
|
564
519
|
rtl? : boolean
|
|
565
520
|
/**
|
|
@@ -567,8 +522,7 @@ export type BryntumCheckboxGroupProps = {
|
|
|
567
522
|
* in both axes. May be an object containing boolean `overflowX` and `overflowY` properties which are
|
|
568
523
|
* applied to CSS style properties `overflowX` and `overflowY`. If they are boolean, they are translated to
|
|
569
524
|
* CSS overflow properties thus:
|
|
570
|
-
* ...
|
|
571
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-scrollable)
|
|
525
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-scrollable)
|
|
572
526
|
*/
|
|
573
527
|
scrollable? : boolean|ScrollerConfig|Scroller
|
|
574
528
|
/**
|
|
@@ -578,8 +532,7 @@ export type BryntumCheckboxGroupProps = {
|
|
|
578
532
|
scrollAction? : 'hide'|'realign'|null
|
|
579
533
|
/**
|
|
580
534
|
* *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
|
|
581
|
-
* ...
|
|
582
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-showAnimation)
|
|
535
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-showAnimation)
|
|
583
536
|
*/
|
|
584
537
|
showAnimation? : boolean|object
|
|
585
538
|
/**
|
|
@@ -592,30 +545,26 @@ export type BryntumCheckboxGroupProps = {
|
|
|
592
545
|
span? : number
|
|
593
546
|
/**
|
|
594
547
|
* This value can be one of the following:
|
|
595
|
-
* ...
|
|
596
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-stateful)
|
|
548
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-stateful)
|
|
597
549
|
*/
|
|
598
550
|
stateful? : boolean|object|string[]
|
|
599
551
|
/**
|
|
600
552
|
* The events that, when fired by this component, should trigger it to save its state by calling
|
|
601
553
|
* [saveState](https://bryntum.com/products/core/docs/api/Core/mixin/State#function-saveState).
|
|
602
|
-
* ...
|
|
603
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-statefulEvents)
|
|
554
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-statefulEvents)
|
|
604
555
|
*/
|
|
605
556
|
statefulEvents? : object|string[]
|
|
606
557
|
/**
|
|
607
558
|
* 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
|
|
608
559
|
* 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)
|
|
609
560
|
* (if explicitly specified) will be used as the `stateId`.
|
|
610
|
-
* ...
|
|
611
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-stateId)
|
|
561
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-stateId)
|
|
612
562
|
*/
|
|
613
563
|
stateId? : string
|
|
614
564
|
/**
|
|
615
565
|
* 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`
|
|
616
566
|
* will be saved using the [default state provider](https://bryntum.com/products/core/docs/api/Core/state/StateProvider#property-instance-static).
|
|
617
|
-
* ...
|
|
618
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-stateProvider)
|
|
567
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-stateProvider)
|
|
619
568
|
*/
|
|
620
569
|
stateProvider? : StateProvider
|
|
621
570
|
/**
|
|
@@ -627,23 +576,20 @@ export type BryntumCheckboxGroupProps = {
|
|
|
627
576
|
* An object containing widgets keyed by name. By default (when no `type` is given), strips are
|
|
628
577
|
* [toolbars](https://bryntum.com/products/core/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
|
|
629
578
|
* the toolbar's [items](https://bryntum.com/products/core/docs/api/Core/widget/Container#config-items).
|
|
630
|
-
* ...
|
|
631
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-strips)
|
|
579
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-strips)
|
|
632
580
|
*/
|
|
633
581
|
strips? : Record<string, CoreContainerItemConfig>
|
|
634
582
|
/**
|
|
635
583
|
* 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
|
|
636
584
|
* [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
|
|
637
585
|
* this widget:
|
|
638
|
-
* ...
|
|
639
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-tab)
|
|
586
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-tab)
|
|
640
587
|
*/
|
|
641
588
|
tab? : boolean|TabConfig
|
|
642
589
|
/**
|
|
643
590
|
* When this container is used as a tab in a TabPanel, these items are added to the
|
|
644
591
|
* [TabBar](https://bryntum.com/products/core/docs/api/Core/widget/TabBar) when this container is the active tab.
|
|
645
|
-
* ...
|
|
646
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-tabBarItems)
|
|
592
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-tabBarItems)
|
|
647
593
|
*/
|
|
648
594
|
tabBarItems? : ToolbarItems[]|Widget[]
|
|
649
595
|
/**
|
|
@@ -654,42 +600,36 @@ export type BryntumCheckboxGroupProps = {
|
|
|
654
600
|
* A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/core/docs/api/Core/widget/Toolbar),
|
|
655
601
|
* or array of config objects representing the child items of a Toolbar.
|
|
656
602
|
* This creates a toolbar docked to the top of the panel immediately below the header.
|
|
657
|
-
* ...
|
|
658
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-tbar)
|
|
603
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-tbar)
|
|
659
604
|
*/
|
|
660
605
|
tbar? : (CoreContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
|
|
661
606
|
/**
|
|
662
607
|
* Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
|
|
663
|
-
* ...
|
|
664
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-textAlign)
|
|
608
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-textAlign)
|
|
665
609
|
*/
|
|
666
610
|
textAlign? : 'left'|'center'|'right'|'start'|'end'
|
|
667
611
|
/**
|
|
668
612
|
* Specify `true` for a container used to show text markup. It will apply the CSS class `b-text-content`
|
|
669
613
|
* which specifies a default max-width that makes long text more readable.
|
|
670
|
-
* ...
|
|
671
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-textContent)
|
|
614
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-textContent)
|
|
672
615
|
*/
|
|
673
616
|
textContent? : boolean
|
|
674
617
|
/**
|
|
675
618
|
* A title to display in the header or owning TabPanel. Causes creation and docking of a header
|
|
676
619
|
* to the top if no header is configured.
|
|
677
|
-
* ...
|
|
678
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-title)
|
|
620
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-title)
|
|
679
621
|
*/
|
|
680
622
|
title? : string
|
|
681
623
|
/**
|
|
682
624
|
* 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
|
|
683
625
|
* property name is the reference by which an instantiated tool may be retrieved from the live
|
|
684
626
|
* `[tools](https://bryntum.com/products/core/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
|
|
685
|
-
* ...
|
|
686
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-tools)
|
|
627
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-tools)
|
|
687
628
|
*/
|
|
688
629
|
tools? : Record<string, ToolConfig>|null
|
|
689
630
|
/**
|
|
690
631
|
* Tooltip for the widget, either as a string or as a Tooltip config object.
|
|
691
|
-
* ...
|
|
692
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-tooltip)
|
|
632
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-tooltip)
|
|
693
633
|
*/
|
|
694
634
|
tooltip? : string|TooltipConfig|null
|
|
695
635
|
/**
|
|
@@ -703,15 +643,13 @@ export type BryntumCheckboxGroupProps = {
|
|
|
703
643
|
* Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
|
|
704
644
|
* as a space separated string, an array of strings, or as an object in which property names with truthy
|
|
705
645
|
* values are used as the class names.
|
|
706
|
-
* ...
|
|
707
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-ui)
|
|
646
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-ui)
|
|
708
647
|
*/
|
|
709
648
|
ui? : 'plain'|'toolbar'|string|object
|
|
710
649
|
/**
|
|
711
650
|
* This property corresponds to the [checkedValue](https://bryntum.com/products/core/docs/api/Core/widget/Checkbox#config-checkedValue) of all the currently
|
|
712
651
|
* [checked](https://bryntum.com/products/core/docs/api/Core/widget/Checkbox#property-checked) checkboxes.
|
|
713
|
-
* ...
|
|
714
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-value)
|
|
652
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-value)
|
|
715
653
|
*/
|
|
716
654
|
value? : string|string[]
|
|
717
655
|
/**
|
|
@@ -727,14 +665,12 @@ export type BryntumCheckboxGroupProps = {
|
|
|
727
665
|
width? : string|number
|
|
728
666
|
/**
|
|
729
667
|
* The x position for the widget.
|
|
730
|
-
* ...
|
|
731
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-x)
|
|
668
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-x)
|
|
732
669
|
*/
|
|
733
670
|
x? : number
|
|
734
671
|
/**
|
|
735
672
|
* The y position for the widget.
|
|
736
|
-
* ...
|
|
737
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-y)
|
|
673
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#config-y)
|
|
738
674
|
*/
|
|
739
675
|
y? : number
|
|
740
676
|
|
|
@@ -786,8 +722,7 @@ export type BryntumCheckboxGroupProps = {
|
|
|
786
722
|
onBeforeStateSave? : ((event: { state: any }) => Promise<boolean>|boolean|void)|string
|
|
787
723
|
/**
|
|
788
724
|
* Fires when any other event is fired from the object.
|
|
789
|
-
* ...
|
|
790
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#event-catchAll)
|
|
725
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#event-catchAll)
|
|
791
726
|
* @param {object} event Event object
|
|
792
727
|
* @param {{[key: string]: any, type: string}} event.event The Object that contains event details
|
|
793
728
|
* @param {string} event.event.type The type of the event which is caught by the listener
|
|
@@ -864,8 +799,7 @@ export type BryntumCheckboxGroupProps = {
|
|
|
864
799
|
/**
|
|
865
800
|
* Triggered when a widget which had been in a non-visible state for any reason
|
|
866
801
|
* achieves visibility.
|
|
867
|
-
* ...
|
|
868
|
-
* [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#event-paint)
|
|
802
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#event-paint)
|
|
869
803
|
* @param {object} event Event object
|
|
870
804
|
* @param {Core.widget.Widget} event.source The widget being painted.
|
|
871
805
|
* @param {boolean} event.firstPaint `true` if this is the first paint.
|
|
@@ -952,7 +886,6 @@ export class BryntumCheckboxGroup extends React.Component<BryntumCheckboxGroupPr
|
|
|
952
886
|
'ignoreParentReadOnly',
|
|
953
887
|
'itemCls',
|
|
954
888
|
'labelCls',
|
|
955
|
-
'labelWidth',
|
|
956
889
|
'lazyItems',
|
|
957
890
|
'listeners',
|
|
958
891
|
'localeClass',
|
|
@@ -968,6 +901,7 @@ export class BryntumCheckboxGroup extends React.Component<BryntumCheckboxGroupPr
|
|
|
968
901
|
'preventTooltipOnTouch',
|
|
969
902
|
'relayStoreEvents',
|
|
970
903
|
'ripple',
|
|
904
|
+
'role',
|
|
971
905
|
'rootElement',
|
|
972
906
|
'scrollAction',
|
|
973
907
|
'showAnimation',
|
|
@@ -1014,6 +948,7 @@ export class BryntumCheckboxGroup extends React.Component<BryntumCheckboxGroupPr
|
|
|
1014
948
|
'keyMap',
|
|
1015
949
|
'label',
|
|
1016
950
|
'labelPosition',
|
|
951
|
+
'labelWidth',
|
|
1017
952
|
'layout',
|
|
1018
953
|
'layoutStyle',
|
|
1019
954
|
'margin',
|
|
@@ -1065,11 +1000,6 @@ export class BryntumCheckboxGroup extends React.Component<BryntumCheckboxGroupPr
|
|
|
1065
1000
|
];
|
|
1066
1001
|
|
|
1067
1002
|
static propertyNames = [
|
|
1068
|
-
'anchorSize',
|
|
1069
|
-
'focusVisible',
|
|
1070
|
-
'hasChanges',
|
|
1071
|
-
'isSettingValues',
|
|
1072
|
-
'isValid',
|
|
1073
1003
|
'parent',
|
|
1074
1004
|
'state',
|
|
1075
1005
|
'values'
|