@ui5/webcomponents 1.21.2 → 1.22.0-rc.1

package/dist/TimePickerClock.d.ts

@@ -54,10 +54,7 @@ type TimePickerClockSelectedItem = TimePickerClockItem & TimePickerClockSelectio
  * <code>import "@ui5/webcomponents/dist/TimePickerClock.js";</code>
  *
  * @constructor
- * @author SAP SE
- * @alias sap.ui.webc.main.TimePickerClock
- * @extends sap.ui.webc.base.UI5Element
- * @tagname ui5-time-picker-clock
+ * @extends UI5Element
  * @since 1.15.0
  * @private
  */
@@ -65,59 +62,45 @@ declare class TimePickerClock extends UI5Element {
     /**
      * Determines whether the component is displayed as disabled.
      *
-     * @name sap.ui.webc.main.TimePickerClock.prototype.disabled
-     * @type {boolean}
-     * @defaultvalue false
+     * @default false
      */
     disabled: boolean;
     /**
      * Determines whether the component is active (visible).
      *
-     * @name sap.ui.webc.main.TimePickerClock.prototype.active
-     * @type {boolean}
-     * @defaultvalue false
+     * @default false
      */
     active: boolean;
     /**
      * Minimum item value for the outer circle of the clock.
      *
-     * @name sap.ui.webc.main.TimePickerClock.prototype.itemMin
-     * @type {integer}
-     * @defaultvalue -1
+     * @default -1
      */
     itemMin: number;
     /**
      * Maximum item value for the outer circle of the clock.
      *
-     * @name sap.ui.webc.main.TimePickerClock.prototype.itemMax
-     * @type {integer}
-     * @defaultvalue -1
+     * @default -1
      */
     itemMax: number;
     /**
      * If set to <code>true</code>, an inner circle is displayed.
      * The first item value of the inner circle will be itemMax + 1
      *
-     * @name sap.ui.webc.main.TimePickerClock.prototype.showInnerCircle
-     * @type {boolean}
-     * @defaultvalue false
+     * @default false
      */
     showInnerCircle: boolean;
     /**
      * Label of the clock dial - for example, 'Hours', 'Minutes', or 'Seconds'.
      *
-     * @name sap.ui.webc.main.TimePickerClock.prototype.label
-     * @type {string}
-     * @defaultvalue undefined
+     * @default undefined
      */
     label?: string;
     /**
      * If set to <code>true</code>, a surrounding circle with markers (dots) will be hidden.
      * (for example, on the 'Minutes' clock-dial, markers represent minutes).
      *
-     * @name sap.ui.webc.main.TimePickerClock.prototype.hideFractions
-     * @type {boolean}
-     * @defaultvalue false
+     * @default false
      */
     hideFractions: boolean;
     /**
@@ -125,25 +108,19 @@ declare class TimePickerClock extends UI5Element {
      * the last item from outer circle will be replaced; if there is an inner circle too, the last
      * item of inner circle will be replaced. Usually, the last item '24' is replaced with '0'.
      *
-     * @name sap.ui.webc.main.TimePickerClock.prototype.lastItemReplacement
-     * @type {integer}
-     * @defaultvalue -1
+     * @default -1
      */
     lastItemReplacement: number;
     /**
      * Prepend with zero flag. If <code>true</code>, values less than 10 will be prepend with 0.
      *
-     * @name sap.ui.webc.main.TimePickerClock.prototype.prependZero
-     * @type {boolean}
-     * @defaultvalue false
+     * @default false
      */
     prependZero: boolean;
     /**
      * The currently selected value of the clock.
      *
-     * @name sap.ui.webc.main.TimePickerClock.prototype.selectedValue
-     * @type {integer}
-     * @defaultvalue -1
+     * @default -1
      */
     selectedValue: number;
     /**
@@ -152,9 +129,7 @@ declare class TimePickerClock extends UI5Element {
      * The default display step is 5 which means minutes and seconds are displayed as "0", "5", "10", etc.
      * For hours the display step must be set to 1.
      *
-     * @name sap.ui.webc.main.TimePickerClock.prototype.displayStep
-     * @type {integer}
-     * @defaultvalue 5
+     * @default 5
      */
     displayStep: number;
     /**
@@ -163,76 +138,61 @@ declare class TimePickerClock extends UI5Element {
      * - if the clock displays hours - 1 unit = 1 hour
      * - if the clock displays minutes/seconds - 1 unit = 1 minute/second
      *
-     * @name sap.ui.webc.main.TimePickerClock.prototype.valueStep
-     * @type {integer}
-     * @defaultvalue 1
+     * @default 1
      */
     valueStep: number;
     /**
      * Defines the currently available Time Picker Clock items depending on Clock setup.
-     *
-     * @type {Array}
      */
     _items: Array<TimePickerClockItem>;
     /**
      * Defines the currently selected Time Picker Clock item.
-     *
-     * @type {TimePickerClockSelectedItem}
      */
     _selectedItem: TimePickerClockSelectedItem;
     /**
      * Keeps variables used in interaction calculations.
-     *
-     * @type {TimePickerClockDimensions}
      */
     _dimensionParameters: TimePickerClockDimensions;
     /**
      * Mousedown or Touchstart event flag.
      *
-     * @type {boolean}
-     * @defaultvalue false
+     * @default false
      */
     _mouseOrTouchDown: boolean;
     /**
      * Cancel Mouseout flag.
      *
-     * @type {boolean}
-     * @defaultvalue false
+     * @default false
      */
     _cancelTouchOut: boolean;
     /**
      * Calculated selected value of the clock during interactions.
      *
-     * @type {integer}
-     * @defaultvalue -1
+     * @default -1
      */
     _selectedValue: number;
     /**
      * Selected value of the clock during interactions.
      *
-     * @type {integer}
-     * @defaultvalue -1
+     * @default -1
      */
     _movSelectedValue: number;
     /**
      * Hovered value of the clock during interactions.
      *
-     * @type {integer}
-     * @defaultvalue -1
+     * @default -1
      */
     _hoveredValue: number;
     /**
      * Previously hovered value of the clock during interactions.
      *
-     * @type {integer}
-     * @defaultvalue -1
+     * @default -1
      */
     _prevHoveredValue: number;
     /**
      * Animation in progress flag.
      *
-     * @type {boolean}
-     * @defaultvalue false
+     * @default false
      */
     _animationInProgress: boolean;
     _fnOnMouseOutUp: () => void;
@@ -244,14 +204,14 @@ declare class TimePickerClock extends UI5Element {
     /**
      * Returns the real value of the passed clock item, if the replacement must be done, returns the replaced value.
      *
-     * @param {number} value The value of the clock item
-     * @returns {number} The real/replaced value
+     * @param value The value of the clock item
+     * @returns The real/replaced value
      */
     _fixReplacementValue(value: number): number;
     /**
      * Updates internal selected value object constructed for rendering purposes.
      *
-     * @param {number} value currently selected value.
+     * @param value currently selected value.
      */
     _updateSelectedValueObject(value: number): void;
     /**
@@ -261,101 +221,101 @@ declare class TimePickerClock extends UI5Element {
     /**
      * Returns the DOM Reference of the clock cover element
      *
-     * @returns {HTMLElement} the DOM Reference
+     * @returns the DOM Reference
      */
     _getClockCoverContainerDomRef(): Element | null | undefined;
     /**
      * Returns the real max value of clock items, taking in count if there is inner circle or not.
      *
-     * @returns {number} max value
+     * @returns max value
      */
     _getMaxValue(): number;
     /**
      * Calculates the outer height of a HTML element.
      *
-     * @param {HTMLElement} element The element which outer height to be calculated
-     * @returns {number} Outer height of the passed HTML element
+     * @param element The element which outer height to be calculated
+     * @returns Outer height of the passed HTML element
      */
     _outerHeight(element: HTMLElement): number;
     /**
      * Returns the Id of the DOM element of the clock item that display specific value.
      *
-     * @param {number} value The value of the clock item
-     * @returns {string} Id of the clock item element
+     * @param value The value of the clock item
+     * @returns Id of the clock item element
      */
     _hoveredId(value: number): string;
     /**
      * Returns provided value as string. Padding with additional zero is applied if necessary.
      *
-     * @param {number} value The value that should be returned as string
-     * @returns {string} The value as string
+     * @param value The value that should be returned as string
+     * @returns The value as string
      */
     _getStringValue(value: number): string;
     /**
      * Calculates dimension variables necessary for determining of item selection.
      *
-     * @returns {TimePickerClockDimensions} Dimensions object
+     * @returns Dimensions object
      */
-    _calculateDimensions(): void;
+    _calculateDimensions(): TimePickerClockDimensions | undefined;
     /**
      * Calculates selected and hovered values based on click/touch position.
      *
-     * @param {number} x X position of click/touch returned by the event
-     * @param {number} y Y position of click/touch returned by the event
+     * @param x X position of click/touch returned by the event
+     * @param y Y position of click/touch returned by the event
      */
     _calculatePosition(x: number, y: number): void;
     /**
      * Does the animation between the old and the new value of the clock. Can be skipped with setting the second parameter to true.
      *
-     * @param {number} newValue the new value that must be set
-     * @param {boolean} skipAnimation whether to skip the animation
+     * @param newValue the new value that must be set
+     * @param skipAnimation whether to skip the animation
      */
     _changeValueAnimation(newValue: number, skipAnimation?: boolean): void;
     /**
      * Does the animation step between old and new selected values.
      *
-     * @param {number} firstSelected first/current value to move from
-     * @param {number} lastSelected last value to move to
-     * @param {number} direction direction of the animation
-     * @param {number} maxValue max clock value
-     * @param {number} newValue new value
-     * @param {number} delay delay of the single step
+     * @param firstSelected first/current value to move from
+     * @param lastSelected last value to move to
+     * @param direction direction of the animation
+     * @param maxValue max clock value
+     * @param newValue new value
+     * @param delay delay of the single step
      */
     _selectNextNumber(firstSelected: number, lastSelected: number, direction: number, maxValue: number, newValue: number, delay: number): void;
     /**
      * Mousewheel handler. Increases/decreases value of the clock.
      *
-     * @param {boolean} increase whether to increase or decrease the value
+     * @param increase whether to increase or decrease the value
      */
     _modifyValue(increase: boolean): void;
     /**
      * Sets new selected value, fires change event and updates selected value object used for rendering purposes.
      *
-     * @param {number} value
+     * @param value
      */
     _setSelectedValue(value: number): void;
     /**
      * TouchStart/MouseDown event handler.
      *
-     * @param {event} evt Event object
+     * @param evt Event object
      */
     _onTouchStart(evt: Event): void;
     /**
      * TouchMove/MouseMove event handler.
      *
-     * @param {event} evt Event object
+     * @param evt Event object
      */
     _onTouchMove(evt: Event): void;
     /**
      * TouchEnd/MouseUp event handler.
      *
-     * @param {event} evt Event object
+     * @param evt Event object
      */
     _onTouchEnd(evt: Event): void;
     /**
      * Mouse Wheel event handler.
      *
-     * @param {WheelEvent} evt Event object
+     * @param evt Event object
      */
     _onMouseWheel(evt: WheelEvent): void;
     /**

package/dist/TimePickerClock.js

@@ -44,10 +44,7 @@ const CLOCK_MIDDOT_CLASS = "ui5-tp-clock-mid-dot";
  * <code>import "@ui5/webcomponents/dist/TimePickerClock.js";</code>
  *
  * @constructor
- * @author SAP SE
- * @alias sap.ui.webc.main.TimePickerClock
- * @extends sap.ui.webc.base.UI5Element
- * @tagname ui5-time-picker-clock
+ * @extends UI5Element
  * @since 1.15.0
  * @private
  */
@@ -81,8 +78,8 @@ let TimePickerClock = class TimePickerClock extends UI5Element {
     /**
      * Returns the real value of the passed clock item, if the replacement must be done, returns the replaced value.
      *
-     * @param {number} value The value of the clock item
-     * @returns {number} The real/replaced value
+     * @param value The value of the clock item
+     * @returns The real/replaced value
      */
     _fixReplacementValue(value) {
         let realValue = value;
@@ -98,7 +95,7 @@ let TimePickerClock = class TimePickerClock extends UI5Element {
     /**
      * Updates internal selected value object constructed for rendering purposes.
      *
-     * @param {number} value currently selected value.
+     * @param value currently selected value.
      */
     _updateSelectedValueObject(value) {
         if (value === -1) {
@@ -176,7 +173,7 @@ let TimePickerClock = class TimePickerClock extends UI5Element {
     /**
      * Returns the DOM Reference of the clock cover element
      *
-     * @returns {HTMLElement} the DOM Reference
+     * @returns the DOM Reference
      */
     _getClockCoverContainerDomRef() {
         const domRef = this.getDomRef();
@@ -185,7 +182,7 @@ let TimePickerClock = class TimePickerClock extends UI5Element {
     /**
      * Returns the real max value of clock items, taking in count if there is inner circle or not.
      *
-     * @returns {number} max value
+     * @returns max value
      */
     _getMaxValue() {
         return this.showInnerCircle ? this.itemMax * 2 : this.itemMax;
@@ -193,8 +190,8 @@ let TimePickerClock = class TimePickerClock extends UI5Element {
     /**
      * Calculates the outer height of a HTML element.
      *
-     * @param {HTMLElement} element The element which outer height to be calculated
-     * @returns {number} Outer height of the passed HTML element
+     * @param element The element which outer height to be calculated
+     * @returns Outer height of the passed HTML element
      */
     _outerHeight(element) {
         if (!element) {
@@ -206,8 +203,8 @@ let TimePickerClock = class TimePickerClock extends UI5Element {
     /**
      * Returns the Id of the DOM element of the clock item that display specific value.
      *
-     * @param {number} value The value of the clock item
-     * @returns {string} Id of the clock item element
+     * @param value The value of the clock item
+     * @returns Id of the clock item element
      */
     _hoveredId(value) {
         if (value === this._getMaxValue() && this.lastItemReplacement !== -1) {
@@ -219,8 +216,8 @@ let TimePickerClock = class TimePickerClock extends UI5Element {
     /**
      * Returns provided value as string. Padding with additional zero is applied if necessary.
      *
-     * @param {number} value The value that should be returned as string
-     * @returns {string} The value as string
+     * @param value The value that should be returned as string
+     * @returns The value as string
      */
     _getStringValue(value) {
         return this.prependZero ? value.toString().padStart(2, "0") : value.toString();
@@ -228,7 +225,7 @@ let TimePickerClock = class TimePickerClock extends UI5Element {
     /**
      * Calculates dimension variables necessary for determining of item selection.
      *
-     * @returns {TimePickerClockDimensions} Dimensions object
+     * @returns Dimensions object
      */
     _calculateDimensions() {
         const cover = this.getDomRef();
@@ -261,8 +258,8 @@ let TimePickerClock = class TimePickerClock extends UI5Element {
     /**
      * Calculates selected and hovered values based on click/touch position.
      *
-     * @param {number} x X position of click/touch returned by the event
-     * @param {number} y Y position of click/touch returned by the event
+     * @param x X position of click/touch returned by the event
+     * @param y Y position of click/touch returned by the event
      */
     _calculatePosition(x, y) {
         const dX = x - this._dimensionParameters.offsetX + 1 - this._dimensionParameters.radius;
@@ -298,8 +295,8 @@ let TimePickerClock = class TimePickerClock extends UI5Element {
     /**
      * Does the animation between the old and the new value of the clock. Can be skipped with setting the second parameter to true.
      *
-     * @param {number} newValue the new value that must be set
-     * @param {boolean} skipAnimation whether to skip the animation
+     * @param newValue the new value that must be set
+     * @param skipAnimation whether to skip the animation
      */
     _changeValueAnimation(newValue, skipAnimation = false) {
         const maxValue = this.itemMax * (this.showInnerCircle ? 2 : 1);
@@ -336,12 +333,12 @@ let TimePickerClock = class TimePickerClock extends UI5Element {
     /**
      * Does the animation step between old and new selected values.
      *
-     * @param {number} firstSelected first/current value to move from
-     * @param {number} lastSelected last value to move to
-     * @param {number} direction direction of the animation
-     * @param {number} maxValue max clock value
-     * @param {number} newValue new value
-     * @param {number} delay delay of the single step
+     * @param firstSelected first/current value to move from
+     * @param lastSelected last value to move to
+     * @param direction direction of the animation
+     * @param maxValue max clock value
+     * @param newValue new value
+     * @param delay delay of the single step
      */
     _selectNextNumber(firstSelected, lastSelected, direction, maxValue, newValue, delay) {
         const current = firstSelected > maxValue ? firstSelected - maxValue : firstSelected;
@@ -369,7 +366,7 @@ let TimePickerClock = class TimePickerClock extends UI5Element {
     /**
      * Mousewheel handler. Increases/decreases value of the clock.
      *
-     * @param {boolean} increase whether to increase or decrease the value
+     * @param increase whether to increase or decrease the value
      */
     _modifyValue(increase) {
         let selectedValue = this.selectedValue;
@@ -403,7 +400,7 @@ let TimePickerClock = class TimePickerClock extends UI5Element {
     /**
      * Sets new selected value, fires change event and updates selected value object used for rendering purposes.
      *
-     * @param {number} value
+     * @param value
      */
     _setSelectedValue(value) {
         const realValue = this._fixReplacementValue(value);
@@ -418,7 +415,7 @@ let TimePickerClock = class TimePickerClock extends UI5Element {
     /**
      * TouchStart/MouseDown event handler.
      *
-     * @param {event} evt Event object
+     * @param evt Event object
      */
     _onTouchStart(evt) {
         this._cancelTouchOut = false;
@@ -435,7 +432,7 @@ let TimePickerClock = class TimePickerClock extends UI5Element {
     /**
      * TouchMove/MouseMove event handler.
      *
-     * @param {event} evt Event object
+     * @param evt Event object
      */
     _onTouchMove(evt) {
         let hoveredNumber;
@@ -470,7 +467,7 @@ let TimePickerClock = class TimePickerClock extends UI5Element {
     /**
      * TouchEnd/MouseUp event handler.
      *
-     * @param {event} evt Event object
+     * @param evt Event object
      */
     _onTouchEnd(evt) {
         if (!this._mouseOrTouchDown) {
@@ -488,7 +485,7 @@ let TimePickerClock = class TimePickerClock extends UI5Element {
     /**
      * Mouse Wheel event handler.
      *
-     * @param {WheelEvent} evt Event object
+     * @param evt Event object
      */
     _onMouseWheel(evt) {
         const increase = evt.detail ? (evt.detail > 0) : (evt.deltaY > 0 || evt.deltaX > 0);
@@ -583,7 +580,6 @@ TimePickerClock = __decorate([
     /**
      * Fired when a value of clock is changed.
      *
-     * @event sap.ui.webc.main.TimePickerClock#change
      * @param { integer } value The new <code>value</code> of the clock.
      * @param { string } stringValue The new <code>value</code> of the clock, as string, zero-prepended when necessary.
      * @param { boolean } finalChange <code>true</code> when a value is selected and confirmed, <code>false</code> when a value is only selected but not confirmed.
@@ -591,8 +587,17 @@ TimePickerClock = __decorate([
     ,
     event("change", {
         detail: {
+            /**
+             * @public
+             */
             value: { type: Integer },
+            /**
+             * @public
+             */
             stringValue: { type: String },
+            /**
+             * @public
+             */
             finalChange: { type: Boolean },
         },
     })