@vandenberghinc/volt 1.1.26 → 1.1.28

package/frontend/dist/frontend/src/ui/border_button.d.ts

@@ -0,0 +1,94 @@
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
+ */
+import { VDivElement, VElementTagMap } from "../elements/module.js";
+/**
+ * Supports a gradient color for the border combined with border radius.
+ * Warning: this class is still experimental and may be subject to future change.
+ */
+export declare class BorderButtonElement extends VElementTagMap.a {
+    nodes: {
+        border: VDivElement;
+        text: VDivElement;
+        [key: string]: any;
+    };
+    /**
+     * Initializes a new instance of the BorderButton element with the provided text.
+     * @param text The text to be displayed on the BorderButton.
+     * @returns This constructor does not return a value.
+     * @docs
+     */
+    constructor(text?: string);
+    /**
+     * Sets or gets the gradient color for the border element. If no value is provided, the current background is returned.
+     * @param value The color value to set for the gradient.
+     * @returns When a value is provided, returns this for chaining; otherwise, returns the current background value.
+     * @docs
+     */
+    gradient(): string;
+    gradient(value: string | null): this;
+    /**
+     * Sets or gets the border color of the element. If no value is provided, the current border color is returned.
+     * @param value The color value to set for the border.
+     * @returns When a value is provided, returns this for chaining; otherwise, returns the current border color.
+     * @docs
+     */
+    border_color(): string;
+    border_color(value: string | null): this;
+    /**
+     * Sets or retrieves the border width of the element. If no argument is passed, the current border width (padding) is returned.
+     * @param value The value of the border width to set.
+     * @returns When a value is provided, returns this for chaining; otherwise, returns the current border width.
+     * @docs
+     */
+    border_width(): string;
+    border_width(value: string | number): this;
+    /**
+     * Sets or gets the border radius for the element. If no value is provided, the current border radius is returned.
+     * @param value The value for the border radius to set.
+     * @returns Returns the current border radius if no value is provided; otherwise, returns this for chaining.
+     * @docs
+     */
+    border_radius(): string;
+    border_radius(value: string | number): this;
+    /**
+     * Sets or retrieves the color of the child text. When a value is provided, it updates the color; when omitted, it returns the current color.
+     * @param value The color value to set for the child text.
+     * @returns Returns the current color if no value is provided; otherwise, returns this for chaining.
+     * @docs
+     */
+    color(): string;
+    color(value: string): this;
+    /**
+     * Retrieves or sets the styling attributes for the element. If no argument is provided, styles are computed from child elements.
+     * @param style_dict A dictionary of styles to set. If omitted, the method computes styles based on child elements.
+     * @returns Returns the computed styles when no argument is passed, or the result of the super method when an argument is provided.
+     * @docs
+     */
+    styles(): Record<string, string>;
+    styles(style_dict: Record<string, any>): this;
+    /**
+     * Sets or gets the text of the element. If a value is provided, it sets the text; otherwise, it returns the current text.
+     * @param val The value to set as text or omitted to retrieve the current text.
+     * @returns When a value is provided, returns this for chaining; otherwise, returns the current text.
+     * @docs
+     */
+    text(): string;
+    text(val: string): this;
+    /**
+     * Sets or retrieves the transition for the border color of the element.
+     * @param val The value to set for the transition or omit to retrieve the current transition.
+     * @returns When a value is provided, returns this for chaining; otherwise, returns the already set transition value.
+     * @docs
+     */
+    transition_border_color(): string;
+    transition_border_color(val: string): this;
+}
+export declare const BorderButton: <Extensions extends object = {}>(text?: string | undefined) => BorderButtonElement & Extensions;
+export declare const NullBorderButton: <Extensions extends object = {}>() => BorderButtonElement & Extensions;
+declare module './any_element.d.ts' {
+    interface AnyElementMap {
+        BorderButtonElement: BorderButtonElement;
+    }
+}

package/frontend/dist/{ui → frontend/src/ui}/border_button.js

@@ -1,6 +1,6 @@
-/*
- * Author: Daan van den Bergh
- * Copyright: © 2022 - 2024 Daan van den Bergh.
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
  */
 var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
     function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
@@ -96,16 +96,10 @@ let BorderButtonElement = (() => {
         }
         nodes;
         /**
-         * @docs:
-         * @title: Constructor
-         * @desc: Initializes a new instance of the BorderButton element with the provided text.
-         * @param:
-         *     @name: text
-         *     @descr: The text to be displayed on the BorderButton.
-         *     @type: string
-         * @return:
-         *     @type: void
-         *     @description This constructor does not return a value.
+         * Initializes a new instance of the BorderButton element with the provided text.
+         * @param text The text to be displayed on the BorderButton.
+         * @returns This constructor does not return a value.
+         * @docs
          */
         constructor(text = "") {
             // Initialize base classes.

package/frontend/dist/frontend/src/ui/button.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
+ */
+import { VElementTagMap } from "../elements/module.js";
+import { BorderButtonElement } from "./border_button.js";
+import { LoaderButtonElement } from "./loader_button.js";
+/**
+ * Is any button like,
+ * including loader and bordered buttons.
+ */
+export declare function isButtonLike(element: any): element is (ButtonElement | LoaderButtonElement | BorderButtonElement);
+export declare class ButtonElement extends VElementTagMap.a {
+    /**
+     * Initializes the Button element with the provided text.
+     * @param text The text to display on the button.
+     * @nav Frontend/Buttons
+     * @docs
+     */
+    constructor(text?: string);
+}
+export declare const Button: <Extensions extends object = {}>(text?: string | undefined) => ButtonElement & Extensions;
+export declare const NullButton: <Extensions extends object = {}>() => ButtonElement & Extensions;
+declare module './any_element.d.ts' {
+    interface AnyElementMap {
+        ButtonElement: ButtonElement;
+    }
+}

package/frontend/dist/{ui → frontend/src/ui}/button.js

@@ -1,6 +1,6 @@
-/*
- * Author: Daan van den Bergh
- * Copyright: © 2022 - 2024 Daan van den Bergh.
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
  */
 var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
     function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
@@ -37,7 +37,20 @@ var __runInitializers = (this && this.__runInitializers) || function (thisArg, i
     return useValue ? value : void 0;
 };
 // Imports.
-import { Elements, VElementTagMap } from "../elements/module.js";
+import { Elements, VElementTagMap, isVElement } from "../elements/module.js";
+import { BorderButtonElement } from "./border_button.js";
+import { LoaderButtonElement } from "./loader_button.js";
+/**
+ * Is any button like,
+ * including loader and bordered buttons.
+ */
+export function isButtonLike(element) {
+    return (element instanceof ButtonElement
+        || element instanceof LoaderButtonElement
+        || element instanceof BorderButtonElement) || (isVElement(element) && (element.element_name === "ButtonElement"
+        || element.element_name === "LoaderButtonElement"
+        || element.element_name === "BorderButtonElement"));
+}
 // Button.
 let ButtonElement = (() => {
     let _classDecorators = [Elements.create({
@@ -86,14 +99,10 @@ let ButtonElement = (() => {
             __runInitializers(_classThis, _classExtraInitializers);
         }
         /**
-         * @docs:
-         * @nav: Frontend
-         * @chapter: Buttons
-         * @title: Button
-         * @desc: Initializes the Button element with the provided text.
-         * @param:
-         *     @name: text
-         *     @description The text to display on the button.
+         * Initializes the Button element with the provided text.
+         * @param text The text to display on the button.
+         * @nav Frontend/Buttons
+         * @docs
          */
         constructor(text = "") {
             super({

package/frontend/dist/frontend/src/ui/canvas.d.ts

@@ -0,0 +1,138 @@
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
+ */
+import { VElementTagMap } from "../elements/module.js";
+import { GradientType } from "../types/gradient.js";
+/**
+ * A point in 2D space used for drawing lines.
+ * Optional `tension` overrides curve smoothing for that segment.
+ */
+type PointObject = {
+    x: number;
+    y: number;
+    tension?: number;
+};
+/**
+ * Canvas element.
+ * @nav Frontend/Elements
+ * @experimental true
+ * @warning This class is still experimental and may be subject to future change.
+ * @docs
+ */
+export declare class CanvasElement extends VElementTagMap.canvas {
+    _e: any;
+    ctx_2d: any;
+    /**
+     * Initialize the canvas element and, on Safari, create a shadow DOM
+     * canvas to work around rendering issues.
+     */
+    constructor();
+    height(): string | number;
+    height(value: string | number, check_attribute?: boolean): this;
+    min_height(): string | number;
+    min_height(value: string | number): this;
+    max_height(): string;
+    max_height(value: string | number): this;
+    width(): string | number;
+    width(value: string | number, check_attribute?: boolean): this;
+    min_width(): string | number;
+    min_width(value: string | number): this;
+    max_width(): string;
+    max_width(value: string | number): this;
+    /**
+     * Get a rendering context for the canvas.
+     * In Safari, forwards to the shadow canvas element.
+     * @param args Arguments forwarded to `HTMLCanvasElement.getContext`.
+     * @returns The rendering context.
+     */
+    getContext(...args: any[]): any;
+    /**
+     * Draw a smoothed path through the given points on the provided context.
+     * Uses a Catmull–Rom style bezier approximation controlled by `tension`.
+     * @param ctx Canvas 2D context.
+     * @param points Ordered list of points to draw through.
+     * @param tension Optional smoothing factor; 0 for straight segments.
+     * @returns this
+     */
+    draw_lines(ctx: any, points?: PointObject[], tension?: number): this;
+    /**
+     * Create a canvas gradient from a `GradientType` definition.
+     * Supports linear and (placeholder) radial gradients.
+     * @param ctx Canvas 2D context.
+     * @param gradient The gradient definition (`GradientType`).
+     * @param start_x Start x coordinate.
+     * @param start_y Start y coordinate.
+     * @param end_x End x coordinate.
+     * @param end_y End y coordinate.
+     * @returns The created gradient or null when invalid.
+     */
+    create_gradient(ctx: any, gradient: GradientType, start_x: number, start_y: number, end_x: number, end_y: number): any;
+    /**
+     * Create a line, optionally curved and with custom styling.
+     * @returns Returns the `Canvas` object.
+     * @param points The line points, an array with objects with `x` and `y` values.
+     * @param tension The smoothness of the line, use `null` or `0` for a straight line and {0.0, 2.0} for a smooth line.
+     * @param color The line color.
+     * @param width The line width in pixels.
+     * @param fill The fill color, supports a `GradientType` class. leave `null` to ignore.
+     * @param scale When enabled all x and y coordinates are treated as a 0.0 till 1.0 scale in relation to the canvas' width and height.
+     * @param dots Place dots at each coordinate, leave `null` to ignore.
+     * @param dots.width Dot width in pixels when `scale` is `false`, and dot width in percentage `{0.0,1.0}` when `scale` is `true`.
+     * @param dots.color Fill color.
+     * @docs
+     */
+    lines({ points, tension, color, width, fill, scale, dots, }: {
+        points: PointObject[];
+        tension?: number;
+        color?: string;
+        width?: number;
+        fill?: string | GradientType;
+        scale?: boolean;
+        dots?: {
+            width?: number;
+            color?: string | GradientType;
+        };
+    }): this;
+    /**
+     * Clear the entire canvas.
+     * @returns this
+     */
+    clear(): this;
+    /**
+     * Get or set the shadow color used for drawing operations.
+     * @param val The CSS color value.
+     * @returns The current shadow color or this.
+     */
+    shadow_color(): string;
+    shadow_color(val: string): this;
+    /**
+     * Get or set the shadow blur radius.
+     * @param val The blur amount.
+     * @returns The current shadow blur or this.
+     */
+    shadow_blur(): string;
+    shadow_blur(val: string): this;
+    /**
+     * Get or set the horizontal shadow offset.
+     * @param val The offset value.
+     * @returns The current shadow offset X or this.
+     */
+    shadow_offset_x(): string;
+    shadow_offset_x(val: number | string): this;
+    /**
+     * Get or set the vertical shadow offset.
+     * @param val The offset value.
+     * @returns The current shadow offset Y or this.
+     */
+    shadow_offset_y(): string;
+    shadow_offset_y(val: number | string): this;
+}
+export declare const Canvas: <Extensions extends object = {}>() => CanvasElement & Extensions;
+export declare const NullCanvas: <Extensions extends object = {}>() => CanvasElement & Extensions;
+declare module './any_element.d.ts' {
+    interface AnyElementMap {
+        CanvasElement: CanvasElement;
+    }
+}
+export {};

package/frontend/dist/{ui → frontend/src/ui}/canvas.js

@@ -1,6 +1,6 @@
-/*
- * Author: Daan van den Bergh
- * Copyright: © 2022 - 2024 Daan van den Bergh.
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
  */
 var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
     function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
@@ -41,15 +41,12 @@ import { Utils } from "../modules/utils.js";
 import { Elements, VElementTagMap } from "../elements/module.js";
 import { GradientType } from "../types/gradient.js";
 // Canvas.
-/*	@docs:
- *	@nav: Frontend
- *	@chapter: Elements
- *	@title: Canvas
- *	@description:
- *		Canvas element.
- *	@experimental: true
- *	@warning:
- *		This class is still experimental and may be subject to future change.
+/**
+ * Canvas element.
+ * @nav Frontend/Elements
+ * @experimental true
+ * @warning This class is still experimental and may be subject to future change.
+ * @docs
  */
 let CanvasElement = (() => {
     let _classDecorators = [Elements.create({
@@ -73,6 +70,10 @@ let CanvasElement = (() => {
         ctx_2d;
         // ---------------------------------------------------------
         // Constructors.
+        /**
+         * Initialize the canvas element and, on Safari, create a shadow DOM
+         * canvas to work around rendering issues.
+         */
         constructor() {
             super({
                 derived: CanvasElement,
@@ -95,6 +96,12 @@ let CanvasElement = (() => {
             }
             this.ctx_2d = this.getContext("2d");
         }
+        /**
+         * Get or set the canvas height with Safari shadow-canvas support.
+         * @param value The height value.
+         * @param check_attribute When true, also update the element attribute.
+         * @returns The current height or this.
+         */
         height(value, check_attribute) {
             if (this._e === undefined) {
                 return super.height(value, check_attribute);
@@ -107,6 +114,11 @@ let CanvasElement = (() => {
             this._e.height = this.pad_numeric(value, "");
             return this;
         }
+        /**
+         * Get or set the minimum canvas height (Safari shadow-canvas aware).
+         * @param value The minimum height value.
+         * @returns The current minimum height or this.
+         */
         min_height(value) {
             if (this._e === undefined) {
                 return super.min_height(value);
@@ -117,6 +129,11 @@ let CanvasElement = (() => {
             this._e.style.minHeight = this.pad_numeric(value, "px");
             return this;
         }
+        /**
+         * Get or set the maximum canvas height (Safari shadow-canvas aware).
+         * @param value The maximum height value.
+         * @returns The current maximum height or this.
+         */
         max_height(value) {
             if (this._e === undefined) {
                 return super.max_height(value);
@@ -127,6 +144,12 @@ let CanvasElement = (() => {
             this._e.style.maxHeight = this.pad_numeric(value, "px");
             return this;
         }
+        /**
+         * Get or set the canvas width with Safari shadow-canvas support.
+         * @param value The width value.
+         * @param check_attribute When true, also update the element attribute.
+         * @returns The current width or this.
+         */
         width(value, check_attribute = true) {
             if (this._e === undefined) {
                 return super.width(value, check_attribute);
@@ -139,6 +162,11 @@ let CanvasElement = (() => {
             this._e.width = value;
             return this;
         }
+        /**
+         * Get or set the minimum canvas width (Safari shadow-canvas aware).
+         * @param value The minimum width value.
+         * @returns The current minimum width or this.
+         */
         min_width(value) {
             if (this._e === undefined) {
                 return super.min_width(value);
@@ -149,6 +177,11 @@ let CanvasElement = (() => {
             this._e.style.minWidth = this.pad_numeric(value, "px");
             return this;
         }
+        /**
+         * Get or set the maximum canvas width (Safari shadow-canvas aware).
+         * @param value The maximum width value.
+         * @returns The current maximum width or this.
+         */
         max_width(value) {
             if (this._e === undefined) {
                 return super.max_width(value);
@@ -161,6 +194,12 @@ let CanvasElement = (() => {
         }
         // ---------------------------------------------------------
         // Utility functions.
+        /**
+         * Get a rendering context for the canvas.
+         * In Safari, forwards to the shadow canvas element.
+         * @param args Arguments forwarded to `HTMLCanvasElement.getContext`.
+         * @returns The rendering context.
+         */
         getContext(...args) {
             if (Utils.is_safari) {
                 return this._e.getContext(...args);
@@ -168,6 +207,14 @@ let CanvasElement = (() => {
             // @ts-ignore
             return super.getContext(...args);
         }
+        /**
+         * Draw a smoothed path through the given points on the provided context.
+         * Uses a Catmull–Rom style bezier approximation controlled by `tension`.
+         * @param ctx Canvas 2D context.
+         * @param points Ordered list of points to draw through.
+         * @param tension Optional smoothing factor; 0 for straight segments.
+         * @returns this
+         */
         // Draw lines.
         draw_lines(ctx, points = [], tension) {
             ctx.beginPath();
@@ -192,6 +239,17 @@ let CanvasElement = (() => {
             }
             return this;
         }
+        /**
+         * Create a canvas gradient from a `GradientType` definition.
+         * Supports linear and (placeholder) radial gradients.
+         * @param ctx Canvas 2D context.
+         * @param gradient The gradient definition (`GradientType`).
+         * @param start_x Start x coordinate.
+         * @param start_y Start y coordinate.
+         * @param end_x End x coordinate.
+         * @param end_y End y coordinate.
+         * @returns The created gradient or null when invalid.
+         */
         // Create gradient.
         create_gradient(ctx, gradient, start_x, start_y, end_x, end_y) {
             if (!(gradient instanceof GradientType)) {
@@ -227,38 +285,19 @@ let CanvasElement = (() => {
         // ---------------------------------------------------------
         // Functions.
         // Create a line.
-        /*	@docs:
-         *	@title: Line.
-         *	@description:
-         *		Create a line, optionally curved and with custom styling.
-         *	@return:
-         *		Returns the `Canvas` object.
-         *	@parameter:
-         *		@name: points
-         *		@description: The line points, an array with objects with `x` and `y` values.
-         *	@parameter:
-         *		@name: tension
-         *		@description: The smoothness of the line, use `null` or `0` for a straight line and {0.0, 2.0} for a smooth line.
-         *	@parameter:
-         *		@name: color
-         *		@description: The line color.
-         *	@parameter:
-         *		@name: fill
-         *		@description: The fill color, supports a `GradientType` class. leave `null` to ignore.
-         *	@parameter:
-         *		@name: scale
-         *		@type: boolean
-         *		@description: When enabled all x and y coordinates are treated as a 0.0 till 1.0 scale in relation to the canvas' width and height.
-         *	@parameter:
-         *		@name: dots
-         *		@type: object
-         *		@description:
-         *			Place dots at each coordinate, leave `null` to ignore.
-         *			Fields:
-         *			```{
-         *				width: 0.01, // Dot width in pixels when `scale` is `false`, and dot width in percentage `{0.0,1.0}` when `scale` is `true`.
-         *				color: "black", // Fill color.
-         *			}```
+        /**
+         * Create a line, optionally curved and with custom styling.
+         * @returns Returns the `Canvas` object.
+         * @param points The line points, an array with objects with `x` and `y` values.
+         * @param tension The smoothness of the line, use `null` or `0` for a straight line and {0.0, 2.0} for a smooth line.
+         * @param color The line color.
+         * @param width The line width in pixels.
+         * @param fill The fill color, supports a `GradientType` class. leave `null` to ignore.
+         * @param scale When enabled all x and y coordinates are treated as a 0.0 till 1.0 scale in relation to the canvas' width and height.
+         * @param dots Place dots at each coordinate, leave `null` to ignore.
+         * @param dots.width Dot width in pixels when `scale` is `false`, and dot width in percentage `{0.0,1.0}` when `scale` is `true`.
+         * @param dots.color Fill color.
+         * @docs
          */
         lines({ points, tension, color = "black", width, fill, scale = false, dots, }) {
             // Create context.
@@ -283,7 +322,7 @@ let CanvasElement = (() => {
             // ctx.beginPath();
             // ctx.moveTo(points[0].x, points[0].y);
             // for (let i = 1; i < points.length; i++) {
-            // 	ctx.lineTo(points[i].x, points[i].y);
+            //  ctx.lineTo(points[i].x, points[i].y);
             // }
             // Stroke style.
             if (width != null) {
@@ -359,6 +398,10 @@ let CanvasElement = (() => {
             return this;
         }
         // Remove all contexts.
+        /**
+         * Clear the entire canvas.
+         * @returns this
+         */
         // @ts-ignore
         clear() {
             this.ctx_2d.clearRect(0, 0, this.width, this.height);
@@ -399,13 +442,3 @@ export { CanvasElement };
 ;
 export const Canvas = Elements.wrapper(CanvasElement);
 export const NullCanvas = Elements.create_null(CanvasElement);
-// function Canvas(...args) {
-// 	if (Utils.is_safari) {
-// 		const e = document.createElement(CanvasElement.element_tag, {is: "v-" + CanvasElement.name.toLowerCase()})
-// 		console.log("E", e);
-// 		e._init(...args);
-// 		return e;
-// 	} else {
-// 		return new CanvasElement(...args);
-// 	}
-// }

package/frontend/dist/frontend/src/ui/checkbox.d.ts

@@ -0,0 +1,74 @@
+/**
+ * @author Daan van den Bergh
+ * @copyright © 2022 - 2025 Daan van den Bergh. All rights reserved
+ */
+import { VElementBaseSignature, ValueOrThis } from "../elements/module.js";
+import { VStackElement, HStackElement } from "./stack.js";
+import { TextElement } from "./text.js";
+interface CircleExtension {
+    enabled: boolean;
+    toggle(): this;
+    value(to?: boolean): this;
+    inner: VStackElement;
+}
+declare const CheckBoxElement_base: VElementBaseSignature;
+export declare class CheckBoxElement extends CheckBoxElement_base {
+    /** Has error state. */
+    has_error: boolean;
+    _border_color: string;
+    _inner_bg: string;
+    _inner_bg_focused: string;
+    _focus_color: string;
+    _error_color: string;
+    _required: boolean;
+    _circle: VStackElement & CircleExtension;
+    text: TextElement;
+    container: HStackElement;
+    error_text: TextElement;
+    constructor(text_or_obj?: string | {
+        text: string;
+        required: boolean;
+        id?: string;
+    });
+    border_color(): string;
+    border_color(val: string): this;
+    inner_bg(): string;
+    inner_bg(val: string): this;
+    inner_bg_focused(): string;
+    inner_bg_focused(val: string): this;
+    styles(): Record<string, string>;
+    styles(style_dict: Record<string, any>): this;
+    set_default(): this;
+    toggle(): this;
+    value(): boolean;
+    value(to: boolean): this;
+    required(): boolean;
+    required(to: boolean): this;
+    focus_color(): string;
+    focus_color(val: string): this;
+    /** Set the missing color. */
+    error_color(): string;
+    error_color(val: string): this;
+    /**
+     * Set the error state and message.
+     * Providing a truthy value will enable the error state and return the current instance for chaining.
+     * Providing a falsy value will disable the error state and return the current instance for chaining.
+     * Providing no value will return the current error message or `undefined` when no error is set.
+     */
+    error<V extends undefined | false | string = undefined>(err?: V): ValueOrThis<V, string | undefined, this>;
+    /** Remove the error state and mark as valid. */
+    valid(): this;
+    submit(): boolean;
+}
+export declare const CheckBox: <Extensions extends object = {}>(text_or_obj?: string | {
+    text: string;
+    required: boolean;
+    id?: string;
+} | undefined) => CheckBoxElement & Extensions;
+export declare const NullCheckBox: <Extensions extends object = {}>() => CheckBoxElement & Extensions;
+declare module './any_element.d.ts' {
+    interface AnyElementMap {
+        CheckBoxElement: CheckBoxElement;
+    }
+}
+export {};