From e0dca4bcc9d070277d0ea5d602d85c5c37ba8555 Mon Sep 17 00:00:00 2001 From: Dmytro Soldatov Date: Sun, 5 Nov 2023 03:02:18 +0200 Subject: [PATCH] update docs --- src/DoubleSlider.ts | 14 ++++++++++++++ src/FancyButton.ts | 14 ++++++++++++++ src/Input.ts | 14 ++++++++++++++ src/ProgressBar.ts | 14 ++++++++++++++ src/Slider.ts | 14 ++++++++++++++ 5 files changed, 70 insertions(+) diff --git a/src/DoubleSlider.ts b/src/DoubleSlider.ts index dd019ad5..7d63bb62 100644 --- a/src/DoubleSlider.ts +++ b/src/DoubleSlider.ts @@ -264,6 +264,12 @@ export class DoubleSlider extends SliderBase } } + /** + * Sets width of a Sliders background and fill. + * If nineSlicePlane is set, then width will be set to nineSlicePlane. + * If nineSlicePlane is not set, then width will control components width as Container. + * @param value - Width value. + */ override set width(value: number) { super.width = value; @@ -272,11 +278,18 @@ export class DoubleSlider extends SliderBase this.updateSlider2(); } + /** Gets width of a Slider. */ override get width(): number { return super.width; } + /** + * Sets height of a Sliders background and fill. + * If nineSlicePlane is set, then height will be set to nineSlicePlane. + * If nineSlicePlane is not set, then height will control components height as Container. + * @param value - Height value. + */ override set height(value: number) { super.height = value; @@ -285,6 +298,7 @@ export class DoubleSlider extends SliderBase this.updateSlider2(); } + /** Gets height of a Slider. */ override get height(): number { return super.height; diff --git a/src/FancyButton.ts b/src/FancyButton.ts index 4c91d5e4..2ba80981 100644 --- a/src/FancyButton.ts +++ b/src/FancyButton.ts @@ -795,6 +795,12 @@ export class FancyButton extends ButtonContainer return this._textOffset; } + /** + * Sets width of a FancyButtons state views. + * If nineSlicePlane is set, then width will be set to nineSlicePlanes of a views. + * If nineSlicePlane is not set, then width will control components width as Container. + * @param value - Width value. + */ override set width(width: number) { if (this.options?.nineSlicePlane) @@ -826,11 +832,18 @@ export class FancyButton extends ButtonContainer } } + /** Gets width of a FancyButton. */ override get width(): number { return super.width; } + /** + * Sets height of a FancyButtons state views. + * If nineSlicePlane is set, then height will be set to nineSlicePlanes of a views. + * If nineSlicePlane is not set, then height will control components height as Container. + * @param value - Height value. + */ override set height(height: number) { if (this.options?.nineSlicePlane) @@ -862,6 +875,7 @@ export class FancyButton extends ButtonContainer } } + /** Gets height of a FancyButton. */ override get height(): number { return super.height; diff --git a/src/Input.ts b/src/Input.ts index a201591d..c09383fe 100644 --- a/src/Input.ts +++ b/src/Input.ts @@ -522,6 +522,12 @@ export class Input extends Container super.destroy(options); } + /** + * Sets width of a Input. + * If nineSlicePlane is set, then width will be set to nineSlicePlane. + * If nineSlicePlane is not set, then width will control components width as Container. + * @param value - Width value. + */ override set width(width: number) { if (this.options?.nineSlicePlane) @@ -545,11 +551,18 @@ export class Input extends Container } } + /** Gets width of Input. */ override get width(): number { return super.width; } + /** + * Sets height of a Input. + * If nineSlicePlane is set, then height will be set to nineSlicePlane. + * If nineSlicePlane is not set, then height will control components height as Container. + * @param value - Height value. + */ override set height(height: number) { if (this.options?.nineSlicePlane) @@ -573,6 +586,7 @@ export class Input extends Container } } + /** Gets height of Input. */ override get height(): number { return super.height; diff --git a/src/ProgressBar.ts b/src/ProgressBar.ts index 4383c2be..90cbae5e 100644 --- a/src/ProgressBar.ts +++ b/src/ProgressBar.ts @@ -229,6 +229,12 @@ export class ProgressBar extends Container return this._progress; } + /** + * Sets width of a ProgressBars background and fill. + * If nineSlicePlane is set, then width will be set to nineSlicePlane. + * If nineSlicePlane is not set, then width will control components width as Container. + * @param value - Width value. + */ override set width(width: number) { if (this.options?.nineSlicePlane) @@ -255,11 +261,18 @@ export class ProgressBar extends Container } } + /** Gets width of a ProgressBar. */ override get width(): number { return super.width; } + /** + * Sets height of a ProgressBars background and fill. + * If nineSlicePlane is set, then height will be set to nineSlicePlane. + * If nineSlicePlane is not set, then height will control components height as Container. + * @param value - Height value. + */ override set height(height: number) { if (this.options?.nineSlicePlane) @@ -286,6 +299,7 @@ export class ProgressBar extends Container } } + /** Gets height of a ProgressBar. */ override get height(): number { return super.height; diff --git a/src/Slider.ts b/src/Slider.ts index 3d6428b5..0326a6a2 100644 --- a/src/Slider.ts +++ b/src/Slider.ts @@ -115,6 +115,12 @@ export class Slider extends SliderBase } } + /** + * Sets width of a Sliders background and fill. + * If nineSlicePlane is set, then width will be set to nineSlicePlane. + * If nineSlicePlane is not set, then width will control components width as Container. + * @param value - Width value. + */ override set width(value: number) { super.width = value; @@ -122,11 +128,18 @@ export class Slider extends SliderBase this.updateSlider(); } + /** Gets width of a Slider. */ override get width(): number { return super.width; } + /** + * Sets height of a Sliders background and fill. + * If nineSlicePlane is set, then height will be set to nineSlicePlane. + * If nineSlicePlane is not set, then height will control components height as Container. + * @param value - Height value. + */ override set height(value: number) { super.height = value; @@ -134,6 +147,7 @@ export class Slider extends SliderBase this.updateSlider(); } + /** Gets height of a Slider. */ override get height(): number { return super.height;