diff --git a/src/components/ArrayInput/index.ts b/src/components/ArrayInput/index.ts index 009652bd..a42031d4 100644 --- a/src/components/ArrayInput/index.ts +++ b/src/components/ArrayInput/index.ts @@ -117,6 +117,11 @@ class ArrayInput extends Element implements IFocusable, IBindable { protected _renderChanges: boolean; + /** + * Creates a new ArrayInput. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { const container = new Container({ dom: args.dom, diff --git a/src/components/BooleanInput/index.ts b/src/components/BooleanInput/index.ts index 5071fb4e..2220281d 100644 --- a/src/components/BooleanInput/index.ts +++ b/src/components/BooleanInput/index.ts @@ -27,6 +27,11 @@ class BooleanInput extends Element implements IBindable, IFocusable { protected _renderChanges: boolean; + /** + * Creates a new BooleanInput. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { super({ tabIndex: 0, ...args }); diff --git a/src/components/Button/index.ts b/src/components/Button/index.ts index d946dbed..197e2835 100644 --- a/src/components/Button/index.ts +++ b/src/components/Button/index.ts @@ -38,6 +38,11 @@ class Button extends Element { protected _size: string | null; + /** + * Creates a new Button. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { super({ dom: 'button', ...args }); diff --git a/src/components/Canvas/index.ts b/src/components/Canvas/index.ts index 6fd793fc..5446114a 100644 --- a/src/components/Canvas/index.ts +++ b/src/components/Canvas/index.ts @@ -23,6 +23,11 @@ class Canvas extends Element { protected _ratio = 1; + /** + * Creates a new Canvas. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { super({ dom: 'canvas', ...args }); diff --git a/src/components/Code/index.ts b/src/components/Code/index.ts index 199711d7..4f8d7090 100644 --- a/src/components/Code/index.ts +++ b/src/components/Code/index.ts @@ -23,6 +23,11 @@ class Code extends Container { protected _text: string; + /** + * Creates a new Code. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { super(args); diff --git a/src/components/ColorPicker/index.ts b/src/components/ColorPicker/index.ts index 5afd4fbf..5709ed53 100644 --- a/src/components/ColorPicker/index.ts +++ b/src/components/ColorPicker/index.ts @@ -91,6 +91,11 @@ class ColorPicker extends Element implements IBindable { protected _renderChanges: boolean; + /** + * Creates a new ColorPicker. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { super(args); diff --git a/src/components/Container/index.ts b/src/components/Container/index.ts index e77c65c6..07c03b43 100644 --- a/src/components/Container/index.ts +++ b/src/components/Container/index.ts @@ -138,6 +138,11 @@ class Container extends Element { protected _resizable: string; + /** + * Creates a new Container. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { super(args); diff --git a/src/components/Divider/index.ts b/src/components/Divider/index.ts index a6f50e65..b030137a 100644 --- a/src/components/Divider/index.ts +++ b/src/components/Divider/index.ts @@ -6,6 +6,11 @@ const CLASS_ROOT = 'pcui-divider'; * Represents a vertical division between two elements. */ class Divider extends Element { + /** + * Creates a new Divider. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { super(args); diff --git a/src/components/Element/index.ts b/src/components/Element/index.ts index 90658273..d590bebc 100644 --- a/src/components/Element/index.ts +++ b/src/components/Element/index.ts @@ -406,6 +406,11 @@ class Element extends Events { protected _onClickEvt: () => void; + /** + * Creates a new Element. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { super(); diff --git a/src/components/GridView/index.ts b/src/components/GridView/index.ts index 6de26e94..4c1a8e13 100644 --- a/src/components/GridView/index.ts +++ b/src/components/GridView/index.ts @@ -50,6 +50,11 @@ class GridView extends Container { protected _selected: GridViewItem[] = []; + /** + * Creates a new GridView. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { super(args); diff --git a/src/components/GridViewItem/index.ts b/src/components/GridViewItem/index.ts index 30f36893..9d8cff0b 100644 --- a/src/components/GridViewItem/index.ts +++ b/src/components/GridViewItem/index.ts @@ -51,6 +51,11 @@ class GridViewItem extends Container implements IFocusable { protected _allowSelect: boolean; + /** + * Creates a new GridViewItem. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { super({ tabIndex: 0, ...args }); diff --git a/src/components/InfoBox/index.ts b/src/components/InfoBox/index.ts index fccdc9a4..cedc7688 100644 --- a/src/components/InfoBox/index.ts +++ b/src/components/InfoBox/index.ts @@ -47,6 +47,11 @@ class InfoBox extends Container { protected _text: string; + /** + * Creates a new InfoBox. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { super(args); diff --git a/src/components/Label/index.ts b/src/components/Label/index.ts index 486f577d..403217a8 100644 --- a/src/components/Label/index.ts +++ b/src/components/Label/index.ts @@ -45,6 +45,11 @@ class Label extends Element implements IPlaceholder, IBindable { protected _renderChanges: boolean; + /** + * Creates a new Label. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { super({ dom: 'span', ...args }); diff --git a/src/components/LabelGroup/index.ts b/src/components/LabelGroup/index.ts index b82ba89e..2cf87f48 100644 --- a/src/components/LabelGroup/index.ts +++ b/src/components/LabelGroup/index.ts @@ -35,6 +35,11 @@ class LabelGroup extends Container { protected _field: Element; + /** + * Creates a new LabelGroup. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { super(args); diff --git a/src/components/Menu/index.ts b/src/components/Menu/index.ts index 4e88af8c..c3672ca5 100644 --- a/src/components/Menu/index.ts +++ b/src/components/Menu/index.ts @@ -32,6 +32,11 @@ export interface MenuArgs extends ContainerArgs { class Menu extends Container implements IFocusable { protected _containerMenuItems: Container; + /** + * Creates a new Menu. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { super({ tabIndex: 1, ...args }); diff --git a/src/components/MenuItem/index.ts b/src/components/MenuItem/index.ts index 7cacfb6a..2a707781 100644 --- a/src/components/MenuItem/index.ts +++ b/src/components/MenuItem/index.ts @@ -73,6 +73,11 @@ class MenuItem extends Container implements IBindable { protected _renderChanges: boolean; + /** + * Creates a new MenuItem. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { super(args); diff --git a/src/components/NumericInput/index.ts b/src/components/NumericInput/index.ts index 49b1b91a..1a56a181 100644 --- a/src/components/NumericInput/index.ts +++ b/src/components/NumericInput/index.ts @@ -73,6 +73,11 @@ class NumericInput extends InputElement { protected _sliderUsed = false; + /** + * Creates a new NumericInput. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { const textInputArgs = { ...args }; // delete value because we want to set it after the other arguments diff --git a/src/components/Overlay/index.ts b/src/components/Overlay/index.ts index c8d227ca..f158c84e 100644 --- a/src/components/Overlay/index.ts +++ b/src/components/Overlay/index.ts @@ -27,6 +27,11 @@ export interface OverlayArgs extends ElementArgs { class Overlay extends Container { protected _domClickableOverlay: HTMLDivElement; + /** + * Creates a new Overlay. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { super(args); diff --git a/src/components/Progress/index.ts b/src/components/Progress/index.ts index 16327bd0..36c76207 100644 --- a/src/components/Progress/index.ts +++ b/src/components/Progress/index.ts @@ -24,6 +24,11 @@ class Progress extends Container { protected _value: number; + /** + * Creates a new Progress. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { super(args); this.class.add(CLASS_ROOT); diff --git a/src/components/RadioButton/index.ts b/src/components/RadioButton/index.ts index 336ea295..a7f7839f 100644 --- a/src/components/RadioButton/index.ts +++ b/src/components/RadioButton/index.ts @@ -17,6 +17,11 @@ class RadioButton extends Element implements IBindable, IFocusable { protected _renderChanges: boolean; + /** + * Creates a new RadioButton. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { super({ tabIndex: 0, ...args }); diff --git a/src/components/SelectInput/index.ts b/src/components/SelectInput/index.ts index 535ae2f1..82df3c15 100644 --- a/src/components/SelectInput/index.ts +++ b/src/components/SelectInput/index.ts @@ -166,6 +166,11 @@ class SelectInput extends Element implements IBindable, IFocusable { protected _prefix = ''; + /** + * Creates a new SelectInput. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { // main container const container = new Container({ diff --git a/src/components/Spinner/index.ts b/src/components/Spinner/index.ts index 5e939b64..6dfd1877 100644 --- a/src/components/Spinner/index.ts +++ b/src/components/Spinner/index.ts @@ -34,7 +34,7 @@ class Spinner extends Element { static TYPE_SMALL_THICK = 'small-thick'; /** - * Sets the pixel size of the spinner + * Creates a new Spinner. * * @param args - The arguments. */ diff --git a/src/components/TextAreaInput/index.ts b/src/components/TextAreaInput/index.ts index 901d430c..0b5f6863 100644 --- a/src/components/TextAreaInput/index.ts +++ b/src/components/TextAreaInput/index.ts @@ -23,6 +23,11 @@ export interface TextAreaInputArgs extends TextInputArgs { * The TextAreaInput wraps a textarea element. It has the same interface as {@link TextInput}. */ class TextAreaInput extends TextInput { + /** + * Creates a new TextAreaInput. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { args = Object.assign({ input: document.createElement('textarea') diff --git a/src/components/TextInput/index.ts b/src/components/TextInput/index.ts index f0e79e2a..6cbbaa08 100644 --- a/src/components/TextInput/index.ts +++ b/src/components/TextInput/index.ts @@ -22,6 +22,11 @@ export interface TextInputArgs extends InputElementArgs, IBindableArgs, IPlaceho class TextInput extends InputElement { protected _onValidate: (value: string) => boolean; + /** + * Creates a new TextInput. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { super(args); diff --git a/src/components/VectorInput/index.ts b/src/components/VectorInput/index.ts index 5d478d15..10cf40b4 100644 --- a/src/components/VectorInput/index.ts +++ b/src/components/VectorInput/index.ts @@ -45,6 +45,11 @@ class VectorInput extends Element implements IBindable, IFocusable, IPlaceholder protected _bindAllInputs = false; + /** + * Creates a new VectorInput. + * + * @param args - The arguments. + */ constructor(args: Readonly = {}) { const elementArgs = { ...args }; // set binding after inputs have been created