@bryntum/core-react-thin 7.3.0 → 7.3.2
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 +2 -1
- package/lib/BryntumBooleanCombo.js +1 -0
- package/lib/BryntumBooleanCombo.js.map +1 -1
- package/lib/BryntumButton.d.ts +3 -3
- package/lib/BryntumButton.js.map +1 -1
- package/lib/BryntumButtonGroup.d.ts +1 -1
- package/lib/BryntumButtonGroup.js.map +1 -1
- package/lib/BryntumChatPanel.d.ts +3 -3
- package/lib/BryntumChatPanel.js.map +1 -1
- package/lib/BryntumCheckbox.d.ts +3 -2
- package/lib/BryntumCheckbox.js +1 -0
- package/lib/BryntumCheckbox.js.map +1 -1
- package/lib/BryntumCheckboxGroup.d.ts +3 -3
- package/lib/BryntumCheckboxGroup.js.map +1 -1
- package/lib/BryntumChipView.d.ts +3 -3
- package/lib/BryntumChipView.js.map +1 -1
- package/lib/BryntumCodeEditor.d.ts +3 -3
- package/lib/BryntumCodeEditor.js.map +1 -1
- package/lib/BryntumColorField.d.ts +2 -1
- package/lib/BryntumColorField.js +1 -0
- package/lib/BryntumColorField.js.map +1 -1
- package/lib/BryntumCombo.d.ts +2 -1
- package/lib/BryntumCombo.js +1 -0
- package/lib/BryntumCombo.js.map +1 -1
- package/lib/BryntumContainer.d.ts +1 -1
- package/lib/BryntumContainer.js.map +1 -1
- package/lib/BryntumDateField.d.ts +2 -1
- package/lib/BryntumDateField.js +1 -0
- package/lib/BryntumDateField.js.map +1 -1
- package/lib/BryntumDatePicker.d.ts +3 -3
- package/lib/BryntumDatePicker.js.map +1 -1
- package/lib/BryntumDateRangeField.d.ts +2 -1
- package/lib/BryntumDateRangeField.js +1 -0
- package/lib/BryntumDateRangeField.js.map +1 -1
- package/lib/BryntumDateTimeField.d.ts +2 -1
- package/lib/BryntumDateTimeField.js +1 -0
- package/lib/BryntumDateTimeField.js.map +1 -1
- package/lib/BryntumDemoCodeEditor.d.ts +3 -3
- package/lib/BryntumDemoCodeEditor.js.map +1 -1
- package/lib/BryntumDisplayField.d.ts +2 -1
- package/lib/BryntumDisplayField.js +1 -0
- package/lib/BryntumDisplayField.js.map +1 -1
- package/lib/BryntumDurationField.d.ts +2 -1
- package/lib/BryntumDurationField.js +1 -0
- package/lib/BryntumDurationField.js.map +1 -1
- package/lib/BryntumEditor.d.ts +5 -5
- package/lib/BryntumEditor.js.map +1 -1
- package/lib/BryntumFieldFilterPicker.d.ts +1 -1
- package/lib/BryntumFieldFilterPicker.js.map +1 -1
- package/lib/BryntumFieldFilterPickerGroup.d.ts +2 -2
- package/lib/BryntumFieldFilterPickerGroup.js.map +1 -1
- package/lib/BryntumFieldSet.d.ts +3 -3
- package/lib/BryntumFieldSet.js.map +1 -1
- package/lib/BryntumFileField.d.ts +2 -1
- package/lib/BryntumFileField.js +1 -0
- package/lib/BryntumFileField.js.map +1 -1
- package/lib/BryntumFilePicker.d.ts +1 -1
- package/lib/BryntumFilePicker.js.map +1 -1
- package/lib/BryntumFilterField.d.ts +2 -1
- package/lib/BryntumFilterField.js +1 -0
- package/lib/BryntumFilterField.js.map +1 -1
- package/lib/BryntumHint.d.ts +3 -3
- package/lib/BryntumHint.js.map +1 -1
- package/lib/BryntumLabel.d.ts +1 -1
- package/lib/BryntumLabel.js.map +1 -1
- package/lib/BryntumList.d.ts +2 -2
- package/lib/BryntumList.js.map +1 -1
- package/lib/BryntumMenu.d.ts +3 -3
- package/lib/BryntumMenu.js.map +1 -1
- package/lib/BryntumMonthPicker.d.ts +3 -3
- package/lib/BryntumMonthPicker.js.map +1 -1
- package/lib/BryntumNumberField.d.ts +2 -1
- package/lib/BryntumNumberField.js +1 -0
- package/lib/BryntumNumberField.js.map +1 -1
- package/lib/BryntumPagingToolbar.d.ts +2 -2
- package/lib/BryntumPagingToolbar.js.map +1 -1
- package/lib/BryntumPanel.d.ts +3 -3
- package/lib/BryntumPanel.js.map +1 -1
- package/lib/BryntumPasswordField.d.ts +2 -1
- package/lib/BryntumPasswordField.js +1 -0
- package/lib/BryntumPasswordField.js.map +1 -1
- package/lib/BryntumProgressBar.d.ts +1 -1
- package/lib/BryntumProgressBar.js.map +1 -1
- package/lib/BryntumRadio.d.ts +3 -2
- package/lib/BryntumRadio.js +1 -0
- package/lib/BryntumRadio.js.map +1 -1
- package/lib/BryntumRadioGroup.d.ts +3 -3
- package/lib/BryntumRadioGroup.js.map +1 -1
- package/lib/BryntumSlideToggle.d.ts +3 -2
- package/lib/BryntumSlideToggle.js +1 -0
- package/lib/BryntumSlideToggle.js.map +1 -1
- package/lib/BryntumSlider.d.ts +1 -1
- package/lib/BryntumSlider.js.map +1 -1
- package/lib/BryntumSplitter.d.ts +1 -1
- package/lib/BryntumSplitter.js.map +1 -1
- package/lib/BryntumTabPanel.d.ts +4 -4
- package/lib/BryntumTabPanel.js.map +1 -1
- package/lib/BryntumTextAreaField.d.ts +2 -1
- package/lib/BryntumTextAreaField.js +1 -0
- package/lib/BryntumTextAreaField.js.map +1 -1
- package/lib/BryntumTextAreaPickerField.d.ts +2 -1
- package/lib/BryntumTextAreaPickerField.js +1 -0
- package/lib/BryntumTextAreaPickerField.js.map +1 -1
- package/lib/BryntumTextField.d.ts +2 -1
- package/lib/BryntumTextField.js +1 -0
- package/lib/BryntumTextField.js.map +1 -1
- package/lib/BryntumTimeField.d.ts +2 -1
- package/lib/BryntumTimeField.js +1 -0
- package/lib/BryntumTimeField.js.map +1 -1
- package/lib/BryntumTimePicker.d.ts +1 -1
- package/lib/BryntumTimePicker.js.map +1 -1
- package/lib/BryntumToolbar.d.ts +2 -2
- package/lib/BryntumToolbar.js.map +1 -1
- package/lib/BryntumWidget.d.ts +1 -1
- package/lib/BryntumWidget.js.map +1 -1
- package/lib/BryntumYearPicker.d.ts +3 -3
- package/lib/BryntumYearPicker.js.map +1 -1
- package/package.json +1 -1
- package/src/BryntumBooleanCombo.tsx +17 -1
- package/src/BryntumButton.tsx +9 -3
- package/src/BryntumButtonGroup.tsx +7 -1
- package/src/BryntumChatPanel.tsx +9 -3
- package/src/BryntumCheckbox.tsx +18 -2
- package/src/BryntumCheckboxGroup.tsx +9 -3
- package/src/BryntumChipView.tsx +11 -3
- package/src/BryntumCodeEditor.tsx +9 -3
- package/src/BryntumColorField.tsx +17 -1
- package/src/BryntumCombo.tsx +17 -1
- package/src/BryntumContainer.tsx +7 -1
- package/src/BryntumDateField.tsx +17 -1
- package/src/BryntumDatePicker.tsx +9 -3
- package/src/BryntumDateRangeField.tsx +17 -1
- package/src/BryntumDateTimeField.tsx +17 -1
- package/src/BryntumDemoCodeEditor.tsx +9 -3
- package/src/BryntumDisplayField.tsx +17 -1
- package/src/BryntumDurationField.tsx +17 -1
- package/src/BryntumEditor.tsx +11 -5
- package/src/BryntumFieldFilterPicker.tsx +7 -1
- package/src/BryntumFieldFilterPickerGroup.tsx +8 -2
- package/src/BryntumFieldSet.tsx +9 -3
- package/src/BryntumFileField.tsx +17 -1
- package/src/BryntumFilePicker.tsx +7 -1
- package/src/BryntumFilterField.tsx +17 -1
- package/src/BryntumHint.tsx +9 -3
- package/src/BryntumLabel.tsx +7 -1
- package/src/BryntumList.tsx +8 -2
- package/src/BryntumMenu.tsx +9 -3
- package/src/BryntumMonthPicker.tsx +9 -3
- package/src/BryntumNumberField.tsx +17 -1
- package/src/BryntumPagingToolbar.tsx +8 -2
- package/src/BryntumPanel.tsx +9 -3
- package/src/BryntumPasswordField.tsx +17 -1
- package/src/BryntumProgressBar.tsx +7 -1
- package/src/BryntumRadio.tsx +18 -2
- package/src/BryntumRadioGroup.tsx +9 -3
- package/src/BryntumSlideToggle.tsx +18 -2
- package/src/BryntumSlider.tsx +7 -1
- package/src/BryntumSplitter.tsx +7 -1
- package/src/BryntumTabPanel.tsx +10 -4
- package/src/BryntumTextAreaField.tsx +17 -1
- package/src/BryntumTextAreaPickerField.tsx +17 -1
- package/src/BryntumTextField.tsx +17 -1
- package/src/BryntumTimeField.tsx +17 -1
- package/src/BryntumTimePicker.tsx +7 -1
- package/src/BryntumToolbar.tsx +8 -2
- package/src/BryntumWidget.tsx +7 -1
- package/src/BryntumYearPicker.tsx +9 -3
|
@@ -34,6 +34,8 @@ export type BryntumFilterFieldProps = {
|
|
|
34
34
|
/**
|
|
35
35
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
36
36
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
37
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
38
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -83,6 +85,15 @@ export type BryntumFilterFieldProps = {
|
|
|
83
85
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
84
86
|
*/
|
|
85
87
|
centered? : boolean
|
|
88
|
+
/**
|
|
89
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
90
|
+
* to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-isValid)
|
|
91
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
|
|
92
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-checkValidity)
|
|
93
|
+
* @param {Core.widget.Field} field The field being validated
|
|
94
|
+
* @returns {void}
|
|
95
|
+
*/
|
|
96
|
+
checkValidity? : ((field: Field) => void)|string
|
|
86
97
|
/**
|
|
87
98
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
88
99
|
* in the [triggers](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
@@ -305,10 +316,14 @@ export type BryntumFilterFieldProps = {
|
|
|
305
316
|
inputWidth? : string|number
|
|
306
317
|
/**
|
|
307
318
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
319
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
320
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-insertBefore)
|
|
308
321
|
*/
|
|
309
322
|
insertBefore? : HTMLElement|string
|
|
310
323
|
/**
|
|
311
324
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
325
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
326
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilterField#config-insertFirst)
|
|
312
327
|
*/
|
|
313
328
|
insertFirst? : HTMLElement|string
|
|
314
329
|
/**
|
|
@@ -646,7 +661,7 @@ export type BryntumFilterFieldProps = {
|
|
|
646
661
|
* @param {object} event Event object
|
|
647
662
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
648
663
|
*/
|
|
649
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
664
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
650
665
|
/**
|
|
651
666
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
652
667
|
* @param {object} event Event object
|
|
@@ -794,6 +809,7 @@ export class BryntumFilterField extends React.Component<BryntumFilterFieldProps>
|
|
|
794
809
|
'autoSelect',
|
|
795
810
|
'bubbleEvents',
|
|
796
811
|
'centered',
|
|
812
|
+
'checkValidity',
|
|
797
813
|
'clearable',
|
|
798
814
|
'color',
|
|
799
815
|
'config',
|
package/src/BryntumHint.tsx
CHANGED
|
@@ -34,6 +34,8 @@ export type BryntumHintProps = {
|
|
|
34
34
|
/**
|
|
35
35
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
36
36
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
37
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
38
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -307,10 +309,14 @@ export type BryntumHintProps = {
|
|
|
307
309
|
inputFieldAlign? : 'start'|'end'
|
|
308
310
|
/**
|
|
309
311
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
312
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
313
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-insertBefore)
|
|
310
314
|
*/
|
|
311
315
|
insertBefore? : HTMLElement|string
|
|
312
316
|
/**
|
|
313
317
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
318
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
319
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#config-insertFirst)
|
|
314
320
|
*/
|
|
315
321
|
insertFirst? : HTMLElement|string
|
|
316
322
|
/**
|
|
@@ -719,7 +725,7 @@ export type BryntumHintProps = {
|
|
|
719
725
|
* @param {object} event Event object
|
|
720
726
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
721
727
|
*/
|
|
722
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
728
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
723
729
|
/**
|
|
724
730
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
725
731
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -739,13 +745,13 @@ export type BryntumHintProps = {
|
|
|
739
745
|
* @param {object} event Event object
|
|
740
746
|
* @param {any} event.state State object config
|
|
741
747
|
*/
|
|
742
|
-
onBeforeStateApply? : ((event: { state: any }) =>
|
|
748
|
+
onBeforeStateApply? : ((event: { state: any }) => boolean|void)|string
|
|
743
749
|
/**
|
|
744
750
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
745
751
|
* @param {object} event Event object
|
|
746
752
|
* @param {any} event.state State object config
|
|
747
753
|
*/
|
|
748
|
-
onBeforeStateSave? : ((event: { state: any }) =>
|
|
754
|
+
onBeforeStateSave? : ((event: { state: any }) => boolean|void)|string
|
|
749
755
|
/**
|
|
750
756
|
* Fires when any other event is fired from the object.
|
|
751
757
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Hint#event-catchAll)
|
package/src/BryntumLabel.tsx
CHANGED
|
@@ -34,6 +34,8 @@ export type BryntumLabelProps = {
|
|
|
34
34
|
/**
|
|
35
35
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
36
36
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
37
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
38
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Label#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -205,10 +207,14 @@ export type BryntumLabelProps = {
|
|
|
205
207
|
ignoreParentReadOnly? : boolean
|
|
206
208
|
/**
|
|
207
209
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
210
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
211
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Label#config-insertBefore)
|
|
208
212
|
*/
|
|
209
213
|
insertBefore? : HTMLElement|string
|
|
210
214
|
/**
|
|
211
215
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
216
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
217
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Label#config-insertFirst)
|
|
212
218
|
*/
|
|
213
219
|
insertFirst? : HTMLElement|string
|
|
214
220
|
/**
|
|
@@ -433,7 +439,7 @@ export type BryntumLabelProps = {
|
|
|
433
439
|
* @param {object} event Event object
|
|
434
440
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
435
441
|
*/
|
|
436
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
442
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
437
443
|
/**
|
|
438
444
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
439
445
|
* @param {object} event Event object
|
package/src/BryntumList.tsx
CHANGED
|
@@ -44,6 +44,8 @@ export type BryntumListProps = {
|
|
|
44
44
|
/**
|
|
45
45
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
46
46
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
47
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
48
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/List#config-appendTo)
|
|
47
49
|
*/
|
|
48
50
|
appendTo? : HTMLElement|string
|
|
49
51
|
/**
|
|
@@ -253,10 +255,14 @@ export type BryntumListProps = {
|
|
|
253
255
|
ignoreParentReadOnly? : boolean
|
|
254
256
|
/**
|
|
255
257
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
258
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
259
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/List#config-insertBefore)
|
|
256
260
|
*/
|
|
257
261
|
insertBefore? : HTMLElement|string
|
|
258
262
|
/**
|
|
259
263
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
264
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
265
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/List#config-insertFirst)
|
|
260
266
|
*/
|
|
261
267
|
insertFirst? : HTMLElement|string
|
|
262
268
|
/**
|
|
@@ -534,7 +540,7 @@ export type BryntumListProps = {
|
|
|
534
540
|
* @param {object} event Event object
|
|
535
541
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
536
542
|
*/
|
|
537
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
543
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
538
544
|
/**
|
|
539
545
|
* User going to activate an item in the list either by pointer or keyboard.
|
|
540
546
|
* The active record, list item index, and the triggering event are passed.
|
|
@@ -546,7 +552,7 @@ export type BryntumListProps = {
|
|
|
546
552
|
* @param {number} event.index List item index
|
|
547
553
|
* @param {Event} event.event Triggering event
|
|
548
554
|
*/
|
|
549
|
-
onBeforeItem? : ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) =>
|
|
555
|
+
onBeforeItem? : ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => boolean|void)|string
|
|
550
556
|
/**
|
|
551
557
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
552
558
|
* @param {object} event Event object
|
package/src/BryntumMenu.tsx
CHANGED
|
@@ -34,6 +34,8 @@ export type BryntumMenuProps = {
|
|
|
34
34
|
/**
|
|
35
35
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
36
36
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
37
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
38
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -329,10 +331,14 @@ export type BryntumMenuProps = {
|
|
|
329
331
|
inputFieldAlign? : 'start'|'end'
|
|
330
332
|
/**
|
|
331
333
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
334
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
335
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-insertBefore)
|
|
332
336
|
*/
|
|
333
337
|
insertBefore? : HTMLElement|string
|
|
334
338
|
/**
|
|
335
339
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
340
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
341
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#config-insertFirst)
|
|
336
342
|
*/
|
|
337
343
|
insertFirst? : HTMLElement|string
|
|
338
344
|
/**
|
|
@@ -715,7 +721,7 @@ export type BryntumMenuProps = {
|
|
|
715
721
|
* @param {object} event Event object
|
|
716
722
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
717
723
|
*/
|
|
718
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
724
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
719
725
|
/**
|
|
720
726
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
721
727
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -735,13 +741,13 @@ export type BryntumMenuProps = {
|
|
|
735
741
|
* @param {object} event Event object
|
|
736
742
|
* @param {any} event.state State object config
|
|
737
743
|
*/
|
|
738
|
-
onBeforeStateApply? : ((event: { state: any }) =>
|
|
744
|
+
onBeforeStateApply? : ((event: { state: any }) => boolean|void)|string
|
|
739
745
|
/**
|
|
740
746
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
741
747
|
* @param {object} event Event object
|
|
742
748
|
* @param {any} event.state State object config
|
|
743
749
|
*/
|
|
744
|
-
onBeforeStateSave? : ((event: { state: any }) =>
|
|
750
|
+
onBeforeStateSave? : ((event: { state: any }) => boolean|void)|string
|
|
745
751
|
/**
|
|
746
752
|
* Fires when any other event is fired from the object.
|
|
747
753
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Menu#event-catchAll)
|
|
@@ -34,6 +34,8 @@ export type BryntumMonthPickerProps = {
|
|
|
34
34
|
/**
|
|
35
35
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
36
36
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
37
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
38
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/MonthPicker#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -291,10 +293,14 @@ export type BryntumMonthPickerProps = {
|
|
|
291
293
|
inputFieldAlign? : 'start'|'end'
|
|
292
294
|
/**
|
|
293
295
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
296
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
297
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/MonthPicker#config-insertBefore)
|
|
294
298
|
*/
|
|
295
299
|
insertBefore? : HTMLElement|string
|
|
296
300
|
/**
|
|
297
301
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
302
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
303
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/MonthPicker#config-insertFirst)
|
|
298
304
|
*/
|
|
299
305
|
insertFirst? : HTMLElement|string
|
|
300
306
|
/**
|
|
@@ -643,7 +649,7 @@ export type BryntumMonthPickerProps = {
|
|
|
643
649
|
* @param {object} event Event object
|
|
644
650
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
645
651
|
*/
|
|
646
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
652
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
647
653
|
/**
|
|
648
654
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
649
655
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -663,13 +669,13 @@ export type BryntumMonthPickerProps = {
|
|
|
663
669
|
* @param {object} event Event object
|
|
664
670
|
* @param {any} event.state State object config
|
|
665
671
|
*/
|
|
666
|
-
onBeforeStateApply? : ((event: { state: any }) =>
|
|
672
|
+
onBeforeStateApply? : ((event: { state: any }) => boolean|void)|string
|
|
667
673
|
/**
|
|
668
674
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
669
675
|
* @param {object} event Event object
|
|
670
676
|
* @param {any} event.state State object config
|
|
671
677
|
*/
|
|
672
|
-
onBeforeStateSave? : ((event: { state: any }) =>
|
|
678
|
+
onBeforeStateSave? : ((event: { state: any }) => boolean|void)|string
|
|
673
679
|
/**
|
|
674
680
|
* Fires when any other event is fired from the object.
|
|
675
681
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/MonthPicker#event-catchAll)
|
|
@@ -34,6 +34,8 @@ export type BryntumNumberFieldProps = {
|
|
|
34
34
|
/**
|
|
35
35
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
36
36
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
37
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
38
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -89,6 +91,15 @@ export type BryntumNumberFieldProps = {
|
|
|
89
91
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-changeOnSpin)
|
|
90
92
|
*/
|
|
91
93
|
changeOnSpin? : boolean|number
|
|
94
|
+
/**
|
|
95
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
96
|
+
* to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-isValid)
|
|
97
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
|
|
98
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-checkValidity)
|
|
99
|
+
* @param {Core.widget.Field} field The field being validated
|
|
100
|
+
* @returns {void}
|
|
101
|
+
*/
|
|
102
|
+
checkValidity? : ((field: Field) => void)|string
|
|
92
103
|
/**
|
|
93
104
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
94
105
|
* in the [triggers](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
@@ -301,10 +312,14 @@ export type BryntumNumberFieldProps = {
|
|
|
301
312
|
inputWidth? : string|number
|
|
302
313
|
/**
|
|
303
314
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
315
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
316
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-insertBefore)
|
|
304
317
|
*/
|
|
305
318
|
insertBefore? : HTMLElement|string
|
|
306
319
|
/**
|
|
307
320
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
321
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
322
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/NumberField#config-insertFirst)
|
|
308
323
|
*/
|
|
309
324
|
insertFirst? : HTMLElement|string
|
|
310
325
|
/**
|
|
@@ -652,7 +667,7 @@ export type BryntumNumberFieldProps = {
|
|
|
652
667
|
* @param {object} event Event object
|
|
653
668
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
654
669
|
*/
|
|
655
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
670
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
656
671
|
/**
|
|
657
672
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
658
673
|
* @param {object} event Event object
|
|
@@ -801,6 +816,7 @@ export class BryntumNumberField extends React.Component<BryntumNumberFieldProps>
|
|
|
801
816
|
'bubbleEvents',
|
|
802
817
|
'centered',
|
|
803
818
|
'changeOnSpin',
|
|
819
|
+
'checkValidity',
|
|
804
820
|
'clearable',
|
|
805
821
|
'color',
|
|
806
822
|
'config',
|
|
@@ -34,6 +34,8 @@ export type BryntumPagingToolbarProps = {
|
|
|
34
34
|
/**
|
|
35
35
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
36
36
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
37
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
38
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -242,10 +244,14 @@ export type BryntumPagingToolbarProps = {
|
|
|
242
244
|
inputFieldAlign? : 'start'|'end'
|
|
243
245
|
/**
|
|
244
246
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
247
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
248
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-insertBefore)
|
|
245
249
|
*/
|
|
246
250
|
insertBefore? : HTMLElement|string
|
|
247
251
|
/**
|
|
248
252
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
253
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
254
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PagingToolbar#config-insertFirst)
|
|
249
255
|
*/
|
|
250
256
|
insertFirst? : HTMLElement|string
|
|
251
257
|
/**
|
|
@@ -561,7 +567,7 @@ export type BryntumPagingToolbarProps = {
|
|
|
561
567
|
* @param {object} event Event object
|
|
562
568
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
563
569
|
*/
|
|
564
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
570
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
565
571
|
/**
|
|
566
572
|
* This event is fired on the owning Toolbar prior to starting a drag gesture. The drag is canceled if
|
|
567
573
|
* a listener returns `false`.
|
|
@@ -570,7 +576,7 @@ export type BryntumPagingToolbarProps = {
|
|
|
570
576
|
* @param {Core.widget.Widget} event.item The dragged item.
|
|
571
577
|
* @param {Event} event.domEvent The browser event.
|
|
572
578
|
*/
|
|
573
|
-
onBeforeItemDragStart? : ((event: { source: Toolbar, item: Widget, domEvent: Event }) =>
|
|
579
|
+
onBeforeItemDragStart? : ((event: { source: Toolbar, item: Widget, domEvent: Event }) => boolean|void)|string
|
|
574
580
|
/**
|
|
575
581
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
576
582
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
package/src/BryntumPanel.tsx
CHANGED
|
@@ -34,6 +34,8 @@ export type BryntumPanelProps = {
|
|
|
34
34
|
/**
|
|
35
35
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
36
36
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
37
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
38
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -291,10 +293,14 @@ export type BryntumPanelProps = {
|
|
|
291
293
|
inputFieldAlign? : 'start'|'end'
|
|
292
294
|
/**
|
|
293
295
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
296
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
297
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-insertBefore)
|
|
294
298
|
*/
|
|
295
299
|
insertBefore? : HTMLElement|string
|
|
296
300
|
/**
|
|
297
301
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
302
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
303
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#config-insertFirst)
|
|
298
304
|
*/
|
|
299
305
|
insertFirst? : HTMLElement|string
|
|
300
306
|
/**
|
|
@@ -639,7 +645,7 @@ export type BryntumPanelProps = {
|
|
|
639
645
|
* @param {object} event Event object
|
|
640
646
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
641
647
|
*/
|
|
642
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
648
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
643
649
|
/**
|
|
644
650
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
645
651
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -659,13 +665,13 @@ export type BryntumPanelProps = {
|
|
|
659
665
|
* @param {object} event Event object
|
|
660
666
|
* @param {any} event.state State object config
|
|
661
667
|
*/
|
|
662
|
-
onBeforeStateApply? : ((event: { state: any }) =>
|
|
668
|
+
onBeforeStateApply? : ((event: { state: any }) => boolean|void)|string
|
|
663
669
|
/**
|
|
664
670
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
665
671
|
* @param {object} event Event object
|
|
666
672
|
* @param {any} event.state State object config
|
|
667
673
|
*/
|
|
668
|
-
onBeforeStateSave? : ((event: { state: any }) =>
|
|
674
|
+
onBeforeStateSave? : ((event: { state: any }) => boolean|void)|string
|
|
669
675
|
/**
|
|
670
676
|
* Fires when any other event is fired from the object.
|
|
671
677
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Panel#event-catchAll)
|
|
@@ -34,6 +34,8 @@ export type BryntumPasswordFieldProps = {
|
|
|
34
34
|
/**
|
|
35
35
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
36
36
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
37
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
38
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PasswordField#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -83,6 +85,15 @@ export type BryntumPasswordFieldProps = {
|
|
|
83
85
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
84
86
|
*/
|
|
85
87
|
centered? : boolean
|
|
88
|
+
/**
|
|
89
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
90
|
+
* to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-isValid)
|
|
91
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
|
|
92
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PasswordField#config-checkValidity)
|
|
93
|
+
* @param {Core.widget.Field} field The field being validated
|
|
94
|
+
* @returns {void}
|
|
95
|
+
*/
|
|
96
|
+
checkValidity? : ((field: Field) => void)|string
|
|
86
97
|
/**
|
|
87
98
|
* Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-readOnly). The trigger is available
|
|
88
99
|
* in the [triggers](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
|
|
@@ -286,10 +297,14 @@ export type BryntumPasswordFieldProps = {
|
|
|
286
297
|
inputWidth? : string|number
|
|
287
298
|
/**
|
|
288
299
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
300
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
301
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PasswordField#config-insertBefore)
|
|
289
302
|
*/
|
|
290
303
|
insertBefore? : HTMLElement|string
|
|
291
304
|
/**
|
|
292
305
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
306
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
307
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/PasswordField#config-insertFirst)
|
|
293
308
|
*/
|
|
294
309
|
insertFirst? : HTMLElement|string
|
|
295
310
|
/**
|
|
@@ -604,7 +619,7 @@ export type BryntumPasswordFieldProps = {
|
|
|
604
619
|
* @param {object} event Event object
|
|
605
620
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
606
621
|
*/
|
|
607
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
622
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
608
623
|
/**
|
|
609
624
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
610
625
|
* @param {object} event Event object
|
|
@@ -752,6 +767,7 @@ export class BryntumPasswordField extends React.Component<BryntumPasswordFieldPr
|
|
|
752
767
|
'autoSelect',
|
|
753
768
|
'bubbleEvents',
|
|
754
769
|
'centered',
|
|
770
|
+
'checkValidity',
|
|
755
771
|
'clearable',
|
|
756
772
|
'color',
|
|
757
773
|
'config',
|
|
@@ -34,6 +34,8 @@ export type BryntumProgressBarProps = {
|
|
|
34
34
|
/**
|
|
35
35
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
36
36
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
37
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
38
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ProgressBar#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -203,10 +205,14 @@ export type BryntumProgressBarProps = {
|
|
|
203
205
|
ignoreParentReadOnly? : boolean
|
|
204
206
|
/**
|
|
205
207
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
208
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
209
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ProgressBar#config-insertBefore)
|
|
206
210
|
*/
|
|
207
211
|
insertBefore? : HTMLElement|string
|
|
208
212
|
/**
|
|
209
213
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
214
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
215
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ProgressBar#config-insertFirst)
|
|
210
216
|
*/
|
|
211
217
|
insertFirst? : HTMLElement|string
|
|
212
218
|
/**
|
|
@@ -452,7 +458,7 @@ export type BryntumProgressBarProps = {
|
|
|
452
458
|
* @param {object} event Event object
|
|
453
459
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
454
460
|
*/
|
|
455
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
461
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
456
462
|
/**
|
|
457
463
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
458
464
|
* @param {object} event Event object
|
package/src/BryntumRadio.tsx
CHANGED
|
@@ -34,6 +34,8 @@ export type BryntumRadioProps = {
|
|
|
34
34
|
/**
|
|
35
35
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
36
36
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
37
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
38
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Radio#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -100,6 +102,15 @@ export type BryntumRadioProps = {
|
|
|
100
102
|
* A value of `undefined` will cause this widget not to include its value when checked.
|
|
101
103
|
*/
|
|
102
104
|
checkedValue? : any
|
|
105
|
+
/**
|
|
106
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
107
|
+
* to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/core/docs/api/Core/widget/Field#property-isValid)
|
|
108
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
|
|
109
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Radio#config-checkValidity)
|
|
110
|
+
* @param {Core.widget.Field} field The field being validated
|
|
111
|
+
* @returns {void}
|
|
112
|
+
*/
|
|
113
|
+
checkValidity? : ((field: Field) => void)|string
|
|
103
114
|
/**
|
|
104
115
|
* Custom CSS classes to add to element.
|
|
105
116
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -288,10 +299,14 @@ export type BryntumRadioProps = {
|
|
|
288
299
|
inputWidth? : string|number
|
|
289
300
|
/**
|
|
290
301
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
302
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
303
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Radio#config-insertBefore)
|
|
291
304
|
*/
|
|
292
305
|
insertBefore? : HTMLElement|string
|
|
293
306
|
/**
|
|
294
307
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
308
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
309
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Radio#config-insertFirst)
|
|
295
310
|
*/
|
|
296
311
|
insertFirst? : HTMLElement|string
|
|
297
312
|
/**
|
|
@@ -610,7 +625,7 @@ export type BryntumRadioProps = {
|
|
|
610
625
|
* @param {boolean} event.valid True if this field is in a valid state.
|
|
611
626
|
* @param {Event} event.event The triggering DOM event if any
|
|
612
627
|
*/
|
|
613
|
-
onBeforeChange? : ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) =>
|
|
628
|
+
onBeforeChange? : ((event: { source: Checkbox, checked: boolean, value: boolean, oldValue: boolean, userAction: boolean, valid: boolean, event: Event }) => boolean|void)|string
|
|
614
629
|
/**
|
|
615
630
|
* Fires before an object is destroyed.
|
|
616
631
|
* @param {object} event Event object
|
|
@@ -622,7 +637,7 @@ export type BryntumRadioProps = {
|
|
|
622
637
|
* @param {object} event Event object
|
|
623
638
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
624
639
|
*/
|
|
625
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
640
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
626
641
|
/**
|
|
627
642
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
628
643
|
* @param {object} event Event object
|
|
@@ -779,6 +794,7 @@ export class BryntumRadio extends React.Component<BryntumRadioProps> {
|
|
|
779
794
|
'bubbleEvents',
|
|
780
795
|
'centered',
|
|
781
796
|
'checkedValue',
|
|
797
|
+
'checkValidity',
|
|
782
798
|
'color',
|
|
783
799
|
'config',
|
|
784
800
|
'constrainTo',
|
|
@@ -34,6 +34,8 @@ export type BryntumRadioGroupProps = {
|
|
|
34
34
|
/**
|
|
35
35
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
36
36
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
37
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
38
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/RadioGroup#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -302,10 +304,14 @@ export type BryntumRadioGroupProps = {
|
|
|
302
304
|
inputFieldAlign? : 'start'|'end'
|
|
303
305
|
/**
|
|
304
306
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
307
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
308
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/RadioGroup#config-insertBefore)
|
|
305
309
|
*/
|
|
306
310
|
insertBefore? : HTMLElement|string
|
|
307
311
|
/**
|
|
308
312
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
313
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
314
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/RadioGroup#config-insertFirst)
|
|
309
315
|
*/
|
|
310
316
|
insertFirst? : HTMLElement|string
|
|
311
317
|
/**
|
|
@@ -677,7 +683,7 @@ export type BryntumRadioGroupProps = {
|
|
|
677
683
|
* @param {object} event Event object
|
|
678
684
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
679
685
|
*/
|
|
680
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
686
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
681
687
|
/**
|
|
682
688
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
683
689
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -697,13 +703,13 @@ export type BryntumRadioGroupProps = {
|
|
|
697
703
|
* @param {object} event Event object
|
|
698
704
|
* @param {any} event.state State object config
|
|
699
705
|
*/
|
|
700
|
-
onBeforeStateApply? : ((event: { state: any }) =>
|
|
706
|
+
onBeforeStateApply? : ((event: { state: any }) => boolean|void)|string
|
|
701
707
|
/**
|
|
702
708
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
703
709
|
* @param {object} event Event object
|
|
704
710
|
* @param {any} event.state State object config
|
|
705
711
|
*/
|
|
706
|
-
onBeforeStateSave? : ((event: { state: any }) =>
|
|
712
|
+
onBeforeStateSave? : ((event: { state: any }) => boolean|void)|string
|
|
707
713
|
/**
|
|
708
714
|
* Fires when any other event is fired from the object.
|
|
709
715
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/RadioGroup#event-catchAll)
|