@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
|
@@ -47,6 +47,8 @@ export type BryntumDatePickerProps = {
|
|
|
47
47
|
/**
|
|
48
48
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
49
49
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
50
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
51
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DatePicker#config-appendTo)
|
|
50
52
|
*/
|
|
51
53
|
appendTo? : HTMLElement|string
|
|
52
54
|
/**
|
|
@@ -394,10 +396,14 @@ export type BryntumDatePickerProps = {
|
|
|
394
396
|
inputFieldAlign? : 'start'|'end'
|
|
395
397
|
/**
|
|
396
398
|
* 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.
|
|
399
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
400
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DatePicker#config-insertBefore)
|
|
397
401
|
*/
|
|
398
402
|
insertBefore? : HTMLElement|string
|
|
399
403
|
/**
|
|
400
404
|
* 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.
|
|
405
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
406
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DatePicker#config-insertFirst)
|
|
401
407
|
*/
|
|
402
408
|
insertFirst? : HTMLElement|string
|
|
403
409
|
/**
|
|
@@ -840,7 +846,7 @@ export type BryntumDatePickerProps = {
|
|
|
840
846
|
* @param {object} event Event object
|
|
841
847
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
842
848
|
*/
|
|
843
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
849
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
844
850
|
/**
|
|
845
851
|
* Fires before this CalendarPanel refreshes in response to changes in its month.
|
|
846
852
|
* @param {object} event Event object
|
|
@@ -866,13 +872,13 @@ export type BryntumDatePickerProps = {
|
|
|
866
872
|
* @param {object} event Event object
|
|
867
873
|
* @param {any} event.state State object config
|
|
868
874
|
*/
|
|
869
|
-
onBeforeStateApply? : ((event: { state: any }) =>
|
|
875
|
+
onBeforeStateApply? : ((event: { state: any }) => boolean|void)|string
|
|
870
876
|
/**
|
|
871
877
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
872
878
|
* @param {object} event Event object
|
|
873
879
|
* @param {any} event.state State object config
|
|
874
880
|
*/
|
|
875
|
-
onBeforeStateSave? : ((event: { state: any }) =>
|
|
881
|
+
onBeforeStateSave? : ((event: { state: any }) => boolean|void)|string
|
|
876
882
|
/**
|
|
877
883
|
* Fires when any other event is fired from the object.
|
|
878
884
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DatePicker#event-catchAll)
|
|
@@ -34,6 +34,8 @@ export type BryntumDateRangeFieldProps = {
|
|
|
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/DateRangeField#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -87,6 +89,15 @@ export type BryntumDateRangeFieldProps = {
|
|
|
87
89
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
88
90
|
*/
|
|
89
91
|
centered? : boolean
|
|
92
|
+
/**
|
|
93
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
94
|
+
* 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)
|
|
95
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
|
|
96
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DateRangeField#config-checkValidity)
|
|
97
|
+
* @param {Core.widget.Field} field The field being validated
|
|
98
|
+
* @returns {void}
|
|
99
|
+
*/
|
|
100
|
+
checkValidity? : ((field: Field) => void)|string
|
|
90
101
|
/**
|
|
91
102
|
* 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
|
|
92
103
|
* 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
|
|
@@ -313,10 +324,14 @@ export type BryntumDateRangeFieldProps = {
|
|
|
313
324
|
inputWidth? : string|number
|
|
314
325
|
/**
|
|
315
326
|
* 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.
|
|
327
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
328
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DateRangeField#config-insertBefore)
|
|
316
329
|
*/
|
|
317
330
|
insertBefore? : HTMLElement|string
|
|
318
331
|
/**
|
|
319
332
|
* 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.
|
|
333
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
334
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DateRangeField#config-insertFirst)
|
|
320
335
|
*/
|
|
321
336
|
insertFirst? : HTMLElement|string
|
|
322
337
|
/**
|
|
@@ -672,7 +687,7 @@ export type BryntumDateRangeFieldProps = {
|
|
|
672
687
|
* @param {object} event Event object
|
|
673
688
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
674
689
|
*/
|
|
675
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
690
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
676
691
|
/**
|
|
677
692
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
678
693
|
* @param {object} event Event object
|
|
@@ -821,6 +836,7 @@ export class BryntumDateRangeField extends React.Component<BryntumDateRangeField
|
|
|
821
836
|
'autoSelect',
|
|
822
837
|
'bubbleEvents',
|
|
823
838
|
'centered',
|
|
839
|
+
'checkValidity',
|
|
824
840
|
'clearable',
|
|
825
841
|
'color',
|
|
826
842
|
'config',
|
|
@@ -34,6 +34,8 @@ export type BryntumDateTimeFieldProps = {
|
|
|
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/DateTimeField#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -78,6 +80,15 @@ export type BryntumDateTimeFieldProps = {
|
|
|
78
80
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
79
81
|
*/
|
|
80
82
|
centered? : boolean
|
|
83
|
+
/**
|
|
84
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
85
|
+
* 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)
|
|
86
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
|
|
87
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DateTimeField#config-checkValidity)
|
|
88
|
+
* @param {Core.widget.Field} field The field being validated
|
|
89
|
+
* @returns {void}
|
|
90
|
+
*/
|
|
91
|
+
checkValidity? : ((field: Field) => void)|string
|
|
81
92
|
/**
|
|
82
93
|
* 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
|
|
83
94
|
* 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
|
|
@@ -267,10 +278,14 @@ export type BryntumDateTimeFieldProps = {
|
|
|
267
278
|
inputTag? : string
|
|
268
279
|
/**
|
|
269
280
|
* 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.
|
|
281
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
282
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DateTimeField#config-insertBefore)
|
|
270
283
|
*/
|
|
271
284
|
insertBefore? : HTMLElement|string
|
|
272
285
|
/**
|
|
273
286
|
* 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.
|
|
287
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
288
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DateTimeField#config-insertFirst)
|
|
274
289
|
*/
|
|
275
290
|
insertFirst? : HTMLElement|string
|
|
276
291
|
/**
|
|
@@ -581,7 +596,7 @@ export type BryntumDateTimeFieldProps = {
|
|
|
581
596
|
* @param {object} event Event object
|
|
582
597
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
583
598
|
*/
|
|
584
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
599
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
585
600
|
/**
|
|
586
601
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
587
602
|
* @param {object} event Event object
|
|
@@ -728,6 +743,7 @@ export class BryntumDateTimeField extends React.Component<BryntumDateTimeFieldPr
|
|
|
728
743
|
'autoSelect',
|
|
729
744
|
'bubbleEvents',
|
|
730
745
|
'centered',
|
|
746
|
+
'checkValidity',
|
|
731
747
|
'clearable',
|
|
732
748
|
'color',
|
|
733
749
|
'config',
|
|
@@ -34,6 +34,8 @@ export type BryntumDemoCodeEditorProps = {
|
|
|
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/DemoCodeEditor#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -304,10 +306,14 @@ export type BryntumDemoCodeEditorProps = {
|
|
|
304
306
|
inputFieldAlign? : 'start'|'end'
|
|
305
307
|
/**
|
|
306
308
|
* 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.
|
|
309
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
310
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DemoCodeEditor#config-insertBefore)
|
|
307
311
|
*/
|
|
308
312
|
insertBefore? : HTMLElement|string
|
|
309
313
|
/**
|
|
310
314
|
* 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.
|
|
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/DemoCodeEditor#config-insertFirst)
|
|
311
317
|
*/
|
|
312
318
|
insertFirst? : HTMLElement|string
|
|
313
319
|
/**
|
|
@@ -676,7 +682,7 @@ export type BryntumDemoCodeEditorProps = {
|
|
|
676
682
|
* @param {object} event Event object
|
|
677
683
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
678
684
|
*/
|
|
679
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
685
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
680
686
|
/**
|
|
681
687
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
682
688
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -696,13 +702,13 @@ export type BryntumDemoCodeEditorProps = {
|
|
|
696
702
|
* @param {object} event Event object
|
|
697
703
|
* @param {any} event.state State object config
|
|
698
704
|
*/
|
|
699
|
-
onBeforeStateApply? : ((event: { state: any }) =>
|
|
705
|
+
onBeforeStateApply? : ((event: { state: any }) => boolean|void)|string
|
|
700
706
|
/**
|
|
701
707
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
702
708
|
* @param {object} event Event object
|
|
703
709
|
* @param {any} event.state State object config
|
|
704
710
|
*/
|
|
705
|
-
onBeforeStateSave? : ((event: { state: any }) =>
|
|
711
|
+
onBeforeStateSave? : ((event: { state: any }) => boolean|void)|string
|
|
706
712
|
/**
|
|
707
713
|
* Fires when any other event is fired from the object.
|
|
708
714
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DemoCodeEditor#event-catchAll)
|
|
@@ -34,6 +34,8 @@ export type BryntumDisplayFieldProps = {
|
|
|
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/DisplayField#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -83,6 +85,15 @@ export type BryntumDisplayFieldProps = {
|
|
|
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/DisplayField#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 BryntumDisplayFieldProps = {
|
|
|
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/DisplayField#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/DisplayField#config-insertFirst)
|
|
293
308
|
*/
|
|
294
309
|
insertFirst? : HTMLElement|string
|
|
295
310
|
/**
|
|
@@ -612,7 +627,7 @@ export type BryntumDisplayFieldProps = {
|
|
|
612
627
|
* @param {object} event Event object
|
|
613
628
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
614
629
|
*/
|
|
615
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
630
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
616
631
|
/**
|
|
617
632
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
618
633
|
* @param {object} event Event object
|
|
@@ -760,6 +775,7 @@ export class BryntumDisplayField extends React.Component<BryntumDisplayFieldProp
|
|
|
760
775
|
'autoSelect',
|
|
761
776
|
'bubbleEvents',
|
|
762
777
|
'centered',
|
|
778
|
+
'checkValidity',
|
|
763
779
|
'clearable',
|
|
764
780
|
'color',
|
|
765
781
|
'config',
|
|
@@ -43,6 +43,8 @@ export type BryntumDurationFieldProps = {
|
|
|
43
43
|
/**
|
|
44
44
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
45
45
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
46
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
47
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DurationField#config-appendTo)
|
|
46
48
|
*/
|
|
47
49
|
appendTo? : HTMLElement|string
|
|
48
50
|
/**
|
|
@@ -92,6 +94,15 @@ export type BryntumDurationFieldProps = {
|
|
|
92
94
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
93
95
|
*/
|
|
94
96
|
centered? : boolean
|
|
97
|
+
/**
|
|
98
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
99
|
+
* 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)
|
|
100
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
|
|
101
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/DurationField#config-checkValidity)
|
|
102
|
+
* @param {Core.widget.Field} field The field being validated
|
|
103
|
+
* @returns {void}
|
|
104
|
+
*/
|
|
105
|
+
checkValidity? : ((field: Field) => void)|string
|
|
95
106
|
/**
|
|
96
107
|
* 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
|
|
97
108
|
* 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
|
|
@@ -299,10 +310,14 @@ export type BryntumDurationFieldProps = {
|
|
|
299
310
|
inputWidth? : string|number
|
|
300
311
|
/**
|
|
301
312
|
* 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.
|
|
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/DurationField#config-insertBefore)
|
|
302
315
|
*/
|
|
303
316
|
insertBefore? : HTMLElement|string
|
|
304
317
|
/**
|
|
305
318
|
* 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.
|
|
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/DurationField#config-insertFirst)
|
|
306
321
|
*/
|
|
307
322
|
insertFirst? : HTMLElement|string
|
|
308
323
|
/**
|
|
@@ -660,7 +675,7 @@ export type BryntumDurationFieldProps = {
|
|
|
660
675
|
* @param {object} event Event object
|
|
661
676
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
662
677
|
*/
|
|
663
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
678
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
664
679
|
/**
|
|
665
680
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
666
681
|
* @param {object} event Event object
|
|
@@ -808,6 +823,7 @@ export class BryntumDurationField extends React.Component<BryntumDurationFieldPr
|
|
|
808
823
|
'autoSelect',
|
|
809
824
|
'bubbleEvents',
|
|
810
825
|
'centered',
|
|
826
|
+
'checkValidity',
|
|
811
827
|
'clearable',
|
|
812
828
|
'color',
|
|
813
829
|
'config',
|
package/src/BryntumEditor.tsx
CHANGED
|
@@ -33,6 +33,8 @@ export type BryntumEditorProps = {
|
|
|
33
33
|
/**
|
|
34
34
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
35
35
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
36
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
37
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-appendTo)
|
|
36
38
|
*/
|
|
37
39
|
appendTo? : HTMLElement|string
|
|
38
40
|
/**
|
|
@@ -276,10 +278,14 @@ export type BryntumEditorProps = {
|
|
|
276
278
|
inputFieldAlign? : 'start'|'end'
|
|
277
279
|
/**
|
|
278
280
|
* 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.
|
|
281
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
282
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-insertBefore)
|
|
279
283
|
*/
|
|
280
284
|
insertBefore? : HTMLElement|string
|
|
281
285
|
/**
|
|
282
286
|
* 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.
|
|
287
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
288
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Editor#config-insertFirst)
|
|
283
289
|
*/
|
|
284
290
|
insertFirst? : HTMLElement|string
|
|
285
291
|
/**
|
|
@@ -593,7 +599,7 @@ export type BryntumEditorProps = {
|
|
|
593
599
|
* @param {Event} event.event Included if the cancellation was triggered by a DOM event
|
|
594
600
|
* @param {Core.widget.Editor} event.source The Editor that triggered the event.
|
|
595
601
|
*/
|
|
596
|
-
onBeforeCancel? : ((event: { oldValue: object, value: object, event: Event, source: Editor }) =>
|
|
602
|
+
onBeforeCancel? : ((event: { oldValue: object, value: object, event: Event, source: Editor }) => boolean|void)|string
|
|
597
603
|
/**
|
|
598
604
|
* Fired when an edit completion has been requested, either by <kbd>Enter</kbd>, or focus loss (if configured to complete on blur).
|
|
599
605
|
* The completion may be vetoed, in which case, focus is moved back into the editor.
|
|
@@ -604,7 +610,7 @@ export type BryntumEditorProps = {
|
|
|
604
610
|
* @param {Function} [event.finalize] An async function may be injected into this property which performs asynchronous finalization tasks such as complex validation of confirmation. The value `true` or `false` must be returned.
|
|
605
611
|
* @param {object} [event.finalize.context] An object describing the editing context upon requested completion of the edit.
|
|
606
612
|
*/
|
|
607
|
-
onBeforeComplete? : ((event: { oldValue: object, value: object, source: Editor, finalize: { context?: object } }) =>
|
|
613
|
+
onBeforeComplete? : ((event: { oldValue: object, value: object, source: Editor, finalize: { context?: object } }) => boolean|void)|string
|
|
608
614
|
/**
|
|
609
615
|
* Fires before an object is destroyed.
|
|
610
616
|
* @param {object} event Event object
|
|
@@ -616,7 +622,7 @@ export type BryntumEditorProps = {
|
|
|
616
622
|
* @param {object} event Event object
|
|
617
623
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
618
624
|
*/
|
|
619
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
625
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
620
626
|
/**
|
|
621
627
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
622
628
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -634,7 +640,7 @@ export type BryntumEditorProps = {
|
|
|
634
640
|
/**
|
|
635
641
|
* Fired before the editor is shown to start an edit operation. Returning `false` from a handler vetoes the edit operation.
|
|
636
642
|
* @param {object} event Event object
|
|
637
|
-
* @param {
|
|
643
|
+
* @param {Element} event.target The element which the Editor is to overlay to edit its content.
|
|
638
644
|
* @param {Core.data.Model} [event.record] The record being edited.
|
|
639
645
|
* @param {string} [event.field] The name of the field if a record is being edited.
|
|
640
646
|
* @param {object} event.value The value to be edited.
|
|
@@ -646,7 +652,7 @@ export type BryntumEditorProps = {
|
|
|
646
652
|
* @param {boolean} event.matchFont Whether to match the target's font. See [matchFont](https://bryntum.com/products/core/docs/api/Core/widget/Editor#config-matchFont)
|
|
647
653
|
* @param {boolean} event.focus Whether to focus the editor's field.
|
|
648
654
|
*/
|
|
649
|
-
onBeforeStart? : ((event: { target:
|
|
655
|
+
onBeforeStart? : ((event: { target: Element, record?: Model, field?: string, value: object, align: string|AlignSpec, hideTarget: boolean, matchSize: { width: boolean, height: boolean }, matchFont: boolean, focus: boolean }) => boolean|void)|string
|
|
650
656
|
/**
|
|
651
657
|
* Edit has been canceled without updating the associated record or element.
|
|
652
658
|
* @param {object} event Event object
|
|
@@ -34,6 +34,8 @@ export type BryntumFieldFilterPickerProps = {
|
|
|
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/FieldFilterPicker#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -262,10 +264,14 @@ export type BryntumFieldFilterPickerProps = {
|
|
|
262
264
|
inputFieldAlign? : 'start'|'end'
|
|
263
265
|
/**
|
|
264
266
|
* 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.
|
|
267
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
268
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPicker#config-insertBefore)
|
|
265
269
|
*/
|
|
266
270
|
insertBefore? : HTMLElement|string
|
|
267
271
|
/**
|
|
268
272
|
* 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.
|
|
273
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
274
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPicker#config-insertFirst)
|
|
269
275
|
*/
|
|
270
276
|
insertFirst? : HTMLElement|string
|
|
271
277
|
/**
|
|
@@ -592,7 +598,7 @@ export type BryntumFieldFilterPickerProps = {
|
|
|
592
598
|
* @param {object} event Event object
|
|
593
599
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
594
600
|
*/
|
|
595
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
601
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
596
602
|
/**
|
|
597
603
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
598
604
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -44,6 +44,8 @@ export type BryntumFieldFilterPickerGroupProps = {
|
|
|
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/FieldFilterPickerGroup#config-appendTo)
|
|
47
49
|
*/
|
|
48
50
|
appendTo? : HTMLElement|string
|
|
49
51
|
/**
|
|
@@ -290,10 +292,14 @@ export type BryntumFieldFilterPickerGroupProps = {
|
|
|
290
292
|
inputFieldAlign? : 'start'|'end'
|
|
291
293
|
/**
|
|
292
294
|
* 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.
|
|
295
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
296
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPickerGroup#config-insertBefore)
|
|
293
297
|
*/
|
|
294
298
|
insertBefore? : HTMLElement|string
|
|
295
299
|
/**
|
|
296
300
|
* 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.
|
|
301
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
302
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPickerGroup#config-insertFirst)
|
|
297
303
|
*/
|
|
298
304
|
insertFirst? : HTMLElement|string
|
|
299
305
|
/**
|
|
@@ -608,7 +614,7 @@ export type BryntumFieldFilterPickerGroupProps = {
|
|
|
608
614
|
* @param {Core.widget.FieldFilterPicker} event.source The FieldFilterPicker instance that fired the event.
|
|
609
615
|
* @param {CollectionFilterConfig} event.filter The [CollectionFilter](https://bryntum.com/products/core/docs/api/Core/util/CollectionFilter) configuration object for the filter represented by this [FieldFilterPicker](https://bryntum.com/products/core/docs/api/Core/widget/FieldFilterPicker).
|
|
610
616
|
*/
|
|
611
|
-
onBeforeAddFilter? : ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) =>
|
|
617
|
+
onBeforeAddFilter? : ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) => boolean|void)|string
|
|
612
618
|
/**
|
|
613
619
|
* Fires before an object is destroyed.
|
|
614
620
|
* @param {object} event Event object
|
|
@@ -620,7 +626,7 @@ export type BryntumFieldFilterPickerGroupProps = {
|
|
|
620
626
|
* @param {object} event Event object
|
|
621
627
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
622
628
|
*/
|
|
623
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
629
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
624
630
|
/**
|
|
625
631
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
626
632
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
package/src/BryntumFieldSet.tsx
CHANGED
|
@@ -34,6 +34,8 @@ export type BryntumFieldSetProps = {
|
|
|
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/FieldSet#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -297,10 +299,14 @@ export type BryntumFieldSetProps = {
|
|
|
297
299
|
inputFieldAlign? : 'start'|'end'
|
|
298
300
|
/**
|
|
299
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/FieldSet#config-insertBefore)
|
|
300
304
|
*/
|
|
301
305
|
insertBefore? : HTMLElement|string
|
|
302
306
|
/**
|
|
303
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/FieldSet#config-insertFirst)
|
|
304
310
|
*/
|
|
305
311
|
insertFirst? : HTMLElement|string
|
|
306
312
|
/**
|
|
@@ -653,7 +659,7 @@ export type BryntumFieldSetProps = {
|
|
|
653
659
|
* @param {object} event Event object
|
|
654
660
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
655
661
|
*/
|
|
656
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
662
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
657
663
|
/**
|
|
658
664
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
659
665
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -673,13 +679,13 @@ export type BryntumFieldSetProps = {
|
|
|
673
679
|
* @param {object} event Event object
|
|
674
680
|
* @param {any} event.state State object config
|
|
675
681
|
*/
|
|
676
|
-
onBeforeStateApply? : ((event: { state: any }) =>
|
|
682
|
+
onBeforeStateApply? : ((event: { state: any }) => boolean|void)|string
|
|
677
683
|
/**
|
|
678
684
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
679
685
|
* @param {object} event Event object
|
|
680
686
|
* @param {any} event.state State object config
|
|
681
687
|
*/
|
|
682
|
-
onBeforeStateSave? : ((event: { state: any }) =>
|
|
688
|
+
onBeforeStateSave? : ((event: { state: any }) => boolean|void)|string
|
|
683
689
|
/**
|
|
684
690
|
* Fires when any other event is fired from the object.
|
|
685
691
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FieldSet#event-catchAll)
|
package/src/BryntumFileField.tsx
CHANGED
|
@@ -39,6 +39,8 @@ export type BryntumFileFieldProps = {
|
|
|
39
39
|
/**
|
|
40
40
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
41
41
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
42
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
43
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-appendTo)
|
|
42
44
|
*/
|
|
43
45
|
appendTo? : HTMLElement|string
|
|
44
46
|
/**
|
|
@@ -88,6 +90,15 @@ export type BryntumFileFieldProps = {
|
|
|
88
90
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
89
91
|
*/
|
|
90
92
|
centered? : boolean
|
|
93
|
+
/**
|
|
94
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
95
|
+
* 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)
|
|
96
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
|
|
97
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-checkValidity)
|
|
98
|
+
* @param {Core.widget.Field} field The field being validated
|
|
99
|
+
* @returns {void}
|
|
100
|
+
*/
|
|
101
|
+
checkValidity? : ((field: Field) => void)|string
|
|
91
102
|
/**
|
|
92
103
|
* 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
|
|
93
104
|
* 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
|
|
@@ -291,10 +302,14 @@ export type BryntumFileFieldProps = {
|
|
|
291
302
|
inputWidth? : string|number
|
|
292
303
|
/**
|
|
293
304
|
* 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.
|
|
305
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
306
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-insertBefore)
|
|
294
307
|
*/
|
|
295
308
|
insertBefore? : HTMLElement|string
|
|
296
309
|
/**
|
|
297
310
|
* 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.
|
|
311
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
312
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FileField#config-insertFirst)
|
|
298
313
|
*/
|
|
299
314
|
insertFirst? : HTMLElement|string
|
|
300
315
|
/**
|
|
@@ -615,7 +630,7 @@ export type BryntumFileFieldProps = {
|
|
|
615
630
|
* @param {object} event Event object
|
|
616
631
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
617
632
|
*/
|
|
618
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
633
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
619
634
|
/**
|
|
620
635
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
621
636
|
* @param {object} event Event object
|
|
@@ -764,6 +779,7 @@ export class BryntumFileField extends React.Component<BryntumFileFieldProps> {
|
|
|
764
779
|
'autoSelect',
|
|
765
780
|
'bubbleEvents',
|
|
766
781
|
'centered',
|
|
782
|
+
'checkValidity',
|
|
767
783
|
'clearable',
|
|
768
784
|
'color',
|
|
769
785
|
'config',
|
|
@@ -34,6 +34,8 @@ export type BryntumFilePickerProps = {
|
|
|
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/FilePicker#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -246,10 +248,14 @@ export type BryntumFilePickerProps = {
|
|
|
246
248
|
inputFieldAlign? : 'start'|'end'
|
|
247
249
|
/**
|
|
248
250
|
* 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.
|
|
251
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
252
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilePicker#config-insertBefore)
|
|
249
253
|
*/
|
|
250
254
|
insertBefore? : HTMLElement|string
|
|
251
255
|
/**
|
|
252
256
|
* 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.
|
|
257
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
258
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/FilePicker#config-insertFirst)
|
|
253
259
|
*/
|
|
254
260
|
insertFirst? : HTMLElement|string
|
|
255
261
|
/**
|
|
@@ -545,7 +551,7 @@ export type BryntumFilePickerProps = {
|
|
|
545
551
|
* @param {object} event Event object
|
|
546
552
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
547
553
|
*/
|
|
548
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
554
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
549
555
|
/**
|
|
550
556
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
551
557
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|