@bryntum/taskboard-angular 7.1.1

package/lib/bryntum-checkbox.component.d.ts

@@ -0,0 +1,968 @@
+/**
+ * Angular wrapper for Bryntum Checkbox
+ */
+import { ElementRef, SimpleChanges, OnDestroy, OnInit } from '@angular/core';
+import { AlignSpec, Base, Checkbox, CheckboxListeners, ContainerItemConfig, DomConfig, Field, FieldContainer, FieldContainerConfig, FieldTriggerConfig, KeyMapConfig, MaskConfig, Rectangle, Scroller, TabConfig, TooltipConfig, VueConfig, Widget } from '@bryntum/taskboard';
+import * as i0 from "@angular/core";
+export declare type BryntumCheckboxProps = {
+    /**
+     * 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/taskboard/docs/api/Core/widget/Checkbox#config-adopt)
+     */
+    adopt?: HTMLElement | string;
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#config-align)
+     */
+    align?: AlignSpec | string;
+    /**
+     * When this widget is a child of a [Container](https://bryntum.com/products/taskboard/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/taskboard/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/taskboard/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/taskboard/docs/api/Core/widget/Checkbox#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/taskboard/docs/api/Core/widget/Checkbox#config-ariaLabel)
+     */
+    ariaLabel?: string;
+    /**
+     * Specify `true` to automatically [collapse](https://bryntum.com/products/taskboard/docs/api/Core/widget/FieldContainer#config-collapsed) the field's
+     * [container](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#config-container) when the field is not [checked](#Core/widget/Checkbox#property-checked).
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#config-autoCollapse)
+     * @returns {boolean}
+     */
+    autoCollapse?: boolean | (() => boolean);
+    /**
+     * 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;
+    /**
+     * 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.
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#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/taskboard/docs/api/Core/widget/Checkbox#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/taskboard/docs/api/Core/widget/Checkbox#config-catchEventHandlerExceptions)
+     */
+    catchEventHandlerExceptions?: boolean;
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-floating).*
+     * Set to `true` to centre the Widget in browser viewport space.
+     */
+    centered?: boolean;
+    /**
+     * The checked state. The same as `value`.
+     */
+    checked?: boolean;
+    /**
+     * The value to provide for this widget in [values](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container#property-values) when it is
+     * [checked](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#property-checked).
+     * A value of `undefined` will cause this widget not to include its value when checked.
+     */
+    checkedValue?: any;
+    /**
+     * 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/taskboard/docs/api/Core/widget/Checkbox#config-cls)
+     */
+    cls?: string | object;
+    /**
+     * Checkbox color, must have match in CSS
+     */
+    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/taskboard/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/taskboard/docs/api/Core/widget/Checkbox) or [radio button](#Core/widget/Radio). See
+     * these classes for examples of nested fields.
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#config-container)
+     */
+    container?: Record<string, ContainerItemConfig> | ContainerItemConfig[] | FieldContainerConfig | FieldContainer;
+    /**
+     * The config controls how the value of nested items are handled when a parent container gets or sets its
+     * [values](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container#property-values).
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#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/taskboard/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/taskboard/docs/api/Core/widget/Checkbox#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 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 issues when upgrading to v7. Performs the following checks:
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#config-detectCSSCompatibilityIssues)
+     */
+    detectCSSCompatibilityIssues?: boolean;
+    /**
+     * Disable or enable the widget. It is similar to [readOnly](https://bryntum.com/products/taskboard/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/taskboard/docs/api/Core/widget/Checkbox#config-disabled)
+     */
+    disabled?: boolean | 'inert';
+    /**
+     * Controls the placement of this widget when it is added to a [panel's ](https://bryntum.com/products/taskboard/docs/api/Core/widget/Panel)
+     * [strips collection](https://bryntum.com/products/taskboard/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/taskboard/docs/api/Core/widget/Checkbox#config-dock)
+     */
+    dock?: 'top' | 'bottom' | 'left' | 'right' | 'start' | 'end' | 'header' | 'pre-header' | object;
+    /**
+     * *Only valid if this Widget is [floating](https://bryntum.com/products/taskboard/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/taskboard/docs/api/Core/widget/Checkbox#config-draggable)
+     */
+    draggable?: boolean | {
+        handleSelector?: string;
+    };
+    /**
+     * 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/taskboard/docs/api/Core/widget/Checkbox#config-elementAttributes)
+     */
+    elementAttributes?: Record<string, string | null>;
+    extraData?: any;
+    /**
+     * When this widget is a child of a [Container](https://bryntum.com/products/taskboard/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/taskboard/docs/api/Core/widget/Widget#config-floating).*
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#config-hideAnimation)
+     */
+    hideAnimation?: boolean | object;
+    /**
+     * 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.
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#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/taskboard/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/taskboard/docs/api/Core/helper/StringHelper#function-encodeHtml-static)).
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#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.
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#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/taskboard/docs/api/Core/widget/layout/Box) as the [layout](#Core/widget/Container#config-layout) to the
+     * [container](https://bryntum.com/products/taskboard/docs/api/Core/widget/Field#config-container).
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#config-inline)
+     */
+    inline?: 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/taskboard/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/taskboard/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
+     */
+    insertFirst?: HTMLElement | string;
+    /**
+     * 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/taskboard/docs/api/Core/widget/Checkbox#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).
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#config-keyStrokeChangeDelay)
+     */
+    keyStrokeChangeDelay?: number;
+    /**
+     * Label, prepended to field
+     */
+    label?: string;
+    /**
+     * CSS class name or class names to add to any configured [label](https://bryntum.com/products/taskboard/docs/api/Core/widget/mixin/Labelable#config-label)
+     */
+    labelCls?: string | object;
+    /**
+     * Label position, either 'before' the field or 'above' the field
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#config-labelPosition)
+     */
+    labelPosition?: 'before' | 'above' | null;
+    /**
+     * The labels to add either before or after the input field.
+     * Each label may have the following properties:
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#config-labels)
+     */
+    labels?: object[];
+    /**
+     * The width to apply to the `&lt;label&gt;` element. If a number is specified, `px` will be used.
+     */
+    labelWidth?: string | number;
+    /**
+     * The listener set for this object.
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#config-listeners)
+     */
+    listeners?: CheckboxListeners;
+    /**
+     * 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/taskboard/docs/api/Core/widget/Checkbox#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/taskboard/docs/api/Core/widget/Checkbox#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/taskboard/docs/api/Core/widget/Mask) created for the
+     * [masked](https://bryntum.com/products/taskboard/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/taskboard/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/taskboard/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/taskboard/docs/api/Core/widget/Widget#config-floating).*
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#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/taskboard/docs/api/Core/widget/Widget#config-width), *reading* the value will return the numeric value in pixels.
+     */
+    maxWidth?: string | 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/taskboard/docs/api/Core/widget/Widget#config-height), *reading* the value will return the numeric value in pixels.
+     */
+    minHeight?: string | 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/taskboard/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/taskboard/docs/api/Core/widget/Checkbox#config-monitorResize)
+     */
+    monitorResize?: boolean | {
+        immediate?: boolean;
+    };
+    /**
+     * 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/taskboard/docs/api/Core/widget/Widget#config-ref) and [id](#Core/widget/Widget#config-id) in
+     * [Container.values](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container#property-values).
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#config-name)
+     */
+    name?: 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/taskboard/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/taskboard/docs/api/Core/widget/Checkbox#config-owner)
+     */
+    owner?: Widget | any;
+    /**
+     * Set to `true` when a widget is rendered into another widget's [contentElement](https://bryntum.com/products/taskboard/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/taskboard/docs/api/Core/widget/Widget#property-contentElement).
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#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;
+    /**
+     * Makes the field unmodifiable by user action. The input area is not editable, and triggers
+     * are unresponsive.
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#config-readOnly)
+     */
+    readOnly?: boolean;
+    relayStoreEvents?: boolean;
+    /**
+     * 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/taskboard/docs/api/Core/widget/Field#property-showRequiredIndicator) is set.
+     */
+    required?: boolean;
+    /**
+     * If this field is not [readOnly](https://bryntum.com/products/taskboard/docs/api/Core/widget/Field#config-readOnly), then setting this option means that pressing
+     * the `ESCAPE` 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/taskboard/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/taskboard/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/taskboard/docs/api/Core/widget/Checkbox#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/taskboard/docs/api/Core/widget/Checkbox#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/taskboard/docs/api/Core/widget/Widget#config-floating).*
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#config-showAnimation)
+     */
+    showAnimation?: boolean | object;
+    /**
+     * `true` to automatically display a * after the label for this field when it is [required](https://bryntum.com/products/taskboard/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/taskboard/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;
+    /**
+     * A configuration for the [tab](https://bryntum.com/products/taskboard/docs/api/Core/widget/Tab) created for this widget when it is placed in a
+     * [TabPanel](https://bryntum.com/products/taskboard/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/taskboard/docs/api/Core/widget/Checkbox#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.
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#config-tabIndex)
+     */
+    tabIndex?: number;
+    /**
+     * Text to display on checkbox label
+     */
+    text?: string;
+    /**
+     * Text alignment: 'left', 'center' or 'right'. Also accepts direction neutral 'start' and 'end'.
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#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.
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#config-tooltip)
+     */
+    tooltip?: string | TooltipConfig | 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.
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#config-triggers)
+     */
+    triggers?: Record<string, FieldTriggerConfig> | Record<string, Widget>;
+    type?: 'checkbox' | 'check';
+    /**
+     * 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/taskboard/docs/api/Core/widget/Checkbox#config-ui)
+     */
+    ui?: string | object;
+    /**
+     * The value to provide for this widget in [values](https://bryntum.com/products/taskboard/docs/api/Core/widget/Container#property-values) when it is not
+     * [checked](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#property-checked).
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#config-uncheckedValue)
+     */
+    uncheckedValue?: any;
+    /**
+     * Set to `false` to not highlight a field as invalid while typing, to instead show it on ENTER key press
+     * or similar.
+     */
+    validateOnInput?: boolean;
+    /**
+     * The value of the checkbox. This is the same as `checked`.
+     */
+    value?: boolean;
+    /**
+     * A widgets weight determines its position among siblings when added to a [Container](https://bryntum.com/products/taskboard/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/taskboard/docs/api/Core/widget/Checkbox#config-x)
+     */
+    x?: number;
+    /**
+     * The y position for the widget.
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#config-y)
+     */
+    y?: number;
+};
+export declare class BryntumCheckboxComponent implements OnInit, OnDestroy {
+    static instanceClass: typeof Checkbox;
+    static instanceName: string;
+    private static bryntumEvents;
+    private static bryntumFeatureNames;
+    private static bryntumConfigs;
+    private static bryntumConfigsOnly;
+    private static bryntumProps;
+    private elementRef;
+    instance: Checkbox;
+    private bryntumConfig;
+    constructor(element: ElementRef);
+    adopt: HTMLElement | string;
+    align: AlignSpec | string;
+    anchor: boolean;
+    ariaDescription: string;
+    ariaLabel: string;
+    autoCollapse: boolean | (() => boolean);
+    autoComplete: string;
+    autoSelect: boolean;
+    bubbleEvents: object;
+    centered: boolean;
+    checkedValue: any;
+    color: string;
+    config: object;
+    constrainTo: HTMLElement | Widget | Rectangle;
+    container: Record<string, ContainerItemConfig> | ContainerItemConfig[] | FieldContainerConfig | FieldContainer;
+    containValues: boolean | string | ((field: Field) => boolean);
+    contentElementCls: string | object;
+    dataField: string;
+    defaultBindProperty: string;
+    detectCSSCompatibilityIssues: boolean;
+    dock: 'top' | 'bottom' | 'left' | 'right' | 'start' | 'end' | 'header' | 'pre-header' | object;
+    draggable: boolean | {
+        handleSelector?: string;
+    };
+    elementAttributes: Record<string, string | null>;
+    floating: boolean;
+    hideAnimation: boolean | object;
+    highlightExternalChange: boolean;
+    hint: string | ((data: {
+        source: Field;
+        value: any;
+    }) => string);
+    hintHtml: string | ((data: {
+        source: Field;
+        value: any;
+    }) => string);
+    ignoreParentReadOnly: boolean;
+    inline: boolean;
+    inputAlign: string;
+    inputAttributes: Record<string, string>;
+    inputTag: string;
+    inputType: string;
+    inputWidth: string | number;
+    keyStrokeChangeDelay: number;
+    labelCls: string | object;
+    labelPosition: 'before' | 'above' | null;
+    labels: object[];
+    labelWidth: string | number;
+    listeners: CheckboxListeners;
+    localeClass: typeof Base;
+    localizable: boolean;
+    localizableProperties: string[];
+    maskDefaults: MaskConfig;
+    masked: boolean | string | MaskConfig;
+    monitorResize: boolean | {
+        immediate?: boolean;
+    };
+    owner: Widget | any;
+    positioned: boolean;
+    preventTooltipOnTouch: boolean;
+    relayStoreEvents: boolean;
+    revertOnEscape: boolean;
+    ripple: boolean | {
+        delegate?: string;
+        color?: string;
+        radius?: number;
+        clip?: string;
+    };
+    rootElement: ShadowRoot | HTMLElement;
+    scrollAction: 'hide' | 'realign' | null;
+    showAnimation: boolean | object;
+    showTooltipWhenDisabled: boolean;
+    skipValidation: boolean;
+    spellCheck: boolean;
+    tab: boolean | TabConfig;
+    tabIndex: number;
+    text: string;
+    textAlign: 'left' | 'center' | 'right' | 'start' | 'end';
+    title: string;
+    type: 'checkbox' | 'check';
+    ui: string | object;
+    uncheckedValue: any;
+    validateOnInput: boolean;
+    weight: number;
+    alignSelf: string;
+    appendTo: HTMLElement | string;
+    badge: string;
+    callOnFunctions: boolean;
+    catchEventHandlerExceptions: boolean;
+    checked: boolean;
+    cls: string | object;
+    column: number;
+    dataset: object | Record<string, string>;
+    disabled: boolean | 'inert';
+    extraData: any;
+    flex: number | string;
+    height: number | string;
+    hidden: boolean;
+    id: string;
+    insertBefore: HTMLElement | string;
+    insertFirst: HTMLElement | string;
+    keyMap: Record<string, KeyMapConfig>;
+    label: string;
+    margin: number | string;
+    maxHeight: string | number;
+    maximizeOnMobile: number | string;
+    maxWidth: string | number;
+    minHeight: string | number;
+    minWidth: string | number;
+    name: string;
+    readOnly: boolean;
+    required: boolean;
+    rtl: boolean;
+    showRequiredIndicator: string;
+    span: number;
+    tooltip: string | TooltipConfig | null;
+    triggers: Record<string, FieldTriggerConfig> | Record<string, Widget>;
+    value: boolean;
+    width: number | string;
+    x: number;
+    y: number;
+    anchorSize: number[];
+    content: string;
+    editable: boolean;
+    focusVisible: boolean;
+    html: string | ((widget: Widget) => string) | DomConfig | DomConfig[] | VueConfig;
+    input: HTMLElement;
+    parent: Widget;
+    placeholder: string;
+    scrollable: Scroller;
+    /**
+     * User performed the default action (toggled the checkbox)
+     * @param {object} event Event object
+     * @param {Core.widget.Checkbox} event.source Checkbox
+     * @param {boolean} event.checked Checked state (=value)
+     * @param {boolean} event.value This field's value
+     * @param {boolean} event.valid True if this field is in a valid state
+     * @param {boolean} event.oldValue This field's previous value
+     * @param {boolean} event.userAction Triggered by user taking an action (`true`) or by setting a value (`false`)
+     * @param {Event} event.event The triggering DOM event if any
+     */
+    onAction: any;
+    /**
+     * Fired before checkbox is toggled. Returning false from a listener prevents the checkbox from being toggled.
+     * @param {object} event Event object
+     * @param {Core.widget.Checkbox} event.source Checkbox
+     * @param {boolean} event.checked Checked state (=value)
+     * @param {boolean} event.value This field's value
+     * @param {boolean} event.oldValue This field's previous value
+     * @param {boolean} event.userAction Triggered by user taking an action (`true`) or by setting a value (`false`)
+     * @param {boolean} event.valid True if this field is in a valid state.
+     * @param {Event} event.event The triggering DOM event if any
+     */
+    onBeforeChange: any;
+    /**
+     * Fires before an object is destroyed.
+     * @param {object} event Event object
+     * @param {Core.Base} event.source The Object that is being destroyed.
+     */
+    onBeforeDestroy: any;
+    /**
+     * Triggered before a widget is hidden. Return `false` to prevent the action.
+     * @param {object} event Event object
+     * @param {Core.widget.Widget} event.source The widget being hidden.
+     */
+    onBeforeHide: any;
+    /**
+     * Triggered before a widget is shown. Return `false` to prevent the action.
+     * @param {object} event Event object
+     * @param {Core.widget.Widget,any} event.source The widget being shown
+     */
+    onBeforeShow: any;
+    /**
+     * Fires when any other event is fired from the object.
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#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
+     */
+    onCatchAll: any;
+    /**
+     * Fired when checkbox is toggled
+     * @param {object} event Event object
+     * @param {Core.widget.Checkbox} event.source Checkbox
+     * @param {boolean} event.checked Checked state (=value)
+     * @param {boolean} event.value This field's value
+     * @param {boolean} event.oldValue This field's previous value
+     * @param {boolean} event.userAction Triggered by user taking an action (`true`) or by setting a value (`false`)
+     * @param {boolean} event.valid True if this field is in a valid state.
+     * @param {Event} event.event The triggering DOM event if any
+     */
+    onChange: any;
+    /**
+     * Fired when this field is [cleared](https://bryntum.com/products/taskboard/docs/api/Core/widget/Field#function-clear).
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#event-clear)
+     * @param {object} event Event object
+     * @param {Core.widget.Field,any} event.source This Field
+     */
+    onClear: any;
+    /**
+     * Fires when the checkbox is clicked
+     * @param {object} event Event object
+     * @param {Core.widget.Checkbox} event.source The checkbox
+     * @param {Event} event.event DOM event
+     */
+    onClick: any;
+    /**
+     * Fires when an object is destroyed.
+     * @param {object} event Event object
+     * @param {Core.Base} event.source The Object that is being destroyed.
+     */
+    onDestroy: any;
+    /**
+     * Triggered when a widget's [element](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#property-element) is available.
+     * @param {object} event Event object
+     * @param {HTMLElement} event.element The Widget's element.
+     */
+    onElementCreated: any;
+    /**
+     * Fired when focus enters this Widget.
+     * @param {object} event Event object
+     * @param {Core.widget.Widget} event.source This Widget
+     * @param {HTMLElement} event.fromElement The element which lost focus.
+     * @param {HTMLElement} event.toElement The element which gained focus.
+     * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
+     * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
+     * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
+     */
+    onFocusIn: any;
+    /**
+     * Fired when focus exits this Widget's ownership tree. This is different from a `blur` event.
+     * focus moving from within this Widget's ownership tree, even if there are floating widgets
+     * will not trigger this event. This is when focus exits this widget completely.
+     * @param {object} event Event object
+     * @param {Core.widget.Widget} event.source This Widget
+     * @param {HTMLElement} event.fromElement The element which lost focus.
+     * @param {HTMLElement} event.toElement The element which gained focus.
+     * @param {Core.widget.Widget} event.fromWidget The widget which lost focus.
+     * @param {Core.widget.Widget} event.toWidget The widget which gained focus.
+     * @param {boolean} event.backwards `true` if the `toElement` is before the `fromElement` in document order.
+     */
+    onFocusOut: any;
+    /**
+     * Triggered after a widget was hidden
+     * @param {object} event Event object
+     * @param {Core.widget.Widget} event.source The widget
+     */
+    onHide: any;
+    /**
+     * Fired when the user types into this field.
+     * @param {object} event Event object
+     * @param {Core.widget.Field,any} event.source This field
+     * @param {string,number,boolean,any} event.value This field's value
+     * @param {Event} event.event The triggering DOM event
+     */
+    onInput: any;
+    /**
+     * Triggered when a widget which had been in a non-visible state for any reason
+     * achieves visibility.
+     * ...
+     * [View online docs...](https://bryntum.com/products/taskboard/docs/api/Core/widget/Checkbox#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.
+     */
+    onPaint: any;
+    /**
+     * Fired when a Widget's read only state is toggled
+     * @param {object} event Event object
+     * @param {boolean} event.readOnly Read only or not
+     */
+    onReadOnly: any;
+    /**
+     * This event is fired after a widget's elements have been synchronized due to a direct or indirect call
+     * to [recompose](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#function-recompose), if this results in some change to the widget's rendered DOM elements.
+     */
+    onRecompose: any;
+    /**
+     * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/taskboard/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
+     * @param {object} event Event object
+     * @param {Core.widget.Widget} event.source This Widget
+     * @param {number} event.width The new width
+     * @param {number} event.height The new height
+     * @param {number} event.oldWidth The old width
+     * @param {number} event.oldHeight The old height
+     */
+    onResize: any;
+    /**
+     * Triggered after a widget is shown.
+     * @param {object} event Event object
+     * @param {Core.widget.Widget} event.source The widget
+     */
+    onShow: any;
+    /**
+     * User clicked one of this field's [triggers](https://bryntum.com/products/taskboard/docs/api/Core/widget/Field#property-triggers)
+     * @param {object} event Event object
+     * @param {Core.widget.Field,any} event.source This field
+     * @param {Core.widget.Widget} event.trigger The trigger activated by click or touch tap.
+     */
+    onTrigger: any;
+    /**
+     * Create and append the underlying widget
+     */
+    ngOnInit(): void;
+    /**
+     * Watch for changes
+     * @param changes
+     */
+    ngOnChanges(changes: SimpleChanges): void;
+    /**
+     * Destroy the component
+     */
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<BryntumCheckboxComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<BryntumCheckboxComponent, "bryntum-checkbox", never, { "adopt": "adopt"; "align": "align"; "anchor": "anchor"; "ariaDescription": "ariaDescription"; "ariaLabel": "ariaLabel"; "autoCollapse": "autoCollapse"; "autoComplete": "autoComplete"; "autoSelect": "autoSelect"; "bubbleEvents": "bubbleEvents"; "centered": "centered"; "checkedValue": "checkedValue"; "color": "color"; "config": "config"; "constrainTo": "constrainTo"; "container": "container"; "containValues": "containValues"; "contentElementCls": "contentElementCls"; "dataField": "dataField"; "defaultBindProperty": "defaultBindProperty"; "detectCSSCompatibilityIssues": "detectCSSCompatibilityIssues"; "dock": "dock"; "draggable": "draggable"; "elementAttributes": "elementAttributes"; "floating": "floating"; "hideAnimation": "hideAnimation"; "highlightExternalChange": "highlightExternalChange"; "hint": "hint"; "hintHtml": "hintHtml"; "ignoreParentReadOnly": "ignoreParentReadOnly"; "inline": "inline"; "inputAlign": "inputAlign"; "inputAttributes": "inputAttributes"; "inputTag": "inputTag"; "inputType": "inputType"; "inputWidth": "inputWidth"; "keyStrokeChangeDelay": "keyStrokeChangeDelay"; "labelCls": "labelCls"; "labelPosition": "labelPosition"; "labels": "labels"; "labelWidth": "labelWidth"; "listeners": "listeners"; "localeClass": "localeClass"; "localizable": "localizable"; "localizableProperties": "localizableProperties"; "maskDefaults": "maskDefaults"; "masked": "masked"; "monitorResize": "monitorResize"; "owner": "owner"; "positioned": "positioned"; "preventTooltipOnTouch": "preventTooltipOnTouch"; "relayStoreEvents": "relayStoreEvents"; "revertOnEscape": "revertOnEscape"; "ripple": "ripple"; "rootElement": "rootElement"; "scrollAction": "scrollAction"; "showAnimation": "showAnimation"; "showTooltipWhenDisabled": "showTooltipWhenDisabled"; "skipValidation": "skipValidation"; "spellCheck": "spellCheck"; "tab": "tab"; "tabIndex": "tabIndex"; "text": "text"; "textAlign": "textAlign"; "title": "title"; "type": "type"; "ui": "ui"; "uncheckedValue": "uncheckedValue"; "validateOnInput": "validateOnInput"; "weight": "weight"; "alignSelf": "alignSelf"; "appendTo": "appendTo"; "badge": "badge"; "callOnFunctions": "callOnFunctions"; "catchEventHandlerExceptions": "catchEventHandlerExceptions"; "checked": "checked"; "cls": "cls"; "column": "column"; "dataset": "dataset"; "disabled": "disabled"; "extraData": "extraData"; "flex": "flex"; "height": "height"; "hidden": "hidden"; "id": "id"; "insertBefore": "insertBefore"; "insertFirst": "insertFirst"; "keyMap": "keyMap"; "label": "label"; "margin": "margin"; "maxHeight": "maxHeight"; "maximizeOnMobile": "maximizeOnMobile"; "maxWidth": "maxWidth"; "minHeight": "minHeight"; "minWidth": "minWidth"; "name": "name"; "readOnly": "readOnly"; "required": "required"; "rtl": "rtl"; "showRequiredIndicator": "showRequiredIndicator"; "span": "span"; "tooltip": "tooltip"; "triggers": "triggers"; "value": "value"; "width": "width"; "x": "x"; "y": "y"; "anchorSize": "anchorSize"; "content": "content"; "editable": "editable"; "focusVisible": "focusVisible"; "html": "html"; "input": "input"; "parent": "parent"; "placeholder": "placeholder"; "scrollable": "scrollable"; }, { "onAction": "onAction"; "onBeforeChange": "onBeforeChange"; "onBeforeDestroy": "onBeforeDestroy"; "onBeforeHide": "onBeforeHide"; "onBeforeShow": "onBeforeShow"; "onCatchAll": "onCatchAll"; "onChange": "onChange"; "onClear": "onClear"; "onClick": "onClick"; "onDestroy": "onDestroy"; "onElementCreated": "onElementCreated"; "onFocusIn": "onFocusIn"; "onFocusOut": "onFocusOut"; "onHide": "onHide"; "onInput": "onInput"; "onPaint": "onPaint"; "onReadOnly": "onReadOnly"; "onRecompose": "onRecompose"; "onResize": "onResize"; "onShow": "onShow"; "onTrigger": "onTrigger"; }, never, never>;
+}