@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
package/package.json
CHANGED
|
@@ -34,6 +34,8 @@ export type BryntumBooleanComboProps = {
|
|
|
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/BooleanCombo#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -96,6 +98,15 @@ export type BryntumBooleanComboProps = {
|
|
|
96
98
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
97
99
|
*/
|
|
98
100
|
centered? : boolean
|
|
101
|
+
/**
|
|
102
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
103
|
+
* 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)
|
|
104
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
|
|
105
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-checkValidity)
|
|
106
|
+
* @param {Core.widget.Field} field The field being validated
|
|
107
|
+
* @returns {void}
|
|
108
|
+
*/
|
|
109
|
+
checkValidity? : ((field: Field) => void)|string
|
|
99
110
|
/**
|
|
100
111
|
* A config object to configure the [ChipView](https://bryntum.com/products/core/docs/api/Core/widget/ChipView) to display the
|
|
101
112
|
* selected value set when [multiSelect](https://bryntum.com/products/core/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
|
|
@@ -389,10 +400,14 @@ export type BryntumBooleanComboProps = {
|
|
|
389
400
|
inputWidth? : string|number
|
|
390
401
|
/**
|
|
391
402
|
* 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.
|
|
403
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
404
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-insertBefore)
|
|
392
405
|
*/
|
|
393
406
|
insertBefore? : HTMLElement|string
|
|
394
407
|
/**
|
|
395
408
|
* 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.
|
|
409
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
410
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/BooleanCombo#config-insertFirst)
|
|
396
411
|
*/
|
|
397
412
|
insertFirst? : HTMLElement|string
|
|
398
413
|
/**
|
|
@@ -814,7 +829,7 @@ export type BryntumBooleanComboProps = {
|
|
|
814
829
|
* @param {object} event Event object
|
|
815
830
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
816
831
|
*/
|
|
817
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
832
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
818
833
|
/**
|
|
819
834
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
820
835
|
* @param {object} event Event object
|
|
@@ -975,6 +990,7 @@ export class BryntumBooleanCombo extends React.Component<BryntumBooleanComboProp
|
|
|
975
990
|
'cacheLastResult',
|
|
976
991
|
'caseSensitive',
|
|
977
992
|
'centered',
|
|
993
|
+
'checkValidity',
|
|
978
994
|
'chipView',
|
|
979
995
|
'clearable',
|
|
980
996
|
'clearTextOnPickerHide',
|
package/src/BryntumButton.tsx
CHANGED
|
@@ -34,6 +34,8 @@ export type BryntumButtonProps = {
|
|
|
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/Button#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -227,10 +229,14 @@ export type BryntumButtonProps = {
|
|
|
227
229
|
ignoreParentReadOnly? : boolean
|
|
228
230
|
/**
|
|
229
231
|
* 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.
|
|
232
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
233
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-insertBefore)
|
|
230
234
|
*/
|
|
231
235
|
insertBefore? : HTMLElement|string
|
|
232
236
|
/**
|
|
233
237
|
* 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.
|
|
238
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
239
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#config-insertFirst)
|
|
234
240
|
*/
|
|
235
241
|
insertFirst? : HTMLElement|string
|
|
236
242
|
/**
|
|
@@ -528,7 +534,7 @@ export type BryntumButtonProps = {
|
|
|
528
534
|
* @param {object} event Event object
|
|
529
535
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
530
536
|
*/
|
|
531
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
537
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
532
538
|
/**
|
|
533
539
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
534
540
|
* @param {object} event Event object
|
|
@@ -543,7 +549,7 @@ export type BryntumButtonProps = {
|
|
|
543
549
|
* @param {boolean} event.userAction `true` if the toggle was triggered by a user action (click), `false` if it was triggered programmatically.
|
|
544
550
|
* @param {Event} event.domEvent The original DOM event that triggered the action, if any. Using the `pointerType` property of this event can help determine if it was a mouse, touch or pen action.
|
|
545
551
|
*/
|
|
546
|
-
onBeforeShowMenu? : ((event: { source: Button, menu: Menu, userAction: boolean, domEvent: Event }) =>
|
|
552
|
+
onBeforeShowMenu? : ((event: { source: Button, menu: Menu, userAction: boolean, domEvent: Event }) => boolean|void)|string
|
|
547
553
|
/**
|
|
548
554
|
* Fires before the button is toggled (the [pressed](https://bryntum.com/products/core/docs/api/Core/widget/Button#property-pressed) state is changed). If the button is part of
|
|
549
555
|
* a [toggleGroup](https://bryntum.com/products/core/docs/api/Core/widget/Button#config-toggleGroup) and you need to process the pressed button only, consider using
|
|
@@ -555,7 +561,7 @@ export type BryntumButtonProps = {
|
|
|
555
561
|
* @param {boolean} event.userAction `true` if the toggle was triggered by a user action (click), `false` if it was triggered programmatically.
|
|
556
562
|
* @param {Event} event.domEvent The original DOM event that triggered the action, if any. Using the `pointerType` property of this event can help determine if it was a mouse, touch or pen action.
|
|
557
563
|
*/
|
|
558
|
-
onBeforeToggle? : ((event: { source: Button, pressed: boolean, userAction: boolean, domEvent: Event }) =>
|
|
564
|
+
onBeforeToggle? : ((event: { source: Button, pressed: boolean, userAction: boolean, domEvent: Event }) => boolean|void)|string
|
|
559
565
|
/**
|
|
560
566
|
* Fires when any other event is fired from the object.
|
|
561
567
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Button#event-catchAll)
|
|
@@ -34,6 +34,8 @@ export type BryntumButtonGroupProps = {
|
|
|
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/ButtonGroup#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -235,10 +237,14 @@ export type BryntumButtonGroupProps = {
|
|
|
235
237
|
inputFieldAlign? : 'start'|'end'
|
|
236
238
|
/**
|
|
237
239
|
* 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.
|
|
240
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
241
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ButtonGroup#config-insertBefore)
|
|
238
242
|
*/
|
|
239
243
|
insertBefore? : HTMLElement|string
|
|
240
244
|
/**
|
|
241
245
|
* 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.
|
|
246
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
247
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ButtonGroup#config-insertFirst)
|
|
242
248
|
*/
|
|
243
249
|
insertFirst? : HTMLElement|string
|
|
244
250
|
/**
|
|
@@ -553,7 +559,7 @@ export type BryntumButtonGroupProps = {
|
|
|
553
559
|
* @param {object} event Event object
|
|
554
560
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
555
561
|
*/
|
|
556
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
562
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
557
563
|
/**
|
|
558
564
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
559
565
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
package/src/BryntumChatPanel.tsx
CHANGED
|
@@ -38,6 +38,8 @@ export type BryntumChatPanelProps = {
|
|
|
38
38
|
/**
|
|
39
39
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
40
40
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
41
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
42
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/chat/ChatPanel#config-appendTo)
|
|
41
43
|
*/
|
|
42
44
|
appendTo? : HTMLElement|string
|
|
43
45
|
/**
|
|
@@ -310,10 +312,14 @@ export type BryntumChatPanelProps = {
|
|
|
310
312
|
inputFieldAlign? : 'start'|'end'
|
|
311
313
|
/**
|
|
312
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/chat/ChatPanel#config-insertBefore)
|
|
313
317
|
*/
|
|
314
318
|
insertBefore? : HTMLElement|string
|
|
315
319
|
/**
|
|
316
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/chat/ChatPanel#config-insertFirst)
|
|
317
323
|
*/
|
|
318
324
|
insertFirst? : HTMLElement|string
|
|
319
325
|
/**
|
|
@@ -682,7 +688,7 @@ export type BryntumChatPanelProps = {
|
|
|
682
688
|
* @param {object} event Event object
|
|
683
689
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
684
690
|
*/
|
|
685
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
691
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
686
692
|
/**
|
|
687
693
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
688
694
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -702,13 +708,13 @@ export type BryntumChatPanelProps = {
|
|
|
702
708
|
* @param {object} event Event object
|
|
703
709
|
* @param {any} event.state State object config
|
|
704
710
|
*/
|
|
705
|
-
onBeforeStateApply? : ((event: { state: any }) =>
|
|
711
|
+
onBeforeStateApply? : ((event: { state: any }) => boolean|void)|string
|
|
706
712
|
/**
|
|
707
713
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
708
714
|
* @param {object} event Event object
|
|
709
715
|
* @param {any} event.state State object config
|
|
710
716
|
*/
|
|
711
|
-
onBeforeStateSave? : ((event: { state: any }) =>
|
|
717
|
+
onBeforeStateSave? : ((event: { state: any }) => boolean|void)|string
|
|
712
718
|
/**
|
|
713
719
|
* Fired when the chat bubble tool icon is clicked.
|
|
714
720
|
* @param {object} event Event object
|
package/src/BryntumCheckbox.tsx
CHANGED
|
@@ -34,6 +34,8 @@ export type BryntumCheckboxProps = {
|
|
|
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/Checkbox#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -100,6 +102,15 @@ export type BryntumCheckboxProps = {
|
|
|
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/Checkbox#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 BryntumCheckboxProps = {
|
|
|
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/Checkbox#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/Checkbox#config-insertFirst)
|
|
295
310
|
*/
|
|
296
311
|
insertFirst? : HTMLElement|string
|
|
297
312
|
/**
|
|
@@ -610,7 +625,7 @@ export type BryntumCheckboxProps = {
|
|
|
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 BryntumCheckboxProps = {
|
|
|
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 BryntumCheckbox extends React.Component<BryntumCheckboxProps> {
|
|
|
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 BryntumCheckboxGroupProps = {
|
|
|
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/CheckboxGroup#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -297,10 +299,14 @@ export type BryntumCheckboxGroupProps = {
|
|
|
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/CheckboxGroup#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/CheckboxGroup#config-insertFirst)
|
|
304
310
|
*/
|
|
305
311
|
insertFirst? : HTMLElement|string
|
|
306
312
|
/**
|
|
@@ -693,7 +699,7 @@ export type BryntumCheckboxGroupProps = {
|
|
|
693
699
|
* @param {object} event Event object
|
|
694
700
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
695
701
|
*/
|
|
696
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
702
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
697
703
|
/**
|
|
698
704
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
699
705
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -713,13 +719,13 @@ export type BryntumCheckboxGroupProps = {
|
|
|
713
719
|
* @param {object} event Event object
|
|
714
720
|
* @param {any} event.state State object config
|
|
715
721
|
*/
|
|
716
|
-
onBeforeStateApply? : ((event: { state: any }) =>
|
|
722
|
+
onBeforeStateApply? : ((event: { state: any }) => boolean|void)|string
|
|
717
723
|
/**
|
|
718
724
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
719
725
|
* @param {object} event Event object
|
|
720
726
|
* @param {any} event.state State object config
|
|
721
727
|
*/
|
|
722
|
-
onBeforeStateSave? : ((event: { state: any }) =>
|
|
728
|
+
onBeforeStateSave? : ((event: { state: any }) => boolean|void)|string
|
|
723
729
|
/**
|
|
724
730
|
* Fires when any other event is fired from the object.
|
|
725
731
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CheckboxGroup#event-catchAll)
|
package/src/BryntumChipView.tsx
CHANGED
|
@@ -44,6 +44,8 @@ export type BryntumChipViewProps = {
|
|
|
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/ChipView#config-appendTo)
|
|
47
49
|
*/
|
|
48
50
|
appendTo? : HTMLElement|string
|
|
49
51
|
/**
|
|
@@ -93,9 +95,11 @@ export type BryntumChipViewProps = {
|
|
|
93
95
|
/**
|
|
94
96
|
* If [closable](https://bryntum.com/products/core/docs/api/Core/widget/ChipView#config-closable) is `true`, this is the name of a callback function to handle what the "close"
|
|
95
97
|
* action means. If not provided, the record representing the chip is removed from the store.
|
|
98
|
+
* @param {Core.data.Model[]} records Records to be closed
|
|
99
|
+
* @param {object} options Close options
|
|
96
100
|
* @returns {void}
|
|
97
101
|
*/
|
|
98
|
-
closeHandler? : string|(() => void)
|
|
102
|
+
closeHandler? : string|((records: Model[], options: object) => void)
|
|
99
103
|
/**
|
|
100
104
|
* Custom CSS classes to add to element.
|
|
101
105
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -272,10 +276,14 @@ export type BryntumChipViewProps = {
|
|
|
272
276
|
ignoreParentReadOnly? : boolean
|
|
273
277
|
/**
|
|
274
278
|
* 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.
|
|
279
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
280
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-insertBefore)
|
|
275
281
|
*/
|
|
276
282
|
insertBefore? : HTMLElement|string
|
|
277
283
|
/**
|
|
278
284
|
* 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.
|
|
285
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
286
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-insertFirst)
|
|
279
287
|
*/
|
|
280
288
|
insertFirst? : HTMLElement|string
|
|
281
289
|
/**
|
|
@@ -553,7 +561,7 @@ export type BryntumChipViewProps = {
|
|
|
553
561
|
* @param {object} event Event object
|
|
554
562
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
555
563
|
*/
|
|
556
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
564
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
557
565
|
/**
|
|
558
566
|
* User going to activate an item in the list either by pointer or keyboard.
|
|
559
567
|
* The active record, list item index, and the triggering event are passed.
|
|
@@ -565,7 +573,7 @@ export type BryntumChipViewProps = {
|
|
|
565
573
|
* @param {number} event.index List item index
|
|
566
574
|
* @param {Event} event.event Triggering event
|
|
567
575
|
*/
|
|
568
|
-
onBeforeItem? : ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) =>
|
|
576
|
+
onBeforeItem? : ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => boolean|void)|string
|
|
569
577
|
/**
|
|
570
578
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
571
579
|
* @param {object} event Event object
|
|
@@ -34,6 +34,8 @@ export type BryntumCodeEditorProps = {
|
|
|
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/CodeEditor#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -300,10 +302,14 @@ export type BryntumCodeEditorProps = {
|
|
|
300
302
|
inputFieldAlign? : 'start'|'end'
|
|
301
303
|
/**
|
|
302
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/CodeEditor#config-insertBefore)
|
|
303
307
|
*/
|
|
304
308
|
insertBefore? : HTMLElement|string
|
|
305
309
|
/**
|
|
306
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/CodeEditor#config-insertFirst)
|
|
307
313
|
*/
|
|
308
314
|
insertFirst? : HTMLElement|string
|
|
309
315
|
/**
|
|
@@ -663,7 +669,7 @@ export type BryntumCodeEditorProps = {
|
|
|
663
669
|
* @param {object} event Event object
|
|
664
670
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
665
671
|
*/
|
|
666
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
672
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
667
673
|
/**
|
|
668
674
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
669
675
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -683,13 +689,13 @@ export type BryntumCodeEditorProps = {
|
|
|
683
689
|
* @param {object} event Event object
|
|
684
690
|
* @param {any} event.state State object config
|
|
685
691
|
*/
|
|
686
|
-
onBeforeStateApply? : ((event: { state: any }) =>
|
|
692
|
+
onBeforeStateApply? : ((event: { state: any }) => boolean|void)|string
|
|
687
693
|
/**
|
|
688
694
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
689
695
|
* @param {object} event Event object
|
|
690
696
|
* @param {any} event.state State object config
|
|
691
697
|
*/
|
|
692
|
-
onBeforeStateSave? : ((event: { state: any }) =>
|
|
698
|
+
onBeforeStateSave? : ((event: { state: any }) => boolean|void)|string
|
|
693
699
|
/**
|
|
694
700
|
* Fires when any other event is fired from the object.
|
|
695
701
|
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/CodeEditor#event-catchAll)
|
|
@@ -38,6 +38,8 @@ export type BryntumColorFieldProps = {
|
|
|
38
38
|
/**
|
|
39
39
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
40
40
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/core/docs/api/Core/widget/Widget#property-element).
|
|
41
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
42
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-appendTo)
|
|
41
43
|
*/
|
|
42
44
|
appendTo? : HTMLElement|string
|
|
43
45
|
/**
|
|
@@ -91,6 +93,15 @@ export type BryntumColorFieldProps = {
|
|
|
91
93
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
92
94
|
*/
|
|
93
95
|
centered? : boolean
|
|
96
|
+
/**
|
|
97
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
98
|
+
* 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)
|
|
99
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
|
|
100
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/ColorField#config-checkValidity)
|
|
101
|
+
* @param {Core.widget.Field} field The field being validated
|
|
102
|
+
* @returns {void}
|
|
103
|
+
*/
|
|
104
|
+
checkValidity? : ((field: Field) => void)|string
|
|
94
105
|
/**
|
|
95
106
|
* 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
|
|
96
107
|
* 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
|
|
@@ -288,10 +299,14 @@ export type BryntumColorFieldProps = {
|
|
|
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/ColorField#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/ColorField#config-insertFirst)
|
|
295
310
|
*/
|
|
296
311
|
insertFirst? : HTMLElement|string
|
|
297
312
|
/**
|
|
@@ -623,7 +638,7 @@ export type BryntumColorFieldProps = {
|
|
|
623
638
|
* @param {object} event Event object
|
|
624
639
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
625
640
|
*/
|
|
626
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
641
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
627
642
|
/**
|
|
628
643
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
629
644
|
* @param {object} event Event object
|
|
@@ -772,6 +787,7 @@ export class BryntumColorField extends React.Component<BryntumColorFieldProps> {
|
|
|
772
787
|
'autoSelect',
|
|
773
788
|
'bubbleEvents',
|
|
774
789
|
'centered',
|
|
790
|
+
'checkValidity',
|
|
775
791
|
'clearable',
|
|
776
792
|
'config',
|
|
777
793
|
'constrainTo',
|
package/src/BryntumCombo.tsx
CHANGED
|
@@ -34,6 +34,8 @@ export type BryntumComboProps = {
|
|
|
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/Combo#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -96,6 +98,15 @@ export type BryntumComboProps = {
|
|
|
96
98
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
97
99
|
*/
|
|
98
100
|
centered? : boolean
|
|
101
|
+
/**
|
|
102
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
103
|
+
* 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)
|
|
104
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/core/docs/api/Core/widget/Field#config-required) check.
|
|
105
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-checkValidity)
|
|
106
|
+
* @param {Core.widget.Field} field The field being validated
|
|
107
|
+
* @returns {void}
|
|
108
|
+
*/
|
|
109
|
+
checkValidity? : ((field: Field) => void)|string
|
|
99
110
|
/**
|
|
100
111
|
* A config object to configure the [ChipView](https://bryntum.com/products/core/docs/api/Core/widget/ChipView) to display the
|
|
101
112
|
* selected value set when [multiSelect](https://bryntum.com/products/core/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
|
|
@@ -389,10 +400,14 @@ export type BryntumComboProps = {
|
|
|
389
400
|
inputWidth? : string|number
|
|
390
401
|
/**
|
|
391
402
|
* 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.
|
|
403
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
404
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-insertBefore)
|
|
392
405
|
*/
|
|
393
406
|
insertBefore? : HTMLElement|string
|
|
394
407
|
/**
|
|
395
408
|
* 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.
|
|
409
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
410
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-insertFirst)
|
|
396
411
|
*/
|
|
397
412
|
insertFirst? : HTMLElement|string
|
|
398
413
|
/**
|
|
@@ -799,7 +814,7 @@ export type BryntumComboProps = {
|
|
|
799
814
|
* @param {object} event Event object
|
|
800
815
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
801
816
|
*/
|
|
802
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
817
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
803
818
|
/**
|
|
804
819
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
805
820
|
* @param {object} event Event object
|
|
@@ -960,6 +975,7 @@ export class BryntumCombo extends React.Component<BryntumComboProps> {
|
|
|
960
975
|
'cacheLastResult',
|
|
961
976
|
'caseSensitive',
|
|
962
977
|
'centered',
|
|
978
|
+
'checkValidity',
|
|
963
979
|
'chipView',
|
|
964
980
|
'clearable',
|
|
965
981
|
'clearTextOnPickerHide',
|
package/src/BryntumContainer.tsx
CHANGED
|
@@ -34,6 +34,8 @@ export type BryntumContainerProps = {
|
|
|
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/Container#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -238,10 +240,14 @@ export type BryntumContainerProps = {
|
|
|
238
240
|
inputFieldAlign? : 'start'|'end'
|
|
239
241
|
/**
|
|
240
242
|
* 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.
|
|
243
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
244
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-insertBefore)
|
|
241
245
|
*/
|
|
242
246
|
insertBefore? : HTMLElement|string
|
|
243
247
|
/**
|
|
244
248
|
* 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.
|
|
249
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
250
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Container#config-insertFirst)
|
|
245
251
|
*/
|
|
246
252
|
insertFirst? : HTMLElement|string
|
|
247
253
|
/**
|
|
@@ -533,7 +539,7 @@ export type BryntumContainerProps = {
|
|
|
533
539
|
* @param {object} event Event object
|
|
534
540
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
535
541
|
*/
|
|
536
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
542
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
537
543
|
/**
|
|
538
544
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
539
545
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
package/src/BryntumDateField.tsx
CHANGED
|
@@ -34,6 +34,8 @@ export type BryntumDateFieldProps = {
|
|
|
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/DateField#config-appendTo)
|
|
37
39
|
*/
|
|
38
40
|
appendTo? : HTMLElement|string
|
|
39
41
|
/**
|
|
@@ -87,6 +89,15 @@ export type BryntumDateFieldProps = {
|
|
|
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/DateField#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
|
|
@@ -291,10 +302,14 @@ export type BryntumDateFieldProps = {
|
|
|
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/DateField#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/DateField#config-insertFirst)
|
|
298
313
|
*/
|
|
299
314
|
insertFirst? : HTMLElement|string
|
|
300
315
|
/**
|
|
@@ -684,7 +699,7 @@ export type BryntumDateFieldProps = {
|
|
|
684
699
|
* @param {object} event Event object
|
|
685
700
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
686
701
|
*/
|
|
687
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
702
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
688
703
|
/**
|
|
689
704
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
690
705
|
* @param {object} event Event object
|
|
@@ -833,6 +848,7 @@ export class BryntumDateField extends React.Component<BryntumDateFieldProps> {
|
|
|
833
848
|
'autoSelect',
|
|
834
849
|
'bubbleEvents',
|
|
835
850
|
'centered',
|
|
851
|
+
'checkValidity',
|
|
836
852
|
'clearable',
|
|
837
853
|
'color',
|
|
838
854
|
'config',
|