@bryntum/schedulerpro-vue-3 7.2.4 → 7.3.0

package/src/components/BryntumBooleanComboProps.ts

@@ -0,0 +1,789 @@
+import type { AlignSpec, Base, BooleanComboListeners, ChipViewConfig, CollectionCompareOperator, CollectionFilterConfig, Color, Combo, ContainerItemConfig, Duration, DurationConfig, Field, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, ListConfig, MaskConfig, Model, Rectangle, Store, StoreConfig, TabConfig, TooltipConfig, Widget } from '@bryntum/schedulerpro';
+import {  } from '@bryntum/schedulerpro';
+
+export declare type BryntumBooleanComboProps = {
+    // Configs
+    /**
+     * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
+     * content will be placed inside this element.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-adopt)
+     */
+    adopt ? : HTMLElement|string
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-align)
+     */
+    align ? : AlignSpec|string
+    /**
+     * When this widget is a child of a [Container](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Container), it will by default be participating in a
+     * flexbox layout. This config allows you to set this widget's
+     * [align-self](https://developer.mozilla.org/en-US/docs/Web/CSS/align-self) style.
+     */
+    alignSelf ? : string
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating) and being shown through [showBy](#Core/widget/Widget#function-showBy).*
+     * `true` to show a connector arrow pointing to the align target.
+     */
+    anchor ? : Boolean
+    /**
+     * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
+     * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#property-element).
+     */
+    appendTo ? : HTMLElement|string
+    /**
+     * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject
+     * into an element which will be linked using the `aria-describedby` attribute.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-ariaDescription)
+     */
+    ariaDescription ? : string
+    /**
+     * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
+     * the `aria-label` attribute.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-ariaLabel)
+     */
+    ariaLabel ? : string
+    /**
+     * Sets the native `autocomplete` property of the underlying input element. For more information, please refer to
+     * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete)
+     */
+    autoComplete ? : string
+    /**
+     * Configure as `true` to have the picker expand upon focus enter.
+     */
+    autoExpand ? : Boolean
+    /**
+     * Specify `true` to auto select field contents on focus
+     */
+    autoSelect ? : Boolean
+    /**
+     * Initial text to show in badge.
+     */
+    badge ? : string
+    /**
+     * An object where property names with a truthy value indicate which events should bubble up the ownership
+     * hierarchy when triggered.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-bubbleEvents)
+     */
+    bubbleEvents ? : object
+    /**
+     * Enable caching of the last retrieved result until the timeout is reached.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-cacheLastResult)
+     */
+    cacheLastResult ? : number|string|Duration|DurationConfig
+    /**
+     * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-callOnFunctions)
+     */
+    callOnFunctions ? : Boolean
+    /**
+     * Configure as `true` to force case matching when filtering the dropdown list based upon the typed value.
+     */
+    caseSensitive ? : Boolean
+    /**
+     * By default, if an event handler throws an exception, the error propagates up the stack and the
+     * application state is undefined. Code which follows the event handler will *not* be executed.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-catchEventHandlerExceptions)
+     */
+    catchEventHandlerExceptions ? : Boolean
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
+     * Set to `true` to centre the Widget in browser viewport space.
+     */
+    centered ? : Boolean
+    /**
+     * A config object to configure the [ChipView](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/ChipView) to display the
+     * selected value set when [multiSelect](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-chipView)
+     */
+    chipView ? : ChipViewConfig
+    /**
+     * Show a trigger to clear field, if this field is not [readOnly](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#config-readOnly). The trigger is available
+     * in the [triggers](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#property-triggers) object under the name `clear`. May also be an object which
+     * configures the `clear` [trigger](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#property-triggers).
+     */
+    clearable ? : Boolean|FieldTriggerConfig
+    /**
+     * `true` to clear value typed to a multiselect combo when picker is collapsed
+     */
+    clearTextOnPickerHide ? : Boolean
+    /**
+     * Specify `false` to not clear value typed to a multiselect combo when an item is selected.
+     */
+    clearTextOnSelection ? : Boolean
+    /**
+     * Set to `true` to clear this field when user empties the input element
+     */
+    clearWhenInputEmpty ? : Boolean
+    /**
+     * Custom CSS classes to add to element.
+     * May be specified as a space separated string, or as an object in which property names
+     * with truthy values are used as the class names:
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-cls)
+     */
+    cls ? : string|object
+    /**
+     * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
+     * `style` block.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-color)
+     */
+    color ? : Color
+    /**
+     * Programmatic control over which column to start in when used in a grid layout.
+     */
+    column ? : number
+    config ? : object
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating) or [positioned](#Core/widget/Widget#config-positioned).*
+     * Element, Widget or Rectangle to which this Widget is constrained.
+     */
+    constrainTo ? : HTMLElement|Widget|Rectangle
+    /**
+     * The configuration for additional items associated to this field. This is typically used to add contextual
+     * fields related to a [checkbox](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
+     * these classes for examples of nested fields.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-container)
+     */
+    container ? : Record<string, ContainerItemConfig>|ContainerItemConfig[]|FieldContainerConfig
+    /**
+     * The config controls how the value of nested items are handled when a parent container gets or sets its
+     * [values](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Container#property-values).
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-containValues)
+     * @param {Core.widget.Field} field Field instance
+     * @returns {boolean}
+     */
+    containValues ? : Boolean|string|((field: Field) => Boolean)
+    /**
+     * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#property-contentElement).
+     * May be specified as a space separated string, or as an object in which property names
+     * with truthy values are used as the class names:
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-contentElementCls)
+     */
+    contentElementCls ? : string|object
+    /**
+     * If configured as `true`, this means that when an unmatched string is typed into the
+     * combo's input field, and <kbd>Enter</kbd>, or the [multiValueSeparator](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-multiValueSeparator) is typed,
+     * a new record will be created using the typed string as the [displayField](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-displayField).
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-createOnUnmatched)
+     * @param {string} name Record name
+     * @param {Core.widget.Combo} combo Combo instance
+     * @returns {Core.data.Model} New record
+     */
+    createOnUnmatched ? : ((name: string, combo: Combo) => Model)|string|Boolean
+    /**
+     * When this Widget configuration is used in the Grid's RowExpander feature's `widget` config, provide the
+     * field on the expanded record to use for populating this widget's store (if applicable)
+     */
+    dataField ? : string
+    /**
+     * Object to apply to elements dataset (each key will be used as a data-attribute on the element)
+     */
+    dataset ? : Record<string, string>
+    /**
+     * The name of the property to set when a single value is to be applied to this Widget. Such as when used
+     * in a grid WidgetColumn, this is the property to which the column's `field` is applied.
+     */
+    defaultBindProperty ? : string
+    /**
+     * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
+     * checks:
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-detectCSSCompatibilityIssues)
+     */
+    detectCSSCompatibilityIssues ? : Boolean
+    /**
+     * Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-readOnly) except a disabled widget
+     * cannot be focused, uses a different rendition (usually greyish) and does not allow selecting its value.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-disabled)
+     */
+    disabled ? : Boolean|'inert'
+    /**
+     * Field used for item text when populating from store
+     */
+    displayField ? : string
+    /**
+     * Template function that can be used to customize the displayed value
+     * @param {Core.data.Model} record The record to provide a textual value for
+     * @param {Core.widget.Combo} combo A reference to this Combo
+     * @returns {string,void}
+     */
+    displayValueRenderer ? : (record: Model, combo: Combo) => string|void
+    /**
+     * Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel)
+     * [strips collection](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Panel#config-strips). Typical values for this config are `'top'`,
+     * `'bottom'`, `'left'`, or `'right'`, which cause the widget to be placed on that side of the panel's
+     * body. Such widgets are called "edge strips".
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-dock)
+     */
+    dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
+     * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
+     * property which controls when a drag should start.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-draggable)
+     * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
+     */
+    draggable ? : Boolean|object
+    /**
+     * User can edit text in text field (otherwise only pick from attached picker)
+     */
+    editable ? : Boolean
+    /**
+     * An object specifying attributes to assign to the root element of this widget.
+     * Set `null` value to attribute to remove it.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-elementAttributes)
+     */
+    elementAttributes ? : Record<string, string|null>
+    /**
+     * Text to display in the drop down when there are no items in the underlying store.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-emptyText)
+     */
+    emptyText ? : string
+    /**
+     * A function which creates an array of values for the [filterParamName](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-filterParamName) to pass
+     * any filters to the server upon load.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-encodeFilterParams)
+     * @param {object[]} filters filters
+     * @returns {object[]} array of values
+     */
+    encodeFilterParams ? : (filters: object[]) => object[]
+    extraData ? : any
+    /**
+     * If `false`, filtering will be triggered once you exceed [minChars](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-minChars). To filter only when
+     * hitting Enter key, set this to `true`;
+     */
+    filterOnEnter ? : Boolean
+    /**
+     * The name of an operator type as implemented in [operator](https://bryntum.com/products/schedulerpro/docs/api/Core/util/CollectionFilter#config-operator)
+     * to use when filtering the dropdown list based upon the typed value.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-filterOperator)
+     */
+    filterOperator ? : CollectionCompareOperator
+    /**
+     * If the dropdown is to be populated with a filtered query to a remote server, specify the
+     * name of the parameter to pass the typed string here. By default, the string is simply sent
+     * as the value of the parameter. For special encoding, configure the combo with [encodeFilterParams](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-encodeFilterParams)
+     */
+    filterParamName ? : string
+    /**
+     * When [multiSelect](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-multiSelect) is `true`, you may configure `filterSelected` as
+     * `true` to hide items in the dropdown when they are added to the selection.
+     * It will appear as if the requested item has "moved" into the field's
+     * [ChipView](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-chipView).
+     */
+    filterSelected ? : Boolean
+    /**
+     * When this widget is a child of a [Container](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Container), it will by default be participating in a
+     * flexbox layout. This config allows you to set this widget's
+     * [flex](https://developer.mozilla.org/en-US/docs/Web/CSS/flex) style.
+     * This may be configured as a single number or a `&lt;flex-grow&gt; &lt;flex-shrink&gt; &lt;flex-basis&gt;` format string.
+     * numeric-only values are interpreted as the `flex-grow` value.
+     */
+    flex ? : number|string
+    /**
+     * Set to `true` to move the widget out of the document flow and position it
+     * absolutely in browser viewport space.
+     */
+    floating ? : Boolean
+    /**
+     * Widget's height, used to set element `style.height`. Either specify a valid height string or a number,
+     * which will get 'px' appended. We recommend using CSS as the primary way to control height, but in some
+     * cases this config is convenient.
+     */
+    height ? : string|number
+    /**
+     * Configure with true to make widget initially hidden.
+     */
+    hidden ? : Boolean
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-hideAnimation)
+     */
+    hideAnimation ? : Boolean|object
+    /**
+     * By default, the picker is hidden on selection in single select mode, and
+     * remains to allow more selections when [multiSelect](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
+     * Setting this to a `Boolean` value can override that default.
+     */
+    hidePickerOnSelect ? : Boolean
+    /**
+     * Configure as `true` to hide the expand trigger. This is automatically set to `true` if
+     * remote filtering is enabled by setting the [filterParamName](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-filterParamName) config.
+     */
+    hideTrigger ? : Boolean
+    /**
+     * Specify `true` to highlight field after external value changes
+     */
+    highlightExternalChange ? : Boolean
+    /**
+     * An optional string to display inside the input field as an overlay. This can be useful for displaying
+     * a field's units.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-hint)
+     * @param {object} data A data object
+     * @param {Core.widget.Field} data.source A reference to the field instance
+     * @param {any} data.value The current value of the field
+     * @returns {string}
+     */
+    hint ? : string|((data: { source: Field, value: any }) => string)
+    /**
+     * This config is similar to [hint](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#config-hint) except that this config is used to display HTML content.
+     * Since this can allow malicious content to be executed, be sure not to include user-entered data or to
+     * encode such data (see [encodeHtml](https://bryntum.com/products/schedulerpro/docs/api/Core/helper/StringHelper#function-encodeHtml-static)).
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-hintHtml)
+     * @param {object} data A data object
+     * @param {Core.widget.Field} data.source A reference to the field instance
+     * @param {any} data.value The current value of the field
+     * @returns {string}
+     */
+    hintHtml ? : string|((data: { source: Field, value: any }) => string)
+    /**
+     * Widget id, if not specified one will be generated. Also used for lookups through Widget.getById
+     */
+    id ? : string
+    /**
+     * Determines if the widgets read-only state should be controlled by its parent.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-ignoreParentReadOnly)
+     */
+    ignoreParentReadOnly ? : Boolean
+    /**
+     * Set this config to `true` to always display items horizontally along with this field. This assigns an
+     * [hbox](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
+     * [container](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#config-container).
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-inline)
+     */
+    inline ? : Boolean
+    /**
+     * Configure this as `true` to render the dropdown list as a permanently visible list
+     * in the document flow immediately below the input area instead of as a popup.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-inlinePicker)
+     */
+    inlinePicker ? : Boolean
+    /**
+     * Text alignment for the input field.
+     */
+    inputAlign ? : string
+    /**
+     * Sets custom attributes of the underlying input element. For more information, please refer to
+     * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes)
+     */
+    inputAttributes ? : Record<string, string>
+    /**
+     * If you need to use something else than a default `input` element, as the input element, provide the tag
+     * name here. Please note that this is used for advanced usage only, for example when using WebComponents
+     * (custom elements), and that the configured element must fulfil the same contract as a regular input
+     * element.
+     */
+    inputTag ? : string
+    /**
+     * Sets the `type` attribute of the underlying input element (password, hidden, date, color, etc.).
+     */
+    inputType ? : string
+    /**
+     * The width to apply to the `.b-field-inner` element, which encompasses the `input` element and any
+     * triggers. If a number is specified, `px` will be used.
+     */
+    inputWidth ? : string|number
+    /**
+     * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     */
+    insertBefore ? : HTMLElement|string
+    /**
+     * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     */
+    insertFirst ? : HTMLElement|string
+    /**
+     * Rows to display in the dropdown (list items).
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-items)
+     */
+    items ? : object[]|string[]|object
+    /**
+     * An object whose keys are the [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) name
+     * and optional modifier prefixes: `'Ctrl+'`, `'Alt+'`, `'Meta+'`, and `'Shift+'` (case-insensitive). The values
+     * are the name of the instance method to call when the keystroke is received.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-keyMap)
+     */
+    keyMap ? : Record<string, KeyMapConfig>
+    /**
+     * The delay in milliseconds to wait after the last keystroke before triggering a change event.
+     * Set to 0 to not trigger change events from keystrokes (listen for input event instead to have
+     * immediate feedback, change will still be triggered on blur).
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-keyStrokeChangeDelay)
+     */
+    keyStrokeChangeDelay ? : number
+    /**
+     * The delay in milliseconds to wait after the last keystroke before filtering the list.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-keyStrokeFilterDelay)
+     */
+    keyStrokeFilterDelay ? : number
+    /**
+     * Label, prepended to field
+     */
+    label ? : string
+    /**
+     * CSS class name or class names to add to any configured [label](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/mixin/Labelable#config-label)
+     */
+    labelCls ? : string|object
+    /**
+     * Label position, either 'before' the field or 'above' the field
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-labelPosition)
+     */
+    labelPosition ? : 'before'|'above'|null
+    /**
+     * The labels to add either before or after the input field.
+     * Each label may have the following properties:
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-labels)
+     * @property {string} html Label text
+     * @property {'start','end'} align Which end of the file the label should go
+     */
+    labels ? : object[]
+    /**
+     * The width to apply to the `&lt;label&gt;` element. If a number is specified, `px` will be used.
+     */
+    labelWidth ? : string|number
+    /**
+     * CSS class to add to picker
+     */
+    listCls ? : string
+    /**
+     * The listener set for this object.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-listeners)
+     */
+    listeners ? : BooleanComboListeners
+    /**
+     * Template string used to render the list items in the dropdown list
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-listItemTpl)
+     * @param {Core.data.Model} record The record representing the item being rendered
+     * @returns {string,void}
+     */
+    listItemTpl ? : (record: Model) => string|void
+    /**
+     * A class translations of which are used for translating this entity.
+     * This is often used when translations of an item are defined on its container class.
+     * For example:
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-localeClass)
+     */
+    localeClass ? : typeof Base
+    /**
+     * Set to `false` to disable localization of this object.
+     */
+    localizable ? : Boolean
+    /**
+     * List of properties which values should be translated automatically upon a locale applying.
+     * In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter),
+     * you could use 'localeKey' meta configuration.
+     * Example:
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-localizableProperties)
+     */
+    localizableProperties ? : string[]
+    /**
+     * Widget's margin. This may be configured as a single number or a `TRBL` format string.
+     * numeric-only values are interpreted as pixels.
+     */
+    margin ? : number|string
+    /**
+     * This config object contains the defaults for the [Mask](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Mask) created for the
+     * [masked](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-masked) config. Any properties specified in the `masked` config will override these
+     * values.
+     */
+    maskDefaults ? : MaskConfig
+    /**
+     * Set to `true` to apply the default mask to the widget. Alternatively, this can be the mask message or a
+     * [Mask](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Mask) config object.
+     */
+    masked ? : Boolean|string|MaskConfig
+    /**
+     * The element's maxHeight. Can be either a String or a Number (which will have 'px' appended). Note that
+     * like [height](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
+     */
+    maxHeight ? : string|number
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-maximizeOnMobile)
+     */
+    maximizeOnMobile ? : number|string
+    /**
+     * The max number of characters for the input field
+     */
+    maxLength ? : number
+    /**
+     * The elements maxWidth. Can be either a String or a Number (which will have 'px' appended). Note that
+     * like [width](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
+     */
+    maxWidth ? : string|number
+    /**
+     * The minimum string length to trigger the filtering, only relevant when [editable](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-editable) is `true`.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-minChars)
+     */
+    minChars ? : number
+    /**
+     * The element's minHeight. Can be either a String or a Number (which will have 'px' appended). Note that
+     * like [height](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
+     */
+    minHeight ? : string|number
+    /**
+     * The min number of characters for the input field
+     */
+    minLength ? : number
+    /**
+     * The elements minWidth. Can be either a String or a Number (which will have 'px' appended). Note that
+     * like [width](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
+     */
+    minWidth ? : string|number
+    /**
+     * When this is configured as `true` a [ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
+     * is used to monitor this element for size changes caused by either style manipulation, or by CSS
+     * layout.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-monitorResize)
+     * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
+     */
+    monitorResize ? : Boolean|object
+    /**
+     * Set to `true` to allow selection of multiple values from the dropdown list.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-multiSelect)
+     */
+    multiSelect ? : Boolean
+    /**
+     * A key value which, when typed in a [multiSelect](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-multiSelect) Combo, selects the
+     * currently active item in the picker, and clears the input field ready for another
+     * match to be typed.
+     */
+    multiValueSeparator ? : string
+    /**
+     * Name of the field which is used as a key to get/set values from/to the field.
+     * Used prior to [ref](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-ref) and [id](#Core/widget/Widget#config-id) in
+     * [Container.values](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Container#property-values).
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-name)
+     */
+    name ? : string
+    /**
+     * False option display value
+     */
+    negativeText ? : string
+    /**
+     * Negative option value
+     */
+    negativeValue ? : any
+    /**
+     * This implies that the picker will display an anchor pointer, but also means that the picker will align closer
+     * to the input field so that the pointer pierces the [pickerAlignElement](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-pickerAlignElement)
+     */
+    overlayAnchor ? : Boolean
+    /**
+     * Configuration object for the [picker](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/List) on initialization. Returns the
+     * [picker](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/List) instance at runtime.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-picker)
+     */
+    picker ? : ListConfig
+    /**
+     * The name of the element property to which the picker should size and align itself.
+     */
+    pickerAlignElement ? : string
+    /**
+     * Width of picker, defaults to this combo's [pickerAlignElement](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#config-pickerAlignElement) width
+     */
+    pickerWidth ? : number|string
+    /**
+     * Text to display in empty field.
+     */
+    placeholder ? : string
+    /**
+     * Set to `true` when a widget is rendered into another widget's [contentElement](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#property-contentElement), but must
+     * not participate in the standard layout of that widget, and must be positioned relatively to that
+     * widget's [contentElement](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#property-contentElement).
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-positioned)
+     */
+    positioned ? : Boolean
+    /**
+     * Positive option display value
+     */
+    positiveText ? : string
+    /**
+     * Positive option value
+     */
+    positiveValue ? : any
+    /**
+     * Prevent tooltip from being displayed on touch devices. Useful for example for buttons that display a
+     * menu on click etc, since the tooltip would be displayed at the same time.
+     */
+    preventTooltipOnTouch ? : Boolean
+    /**
+     * Optionally a [Filter](https://bryntum.com/products/schedulerpro/docs/api/Core/util/CollectionFilter) config object which the combo should use for
+     * filtering using the typed value.
+     * This may use a `filterBy` property to test its `value` against any field in the passed record.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-primaryFilter)
+     */
+    primaryFilter ? : CollectionFilterConfig
+    /**
+     * Makes the field unmodifiable by user action. The input area is not editable, and triggers
+     * are unresponsive.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-readOnly)
+     */
+    readOnly ? : Boolean
+    relayStoreEvents ? : Boolean
+    /**
+     * Predefined style to use for the field. Possible values are:
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-rendition)
+     */
+    rendition ? : 'outlined'|'filled'|string
+    /**
+     * Configure as `true` to indicate that a `null` field value is to be marked as invalid. This will
+     * optionally append a * to the field label if [showRequiredIndicator](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#property-showRequiredIndicator) is set.
+     */
+    required ? : Boolean
+    /**
+     * If this field is not [readOnly](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
+     * the <kbd>Escape</kbd> key after editing the field will revert the field to the value it had when
+     * the user focused the field. If the field is *not* changed from when focused, the [clearable](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#config-clearable)
+     * behaviour will be activated.
+     */
+    revertOnEscape ? : Boolean
+    /**
+     * Configure as `true` to have the component display a translucent ripple when its
+     * [focusElement](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#property-focusElement), or [element](#Core/widget/Widget#property-element) is tapped <em>if the
+     * current theme supports ripples</em>. Out of the box, only the Material theme supports ripples.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-ripple)
+     * @property {string} [delegate] A CSS selector to filter which child elements trigger ripples. By default, the ripple is clipped to the triggering element.
+     * @property {string} [color] A CSS color name or specification.
+     * @property {number} [radius] The ending radius of the ripple. Note that it will be clipped by the target element by default.
+     * @property {string} [clip] A string which describes how to clip the ripple if it is not to be clipped to the default element. Either the property of the widget to use as the clipping element, or a selector to allow clipping to the closest matching ancestor to the target element.
+     */
+    ripple ? : Boolean|object
+    /**
+     * The ARIA role to apply to this widget's element. By default, this is set to `'presentation'` to avoid
+     * accidentally applying a role which may interfere with screen readers.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-role)
+     */
+    role ? : string
+    /**
+     * If you are rendering this widget to a shadow root inside a web component, set this config to the shadowRoot. If not inside a web component, set it to `document.body`
+     */
+    rootElement ? : ShadowRoot|HTMLElement
+    /**
+     * This may be configured as `true` to make the widget's element use the `direction:rtl` style.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-rtl)
+     */
+    rtl ? : Boolean
+    /**
+     * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
+     * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
+     */
+    scrollAction ? : 'hide'|'realign'|null
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#config-floating).*
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-showAnimation)
+     */
+    showAnimation ? : Boolean|object
+    /**
+     * `true` to automatically display a * after the label for this field when it is [required](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Field#property-required).
+     */
+    showRequiredIndicator ? : string
+    /**
+     * Set to `false` to not show the tooltip when this widget is [disabled](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Widget#property-disabled)
+     */
+    showTooltipWhenDisabled ? : Boolean
+    /**
+     * Set to `true`, completely bypasses validation logic (could be userful if your field is not `editable`
+     * to the user).
+     */
+    skipValidation ? : Boolean
+    /**
+     * Programmatic control over how many columns to span when used in a grid layout.
+     */
+    span ? : number
+    /**
+     * Sets the native `spellcheck` property of the underlying input element. For more information, please refer to
+     * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/spellcheck)
+     */
+    spellCheck ? : Boolean
+    /**
+     * Store used to populate items. Also accepts a Store config object
+     */
+    store ? : Store|StoreConfig
+    /**
+     * A configuration for the [tab](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Tab) created for this widget when it is placed in a
+     * [TabPanel](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/TabPanel). For example, this config can be used to control the icon of the `tab` for
+     * this widget:
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-tab)
+     */
+    tab ? : Boolean|TabConfig
+    /**
+     * The tab index of the input field or fields, or `null` for natural tab order (recommended). Setting to `0`
+     * is equivalent to natural tab order, but is unnecessary for fields since they are naturally tabbable
+     * (i.e., accessible via the TAB key). Setting to `-1` disables tabbability but allows for focus to be set
+     * to the element programmatically.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-tabIndex)
+     */
+    tabIndex ? : number
+    /**
+     * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-textAlign)
+     */
+    textAlign ? : 'left'|'center'|'right'|'start'|'end'
+    /**
+     * A title to display for the widget. Only in effect when inside a container that uses it (such as TabPanel)
+     */
+    title ? : string
+    /**
+     * Tooltip for the widget, either as a string or as a Tooltip config object.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-tooltip)
+     */
+    tooltip ? : string|TooltipConfig|null
+    /**
+     * How to query the store upon click of the expand trigger. Specify one of these values:
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-triggerAction)
+     */
+    triggerAction ? : 'all'|'last'|null
+    /**
+     * The triggers to add either before or after the input field. Each property name is the reference by which
+     * an instantiated Trigger Widget may be retrieved from the live `triggers` property.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-triggers)
+     */
+    triggers ? : Record<string, FieldTriggerConfig>
+    type ? : 'Booleancombo'
+    /**
+     * Custom CSS class name suffixes to apply to the elements rendered by this widget. This may be specified
+     * as a space separated string, an array of strings, or as an object in which property names with truthy
+     * values are used as the class names.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-ui)
+     */
+    ui ? : string|object
+    /**
+     * `true` to cause the field to be in an invalid state while the typed filter string does not match a record in the store.
+     */
+    validateFilter ? : Boolean
+    /**
+     * Set to `false` to not highlight a field as invalid while typing, to instead show it on ENTER key press
+     * or similar.
+     */
+    validateOnInput ? : Boolean
+    /**
+     * Default value
+     */
+    value ? : any
+    /**
+     * Field used for item value when populating from store. Setting this to `null` will
+     * yield the selected record as the Combo's [value](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Combo#property-value).
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-valueField)
+     */
+    valueField ? : string|null
+    /**
+     * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/Container).
+     * Higher weights go further down.
+     */
+    weight ? : number
+    /**
+     * Widget's width, used to set element `style.width`. Either specify a valid width string or a number, which
+     * will get 'px' appended. We recommend using CSS as the primary way to control width, but in some cases
+     * this config is convenient.
+     */
+    width ? : string|number
+    /**
+     * The x position for the widget.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-x)
+     */
+    x ? : number
+    /**
+     * The y position for the widget.
+     * [More...](https://bryntum.com/products/schedulerpro/docs/api/Core/widget/BooleanCombo#config-y)
+     */
+    y ? : number
+
+}