@bryntum/calendar-vue-3 7.1.1

package/src/components/BryntumDatePickerProps.ts

@@ -0,0 +1,898 @@
+import type { AlignSpec, Base, CalendarPanel, ContainerItemConfig, ContainerLayoutConfig, DatePickerListeners, DomConfig, KeyMapConfig, MaskConfig, MenuItemEntry, Model, Month, MonthConfig, PagingToolbarConfig, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, Rectangle, Scroller, ScrollerConfig, StateProvider, TabConfig, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, VueConfig, Widget } from '@bryntum/calendar';
+import {  } from '@bryntum/calendar';
+
+export declare type BryntumDatePickerProps = {
+    // Configs
+    /**
+     * The date that the user has navigated to using the UI *prior* to setting the widget's
+     * value by selecting it. The initial default is today's date. Can also be supplied as a `YYYY-MM-DD` date
+     * string.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-activeDate)
+     */
+    activeDate ? : Date|'today'|string
+    /**
+     * Element (or element id) to adopt as this Widget's encapsulating element. The widget's
+     * content will be placed inside this element.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-adopt)
+     */
+    adopt ? : HTMLElement|string
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-floating).*
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-align)
+     */
+    align ? : AlignSpec|string
+    /**
+     * When this widget is a child of a [Container](https://bryntum.com/products/calendar/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/calendar/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
+    /**
+     * By default, when navigating through time, the next time
+     * block will be animated in from the appropriate direction.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-animateTimeShift)
+     */
+    animateTimeShift ? : 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/calendar/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.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-ariaDescription)
+     */
+    ariaDescription ? : string
+    /**
+     * A localizable string (May contain `'L{}'` tokens which resolve in the locale file) to inject as
+     * the `aria-label` attribute.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-ariaLabel)
+     */
+    ariaLabel ? : string
+    /**
+     * Update assigned [record](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#config-record) automatically on field changes
+     */
+    autoUpdateRecord ? : Boolean
+    /**
+     * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/calendar/docs/api/Core/widget/Toolbar),
+     * or array of config objects representing the child items of a Toolbar. Another way to add a bbar is to use [strips](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-strips).
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-bbar)
+     */
+    bbar ? : (ContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
+    /**
+     * Custom CSS classes to add to the panel's body element.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-bodyCls)
+     */
+    bodyCls ? : string|object
+    /**
+     * An object where property names with a truthy value indicate which events should bubble up the ownership
+     * hierarchy when triggered.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-bubbleEvents)
+     */
+    bubbleEvents ? : object
+    /**
+     * Set to `false` to not call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-callOnFunctions)
+     */
+    callOnFunctions ? : 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.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-catchEventHandlerExceptions)
+     */
+    catchEventHandlerExceptions ? : Boolean
+    /**
+     * A function (or the name of a function) which creates content in, and may mutate a day cell element.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-cellRenderer)
+     * @param {object} renderData
+     * @param {HTMLElement} renderData.cell The cell's encapsulating element. This has the `b-calendar-panel-cell` class and is the element which receives focus, so this should be the target of any accessibility attributes.
+     * @param {HTMLElement} renderData.innerCell The inner element of the cell which contains the date number. This is the `aspect-ratio : 1` element which contains the date. It is not recommeneded to mutate this element. Instead use the `cellPayload` element (see below).
+     * @param {HTMLElement} renderData.cellPayload An empty, absolutely positioned element, by default docked at the bottom of the cell. Content may be added to this element to augment cell content.
+     * @param {Date} renderData.date The date for the cell
+     * @param {number} renderData.day The day for the cell (`0` to `6` for Sunday to Saturday)
+     * @param {number[]} renderData.rowIndex The row index, 0 to month row count (6 if [sixWeeks](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-sixWeeks) is `true`)
+     * @param {HTMLElement} renderData.row The row element encapsulating the week which the cell is a part of
+     * @param {Core.widget.CalendarPanel} renderData.source The widget being rendered
+     * @param {number[]} renderData.cellIndex The cell index in the whole panel. May be from `0` to up to `42`
+     * @param {number[]} renderData.columnIndex The column index, `0` to `6`
+     * @param {number[]} renderData.visibleColumnIndex The visible column index taking hidden non working days into account
+     * @returns {string,DomConfig,void}
+     */
+    cellRenderer ? : ((renderData: { cell: HTMLElement, innerCell: HTMLElement, cellPayload: HTMLElement, date: Date, day: number, rowIndex: number[], row: HTMLElement, source: CalendarPanel, cellIndex: number[], columnIndex: number[], visibleColumnIndex: number[] }) => string|DomConfig|void)|string
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-floating).*
+     * Set to `true` to centre the Widget in browser viewport space.
+     */
+    centered ? : 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:
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-cls)
+     */
+    cls ? : string|object
+    /**
+     * Controls whether the panel is collapsed (the body of the panel is hidden while only the header is
+     * visible). Only valid if the panel is [collapsible](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-collapsible).
+     */
+    collapsed ? : Boolean
+    /**
+     * This config enables collapsibility for the panel. See [collapsed](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-collapsed).
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-collapsible)
+     */
+    collapsible ? : Boolean|PanelCollapserConfig|PanelCollapserOverlayConfig
+    /**
+     * Applies the specified color to the widget, by setting the `--b-primary` CSS variable in the widgets
+     * `style` block.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-color)
+     */
+    color ? : string
+    /**
+     * 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/calendar/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 HTML content that coexists with sibling elements which may have been added to the
+     * [contentElement](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-contentElement) by plugins and features.
+     * When specifying html, this widget's element will also have the [htmlCls](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-htmlCls)
+     * class added to its classList, to allow targeted styling.
+     */
+    content ? : string
+    /**
+     * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/calendar/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:
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-contentElementCls)
+     */
+    contentElementCls ? : string|object
+    /**
+     * 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 initially selected date (or a `YYYY-MM-DD` date string).
+     */
+    date ? : Date|string
+    /**
+     * The [DateHelper](https://bryntum.com/products/calendar/docs/api/Core/helper/DateHelper) format string to format the day names.
+     */
+    dayNameFormat ? : 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
+    /**
+     * A [query](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#function-query) selector function which can identify the descendant widget to which
+     * focus should be directed by default.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-defaultFocus)
+     * @param {Core.widget.Widget} widget Widget passed to method
+     * @returns {boolean} truthy value if widget is the default one
+     */
+    defaultFocus ? : ((widget: Widget) => Boolean)|string
+    /**
+     * A config object containing default settings to apply to all child widgets.
+     */
+    defaults ? : ContainerItemConfig
+    /**
+     * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-detectCSSCompatibilityIssues)
+     */
+    detectCSSCompatibilityIssues ? : Boolean
+    /**
+     * Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/calendar/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.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-disabled)
+     */
+    disabled ? : Boolean|'inert'
+    /**
+     * The class name to add to disabled calendar cells.
+     */
+    disabledCls ? : string
+    /**
+     * Either an array of `Date` objects which are to be disabled (or date strings), or
+     * a function (or the name of a function), which, when passed a `Date` returns `true` if the
+     * date is disabled. Disabled dates cannot be interacted with.
+     * @param {Date} date Date to check
+     * @returns {boolean} Returns `true` if the provided date is disabled
+     */
+    disabledDates ? : ((date: Date) => Boolean)|string|Date[]|string[]
+    /**
+     * Configure as `true` to render non working days as [disabledDates](https://bryntum.com/products/calendar/docs/api/Core/widget/CalendarPanel#config-disabledDates).
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-disableNonWorkingDays)
+     */
+    disableNonWorkingDays ? : Boolean
+    /**
+     * Configure this as true to disable pointer interaction with cells which are outside the
+     * range of the current month.
+     */
+    disableOtherMonthCells ? : Boolean
+    /**
+     * Configure as `true` to render Saturdays and Sundays as [disabledDates](https://bryntum.com/products/calendar/docs/api/Core/widget/CalendarPanel#config-disabledDates).
+     */
+    disableWeekends ? : Boolean
+    /**
+     * Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel)
+     * [strips collection](https://bryntum.com/products/calendar/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".
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-dock)
+     */
+    dock ? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/calendar/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.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-draggable)
+     */
+    draggable ? : Boolean|{
+        handleSelector?: string
+    }
+    /**
+     * This property is only valid if [multiSelect](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-multiSelect) is set to `'range'`
+     * or `true`.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-dragSelect)
+     */
+    dragSelect ? : Boolean
+    /**
+     * Make this Panel a docked drawer which slides out from one side of the browser viewport by default.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-drawer)
+     * @param {'start','left','end','right','top','bottom'} side The side of the viewport to dock the drawer to.  * `'start'` means the `inline-start` side. * `'end'` means the `inline-end` side.
+     * @param {string,number} size The size of the drawer in its collapsible axis.
+     * @param {boolean} inline If using the [appendTo](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-appendTo) config to place the drawer inside a host widget, this may be set to `true` to make the drawer inline within that host. Note that, if using this, the layout of the host element must have `flex-direction` set appropriately.
+     * @param {boolean,object} autoClose Specifies what user actions should automatically close the drawer. Defaults to closing when the user clicks outside of the drawer or when focus moves outside of the drawer.
+     * @param {boolean,string} autoClose.mousedown If the user clicks outside of the drawer, the drawer will automatically be hidden. If the value is a string, it is used as a CSS selector to filter clicks which should close the drawer.
+     * @param {boolean,string} autoClose.focusout If focus moves outside of the drawer, the drawer will automatically be hidden.
+     * @param {string} autoClose.mouseout Hides the drawer when the mouse leaves the drawer after the `autoCloseDelay` period.
+     * @param {number} autoCloseDelay When using `mouseout`, this is the delay in milliseconds
+     */
+    drawer ? : Boolean|{side?: 'start'|'left'|'end'|'right'|'top'|'bottom', size?: string|number, inline?: Boolean, autoClose: { mousedown?: Boolean|string, focusout?: Boolean|string, mouseout?: string }, autoCloseDelay?: number}
+    /**
+     * By default, the month and year are editable. Configure this as `false` to prevent that.
+     */
+    editMonth ? : Boolean
+    /**
+     * An object specifying attributes to assign to the root element of this widget.
+     * Set `null` value to attribute to remove it.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-elementAttributes)
+     */
+    elementAttributes ? : Record<string, string|null>
+    extraData ? : any
+    /**
+     * When this widget is a child of a [Container](https://bryntum.com/products/calendar/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
+    /**
+     * By default, disabled dates cannot be navigated to, and they are skipped over
+     * during keyboard navigation. Configure this as `true` to enable navigation to
+     * disabled dates.
+     */
+    focusDisabledDates ? : Boolean
+    /**
+     * Config object of a footer. May contain a `dock`, `html` and a `cls` property. A footer is not a widget,
+     * but rather plain HTML that follows the last element of the panel's body and [strips](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-strips).
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-footer)
+     */
+    footer ? : {
+        dock?: 'top'|'right'|'bottom'|'left'|'start'|'end'
+        html?: string
+        cls?: string
+    }|string
+    /**
+     * A config [object](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#typedef-PanelHeader) for the panel's header or a string in place of a `title`.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-header)
+     */
+    header ? : string|Boolean|PanelHeader
+    /**
+     * A function (or the name of a function) which creates content in, and may mutate a day header element.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-headerRenderer)
+     * @param {HTMLElement} cell The header element
+     * @param {number} columnIndex The day column. Will be in the range `0` to `6`
+     * @param {number} weekDay The canonical day number where Monday is `0` and Sunday is `6`
+     * @returns {string,DomConfig,void}
+     */
+    headerRenderer ? : ((cell: HTMLElement, columnIndex: number, weekDay: number) => string|DomConfig|void)|string
+    /**
+     * 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/calendar/docs/api/Core/widget/Widget#config-floating).*
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-hideAnimation)
+     */
+    hideAnimation ? : Boolean|object
+    /**
+     * Configure this as `true` to hide cells which are outside the range of the current month.
+     */
+    hideOtherMonthCells ? : Boolean
+    /**
+     * Specify `true` to make this container hide when it has no visible children (Either empty
+     * or all children hidden).
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-hideWhenEmpty)
+     */
+    hideWhenEmpty ? : Boolean
+    /**
+     * Configure as `true` to add a highlighted border and background to the week row which
+     * encapsulates the selected date.
+     */
+    highlightSelectedWeek ? : Boolean
+    /**
+     * The HTML to display initially or a function returning the markup (called at widget construction time).
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-html)
+     * @param {Core.widget.Widget} widget The calling Widget
+     * @returns {string}
+     */
+    html ? : string|((widget: Widget) => string)|DomConfig|DomConfig[]|VueConfig
+    /**
+     * The CSS class(es) to add when HTML content is being applied to this widget.
+     */
+    htmlCls ? : string|object
+    /**
+     * An icon to show before the [title](https://bryntum.com/products/calendar/docs/api/Core/widget/Panel#config-title). Either pass a CSS class as a string, or pass a
+     * [DomConfig](https://bryntum.com/products/calendar/docs/api/Core/helper/DomHelper#typedef-DomConfig) object describing an element to represent the icon.
+     */
+    icon ? : string|DomConfig
+    /**
+     * 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.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-ignoreParentReadOnly)
+     */
+    ignoreParentReadOnly ? : Boolean
+    /**
+     * By default, the year is visible. Configure this as `false` to prevent that.
+     */
+    includeYear ? : Boolean
+    /**
+     * Convenience setting to align input fields of child widgets. By default, the Field input element is
+     * placed immediately following the `label`. If you prefer to have all input fields aligned to the
+     * right, set this config to `'end'`.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-inputFieldAlign)
+     */
+    inputFieldAlign ? : 'start'|'end'
+    /**
+     * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/calendar/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/calendar/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     */
+    insertFirst ? : HTMLElement|string
+    /**
+     * An optional CSS class to add to child items of this container.
+     */
+    itemCls ? : string
+    /**
+     * An object containing typed child widget config objects or Widgets. May also be specified
+     * as an array.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-items)
+     */
+    items ? : Record<string, ContainerItemConfig|MenuItemEntry>|(ContainerItemConfig|MenuItemEntry|Widget)[]
+    /**
+     * 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.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-keyMap)
+     */
+    keyMap ? : Record<string, KeyMapConfig>
+    /**
+     * Convenience setting to use same label placement on all child widgets.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-labelPosition)
+     */
+    labelPosition ? : 'before'|'above'|'align-before'|'auto'|null
+    /**
+     * The short name of a helper class which manages rendering and styling of child items.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-layout)
+     */
+    layout ? : string|ContainerLayoutConfig
+    /**
+     * The CSS style properties to apply to the [contentElement](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-contentElement).
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-layoutStyle)
+     */
+    layoutStyle ? : object
+    /**
+     * An array of [child item](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#config-items) *config objects* which is to be converted into
+     * instances only when this Container is rendered, rather than eagerly at construct time.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-lazyItems)
+     */
+    lazyItems ? : Record<string, ContainerItemConfig>|ContainerItemConfig[]|Widget[]
+    /**
+     * The listener set for this object.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-listeners)
+     */
+    listeners ? : DatePickerListeners
+    /**
+     * 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:
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#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:
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#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/calendar/docs/api/Core/widget/Mask) created for the
+     * [masked](https://bryntum.com/products/calendar/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/calendar/docs/api/Core/widget/Mask) config object.
+     */
+    masked ? : Boolean|string|MaskConfig
+    /**
+     * The maximum selectable date. Selection of and navigation to dates after
+     * this date will not be possible.
+     */
+    maxDate ? : Date
+    /**
+     * 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/calendar/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/calendar/docs/api/Core/widget/Widget#config-floating).*
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-maximizeOnMobile)
+     */
+    maximizeOnMobile ? : number|string
+    /**
+     * The elements maxWidth. Can be either a String or a Number (which will have 'px' appended). Note that
+     * like [width](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
+     */
+    maxWidth ? : string|number
+    /**
+     * By default, day cells flex to share available Panel width equally.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-minColumnWidth)
+     */
+    minColumnWidth ? : number
+    /**
+     * The minimum selectable date. Selection of and navigation to dates prior
+     * to this date will not be possible.
+     */
+    minDate ? : Date
+    /**
+     * 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/calendar/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
+     */
+    minHeight ? : string|number
+    /**
+     * By default, week rows flex to share available Panel height equally.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-minRowHeight)
+     */
+    minRowHeight ? : number|string
+    /**
+     * The elements minWidth. Can be either a String or a Number (which will have 'px' appended). Note that
+     * like [width](https://bryntum.com/products/calendar/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.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-monitorResize)
+     */
+    monitorResize ? : Boolean|{
+        immediate?: Boolean
+    }
+    /**
+     * A [Month](https://bryntum.com/products/calendar/docs/api/Core/util/Month) Month utility object which encapsulates this Panel's month
+     * and provides contextual information and navigation services.
+     */
+    month ? : Month|MonthConfig
+    /**
+     * The format string to use to create the text of the month button.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-monthButtonFormat)
+     */
+    monthButtonFormat ? : string
+    /**
+     * Configure as `true` to enable selecting multiple discontiguous date ranges using
+     * click and Shift+click to create ranges and Ctrl+click to select/deselect individual dates.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-multiSelect)
+     */
+    multiSelect ? : Boolean|'range'|'simple'
+    /**
+     * An object containing default config objects which may be referenced by name in the [items](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#config-items)
+     * config. For example, a specialized [Menu](https://bryntum.com/products/calendar/docs/api/Core/widget/Menu) subclass may have a `namedItems` default
+     * value defined like this:
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-namedItems)
+     */
+    namedItems ? : Record<string, ContainerItemConfig>
+    /**
+     * The class name to add to calendar cells which are [nonWorkingDays](https://bryntum.com/products/calendar/docs/api/Core/widget/CalendarPanel#config-nonWorkingDays).
+     */
+    nonWorkingDayCls ? : string
+    /**
+     * Non-working days as an object where keys are day indices, 0-6 (Sunday-Saturday), and the value is `true`.
+     * Defaults to [nonWorkingDays](https://bryntum.com/products/calendar/docs/api/Core/helper/DateHelper#property-nonWorkingDays-static).
+     */
+    nonWorkingDays ? : Record<number, Boolean>
+    /**
+     * The class name to add to calendar cells which are in the previous or next month.
+     */
+    otherMonthCls ? : string
+    /**
+     * The owning Widget of this Widget. If this Widget is directly contained (that is, it is one of the
+     * [items](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#property-items) of a Container), this config will be ignored. In this case
+     * the owner is <strong>always</strong> the encapsulating Container.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-owner)
+     */
+    owner ? : Widget|any
+    /**
+     * Set to `true` when a widget is rendered into another widget's [contentElement](https://bryntum.com/products/calendar/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/calendar/docs/api/Core/widget/Widget#property-contentElement).
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-positioned)
+     */
+    positioned ? : Boolean
+    /**
+     * 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
+    /**
+     * Whether this widget is read-only.  This is only valid if the widget is an input
+     * field, <strong>or contains input fields at any depth</strong>.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-readOnly)
+     */
+    readOnly ? : Boolean
+    /**
+     * [Record](https://bryntum.com/products/calendar/docs/api/Core/data/Model) whose values will be used to populate fields in the container.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-record)
+     */
+    record ? : Model
+    relayStoreEvents ? : Boolean
+    /**
+     * Either a default `rendition` to apply to all child widgets, or a map of renditions keyed by child widget
+     * `type`.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-rendition)
+     */
+    rendition ? : string|Record<string, string>|null
+    /**
+     * Configure as `true` to have the component display a translucent ripple when its
+     * [focusElement](https://bryntum.com/products/calendar/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.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-ripple)
+     */
+    ripple ? : Boolean|{
+        delegate?: string
+        color?: string
+        radius?: number
+        clip?: 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.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-rtl)
+     */
+    rtl ? : Boolean
+    /**
+     * Specifies whether (and optionally in which axes) a Widget may scroll. `true` means this widget may scroll
+     * in both axes. May be an object containing boolean `overflowX` and `overflowY` properties which are
+     * applied to CSS style properties `overflowX` and `overflowY`. If they are boolean, they are translated to
+     * CSS overflow properties thus:
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-scrollable)
+     */
+    scrollable ? : Boolean|ScrollerConfig|Scroller
+    /**
+     * 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
+    /**
+     * If [multiSelect](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-multiSelect) is configured as `true`, this is an array of dates
+     * which are selected. There may be multiple, discontiguous date ranges.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-selection)
+     */
+    selection ? : Date[]|string[]
+    /**
+     * Configure as `true` to render past dates in a lighter text color.
+     */
+    shadePastDates ? : Boolean
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#config-floating).*
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-showAnimation)
+     */
+    showAnimation ? : Boolean|object
+    /**
+     * Set to `false` to not show the tooltip when this widget is [disabled](https://bryntum.com/products/calendar/docs/api/Core/widget/Widget#property-disabled)
+     */
+    showTooltipWhenDisabled ? : Boolean
+    /**
+     * Configure as `true` to show a week number column at the start of the calendar block.
+     */
+    showWeekColumn ? : Boolean
+    /**
+     * Configure as `true` to always show a six-week calendar.
+     */
+    sixWeeks ? : Boolean
+    /**
+     * Programmatic control over how many columns to span when used in a grid layout.
+     */
+    span ? : number
+    /**
+     * This value can be one of the following:
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-stateful)
+     */
+    stateful ? : Boolean|object|string[]
+    /**
+     * The events that, when fired by this component, should trigger it to save its state by calling
+     * [saveState](https://bryntum.com/products/calendar/docs/api/Core/mixin/State#function-saveState).
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-statefulEvents)
+     */
+    statefulEvents ? : object|string[]
+    /**
+     * The key to use when saving this object's state in the [stateProvider](https://bryntum.com/products/calendar/docs/api/Core/mixin/State#config-stateProvider). If this config is
+     * not assigned, and [stateful](https://bryntum.com/products/calendar/docs/api/Core/mixin/State#config-stateful) is not set to `false`, the [id](#Core/widget/Widget#config-id)
+     * (if explicitly specified) will be used as the `stateId`.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-stateId)
+     */
+    stateId ? : string
+    /**
+     * The `StateProvider` to use to save and restore this object's [state](https://bryntum.com/products/calendar/docs/api/Core/mixin/State#property-state). By default, `state`
+     * will be saved using the [default state provider](https://bryntum.com/products/calendar/docs/api/Core/state/StateProvider#property-instance-static).
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-stateProvider)
+     */
+    stateProvider ? : StateProvider
+    /**
+     * Specify `true` to match fields by their `name` property only when assigning a [record](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#config-record),
+     * without falling back to `ref`.
+     */
+    strictRecordMapping ? : Boolean
+    /**
+     * An object containing widgets keyed by name. By default (when no `type` is given), strips are
+     * [toolbars](https://bryntum.com/products/calendar/docs/api/Core/widget/Toolbar). If you want to pass an array, you can use
+     * the toolbar's [items](https://bryntum.com/products/calendar/docs/api/Core/widget/Container#config-items).
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-strips)
+     */
+    strips ? : Record<string, ContainerItemConfig>
+    /**
+     * A configuration for the [tab](https://bryntum.com/products/calendar/docs/api/Core/widget/Tab) created for this widget when it is placed in a
+     * [TabPanel](https://bryntum.com/products/calendar/docs/api/Core/widget/TabPanel). For example, this config can be used to control the icon of the `tab` for
+     * this widget:
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-tab)
+     */
+    tab ? : Boolean|TabConfig
+    /**
+     * When this container is used as a tab in a TabPanel, these items are added to the
+     * [TabBar](https://bryntum.com/products/calendar/docs/api/Core/widget/TabBar) when this container is the active tab.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-tabBarItems)
+     */
+    tabBarItems ? : ToolbarItems[]|Widget[]
+    /**
+     * The tag name of this Widget's root element
+     */
+    tag ? : string
+    /**
+     * A Config object representing the configuration of a [Toolbar](https://bryntum.com/products/calendar/docs/api/Core/widget/Toolbar),
+     * or array of config objects representing the child items of a Toolbar.
+     * This creates a toolbar docked to the top of the panel immediately below the header.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-tbar)
+     */
+    tbar ? : (ContainerItemConfig|string)[]|ToolbarConfig|PagingToolbarConfig|null
+    /**
+     * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-textAlign)
+     */
+    textAlign ? : 'left'|'center'|'right'|'start'|'end'
+    /**
+     * Specify `true` for a container used to show text markup. It will apply the CSS class `b-text-content`
+     * which specifies a default max-width that makes long text more readable.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-textContent)
+     */
+    textContent ? : Boolean
+    /**
+     * A config object to create a tooltip which will show on hover of a date cell including disabled, weekend,
+     * and "other month" cells.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-tip)
+     */
+    tip ? : TooltipConfig
+    /**
+     * A title to display in the header or owning TabPanel. Causes creation and docking of a header
+     * to the top if no header is configured.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-title)
+     */
+    title ? : string
+    /**
+     * The class name to add to the calendar cell which contains today's date.
+     */
+    todayCls ? : string
+    /**
+     * The [tools](https://bryntum.com/products/calendar/docs/api/Core/widget/Tool) to add either before or after the `title` in the Panel header. Each
+     * property name is the reference by which an instantiated tool may be retrieved from the live
+     * `[tools](https://bryntum.com/products/calendar/docs/api/Core/widget/mixin/Toolable#property-tools)` property.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-tools)
+     */
+    tools ? : Record<string, ToolConfig>|null
+    /**
+     * Tooltip for the widget, either as a string or as a Tooltip config object.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-tooltip)
+     */
+    tooltip ? : string|TooltipConfig|null
+    /**
+     * By default, tabbing within a Panel is not contained, ie you can TAB out of the Panel
+     * forwards or backwards.
+     * Configure this as `true` to disallow tabbing out of the Panel, and make tabbing circular within this Panel.
+     */
+    trapFocus ? : Boolean
+    type ? : 'datepicker'
+    /**
+     * 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.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-ui)
+     */
+    ui ? : 'plain'|'toolbar'|string|object
+    /**
+     * The header text for the week number column, if shown.
+     */
+    weekColumnHeader ? : string
+    /**
+     * The class name to add to calendar cells which are weekend dates.
+     */
+    weekendCls ? : string
+    /**
+     * A function (or the name of a function) which creates content in, and may mutate the week cell element at the start of a week row.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-weekRenderer)
+     * @param {HTMLElement} weekCell The header element
+     * @param {number[]} week An array containing `[year, weekNumber]`
+     * @returns {string,DomConfig,void}
+     */
+    weekRenderer ? : ((weekCell: HTMLElement, week: number[]) => string|DomConfig|void)|string
+    /**
+     * The week start day, 0 meaning Sunday, 6 meaning Saturday.
+     * Defaults to [weekStartDay](https://bryntum.com/products/calendar/docs/api/Core/helper/DateHelper#property-weekStartDay-static).
+     */
+    weekStartDay ? : number
+    /**
+     * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/calendar/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.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-x)
+     */
+    x ? : number
+    /**
+     * The y position for the widget.
+     * ...
+     * [View online docs...](https://bryntum.com/products/calendar/docs/api/Core/widget/DatePicker#config-y)
+     */
+    y ? : number
+
+}