@bryntum/core-react-thin 7.2.3 → 7.3.0

package/src/BryntumWidget.tsx

@@ -3,7 +3,7 @@
  */
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 import React, { RefObject } from 'react';
-import { AlignSpec, Base, Color, DomConfig, KeyMapConfig, MaskConfig, Rectangle, Scroller, ScrollerConfig, TabConfig, TooltipConfig, VueConfig, Widget, WidgetListeners } from '@bryntum/core-thin';
+import { AlignSpec, Base, Color, DomConfig, KeyMapConfig, MaskConfig, ReactJSX, Rectangle, Scroller, ScrollerConfig, TabConfig, TooltipConfig, VueConfig, Widget, WidgetListeners } from '@bryntum/core-thin';
 
 import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
 
@@ -12,14 +12,12 @@ export type BryntumWidgetProps = {
     /**
      * 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/grid/docs/api/Core/widget/Widget#config-adopt)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-adopt)
      */
     adopt? : HTMLElement|string
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
-     * ...
-     * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-align)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-align)
      */
     align? : AlignSpec|string
     /**
@@ -41,35 +39,30 @@ export type BryntumWidgetProps = {
     /**
      * 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/grid/docs/api/Core/widget/Widget#config-ariaDescription)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#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/grid/docs/api/Core/widget/Widget#config-ariaLabel)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-ariaLabel)
      */
     ariaLabel? : string
     /**
      * 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/grid/docs/api/Core/widget/Widget#config-bubbleEvents)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#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/grid/docs/api/Core/widget/Widget#config-callOnFunctions)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#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/grid/docs/api/Core/widget/Widget#config-catchEventHandlerExceptions)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-catchEventHandlerExceptions)
      */
     catchEventHandlerExceptions? : boolean
     /**
@@ -81,15 +74,13 @@ export type BryntumWidgetProps = {
      * 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/grid/docs/api/Core/widget/Widget#config-cls)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-cls)
      */
     cls? : string|object
     /**
      * 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/grid/docs/api/Core/widget/Widget#config-color)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-color)
      */
     color? : Color
     /**
@@ -113,8 +104,7 @@ export type BryntumWidgetProps = {
      * Custom CSS classes to add to the [contentElement](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/Widget#config-contentElementCls)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-contentElementCls)
      */
     contentElementCls? : string|object
     /**
@@ -132,16 +122,15 @@ export type BryntumWidgetProps = {
      */
     defaultBindProperty? : string
     /**
-     * Check for CSS compatibility issues when upgrading to v7. Performs the following checks:
-     * ...
-     * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-detectCSSCompatibilityIssues)
+     * Check for CSS compatibility and inclusion related issues and try to auto fix them. Performs the following
+     * checks:
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-detectCSSCompatibilityIssues)
      */
     detectCSSCompatibilityIssues? : boolean
     /**
      * Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/Widget#config-disabled)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-disabled)
      */
     disabled? : boolean|'inert'
     /**
@@ -149,25 +138,21 @@ export type BryntumWidgetProps = {
      * [strips collection](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/Widget#config-dock)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-dock)
      */
     dock? : 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/Widget#config-draggable)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#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|{
-        handleSelector?: string
-    }
+    draggable? : boolean|object
     /**
      * 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/grid/docs/api/Core/widget/Widget#config-elementAttributes)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-elementAttributes)
      */
     elementAttributes? : Record<string, string|null>
     extraData? : any
@@ -196,18 +181,15 @@ export type BryntumWidgetProps = {
     hidden? : boolean
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
-     * ...
-     * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-hideAnimation)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-hideAnimation)
      */
     hideAnimation? : boolean|object
     /**
      * The HTML to display initially or a function returning the markup (called at widget construction time).
-     * ...
-     * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-html)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-html)
      * @param {Core.widget.Widget} widget The calling Widget
-     * @returns {string}
      */
-    html? : string|((widget: Widget) => string)|DomConfig|DomConfig[]|VueConfig
+    html? : string|((widget: Widget) => void)|DomConfig|DomConfig[]|VueConfig|ReactJSX
     /**
      * The CSS class(es) to add when HTML content is being applied to this widget.
      */
@@ -218,8 +200,7 @@ export type BryntumWidgetProps = {
     id? : string
     /**
      * Determines if the widgets read-only state should be controlled by its parent.
-     * ...
-     * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-ignoreParentReadOnly)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-ignoreParentReadOnly)
      */
     ignoreParentReadOnly? : boolean
     /**
@@ -234,22 +215,19 @@ export type BryntumWidgetProps = {
      * 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/grid/docs/api/Core/widget/Widget#config-keyMap)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-keyMap)
      */
     keyMap? : Record<string, KeyMapConfig>
     /**
      * The listener set for this object.
-     * ...
-     * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-listeners)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-listeners)
      */
     listeners? : WidgetListeners
     /**
      * 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/grid/docs/api/Core/widget/Widget#config-localeClass)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-localeClass)
      */
     localeClass? : typeof Base
     /**
@@ -261,8 +239,7 @@ export type BryntumWidgetProps = {
      * 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/grid/docs/api/Core/widget/Widget#config-localizableProperties)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-localizableProperties)
      */
     localizableProperties? : string[]
     /**
@@ -288,8 +265,7 @@ export type BryntumWidgetProps = {
     maxHeight? : string|number
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
-     * ...
-     * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-maximizeOnMobile)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-maximizeOnMobile)
      */
     maximizeOnMobile? : number|string
     /**
@@ -311,18 +287,15 @@ export type BryntumWidgetProps = {
      * 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/grid/docs/api/Core/widget/Widget#config-monitorResize)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize)
+     * @property {boolean} immediate Set to `true` to receive resize notifications immediately.
      */
-    monitorResize? : boolean|{
-        immediate?: boolean
-    }
+    monitorResize? : boolean|object
     /**
      * Set to `true` when a widget is rendered into another widget's [contentElement](https://bryntum.com/products/core/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/core/docs/api/Core/widget/Widget#property-contentElement).
-     * ...
-     * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-positioned)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-positioned)
      */
     positioned? : boolean
     /**
@@ -333,8 +306,7 @@ export type BryntumWidgetProps = {
     /**
      * 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/grid/docs/api/Core/widget/Widget#config-readOnly)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-readOnly)
      */
     readOnly? : boolean
     relayStoreEvents? : boolean
@@ -342,23 +314,26 @@ export type BryntumWidgetProps = {
      * Configure as `true` to have the component display a translucent ripple when its
      * [focusElement](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/Widget#config-ripple)
-     */
-    ripple? : boolean|{
-        delegate?: string
-        color?: string
-        radius?: number
-        clip?: string
-    }
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#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/grid/docs/api/Core/widget/Widget#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.
-     * ...
-     * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-rtl)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-rtl)
      */
     rtl? : boolean
     /**
@@ -366,8 +341,7 @@ export type BryntumWidgetProps = {
      * 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/grid/docs/api/Core/widget/Widget#config-scrollable)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-scrollable)
      */
     scrollable? : boolean|ScrollerConfig|Scroller
     /**
@@ -377,8 +351,7 @@ export type BryntumWidgetProps = {
     scrollAction? : 'hide'|'realign'|null
     /**
      * *Only valid if this Widget is [floating](https://bryntum.com/products/core/docs/api/Core/widget/Widget#config-floating).*
-     * ...
-     * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-showAnimation)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-showAnimation)
      */
     showAnimation? : boolean|object
     /**
@@ -393,8 +366,7 @@ export type BryntumWidgetProps = {
      * A configuration for the [tab](https://bryntum.com/products/core/docs/api/Core/widget/Tab) created for this widget when it is placed in a
      * [TabPanel](https://bryntum.com/products/core/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/grid/docs/api/Core/widget/Widget#config-tab)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-tab)
      */
     tab? : boolean|TabConfig
     /**
@@ -403,8 +375,7 @@ export type BryntumWidgetProps = {
     tag? : string
     /**
      * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
-     * ...
-     * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-textAlign)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-textAlign)
      */
     textAlign? : 'left'|'center'|'right'|'start'|'end'
     /**
@@ -413,8 +384,7 @@ export type BryntumWidgetProps = {
     title? : string
     /**
      * Tooltip for the widget, either as a string or as a Tooltip config object.
-     * ...
-     * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-tooltip)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-tooltip)
      */
     tooltip? : string|TooltipConfig|null
     type? : 'widget'
@@ -422,8 +392,7 @@ export type BryntumWidgetProps = {
      * 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/grid/docs/api/Core/widget/Widget#config-ui)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-ui)
      */
     ui? : string|object
     /**
@@ -439,14 +408,12 @@ export type BryntumWidgetProps = {
     width? : string|number
     /**
      * The x position for the widget.
-     * ...
-     * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-x)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-x)
      */
     x? : number
     /**
      * The y position for the widget.
-     * ...
-     * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-y)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-y)
      */
     y? : number
 
@@ -471,8 +438,7 @@ export type BryntumWidgetProps = {
     onBeforeShow? : ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string
     /**
      * Fires when any other event is fired from the object.
-     * ...
-     * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#event-catchAll)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#event-catchAll)
      * @param {object} event Event object
      * @param {{[key: string]: any, type: string}} event.event The Object that contains event details
      * @param {string} event.event.type The type of the event which is caught by the listener
@@ -523,8 +489,7 @@ export type BryntumWidgetProps = {
     /**
      * Triggered when a widget which had been in a non-visible state for any reason
      * achieves visibility.
-     * ...
-     * [View online docs...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#event-paint)
+     * [More...](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#event-paint)
      * @param {object} event Event object
      * @param {Core.widget.Widget} event.source The widget being painted.
      * @param {boolean} event.firstPaint `true` if this is the first paint.
@@ -601,6 +566,7 @@ export class BryntumWidget extends React.Component<BryntumWidgetProps> {
         'preventTooltipOnTouch',
         'relayStoreEvents',
         'ripple',
+        'role',
         'rootElement',
         'scrollAction',
         'showAnimation',
@@ -664,8 +630,6 @@ export class BryntumWidget extends React.Component<BryntumWidgetProps> {
     ];
 
     static propertyNames = [
-        'anchorSize',
-        'focusVisible',
         'parent'
     ];