@refinitiv-ui/elements 5.7.0 → 5.8.0

package/lib/overlay/custom-elements.json

@@ -31,23 +31,28 @@
         },
         {
           "name": "transition-style",
-          "description": "Set the transition style"
+          "description": "Set the transition style",
+          "type": "TransitionStyle|null|undefined"
         },
         {
           "name": "z-index",
-          "description": "Set a preferable z-index to override automatically calculated z-index"
+          "description": "Set a preferable z-index to override automatically calculated z-index",
+          "type": "number|null|undefined"
         },
         {
           "name": "x",
-          "description": "Set a specific x coordinate"
+          "description": "Set a specific x coordinate",
+          "type": "number|null|undefined"
         },
         {
           "name": "y",
-          "description": "Set a specific y coordinate"
+          "description": "Set a specific y coordinate",
+          "type": "number|null|undefined"
         },
         {
           "name": "position-target",
-          "description": "Set the position target as follows:\n- HTMLElement if overlay is position next to the HTML element\n- String containing `top`, `right`, `left`, `bottom`, `center` combinations to position against the screen.\nFor instance: `top left` - put the overlay at `top left` point of the screen; `bottom` - put overlay at `bottom center` point of the screen"
+          "description": "Set the position target as follows:\n- HTMLElement if overlay is position next to the HTML element\n- String containing `top`, `right`, `left`, `bottom`, `center` combinations to position against the screen.\nFor instance: `top left` - put the overlay at `top left` point of the screen; `bottom` - put overlay at `bottom center` point of the screen",
+          "type": "PositionTarget|null|undefined"
         },
         {
           "name": "horizontal-offset",
@@ -159,27 +164,32 @@
         {
           "name": "transitionStyle",
           "attribute": "transition-style",
-          "description": "Set the transition style"
+          "description": "Set the transition style",
+          "type": "TransitionStyle|null|undefined"
         },
         {
           "name": "zIndex",
           "attribute": "z-index",
-          "description": "Set a preferable z-index to override automatically calculated z-index"
+          "description": "Set a preferable z-index to override automatically calculated z-index",
+          "type": "number|null|undefined"
         },
         {
           "name": "x",
           "attribute": "x",
-          "description": "Set a specific x coordinate"
+          "description": "Set a specific x coordinate",
+          "type": "number|null|undefined"
         },
         {
           "name": "y",
           "attribute": "y",
-          "description": "Set a specific y coordinate"
+          "description": "Set a specific y coordinate",
+          "type": "number|null|undefined"
         },
         {
           "name": "positionTarget",
           "attribute": "position-target",
-          "description": "Set the position target as follows:\n- HTMLElement if overlay is position next to the HTML element\n- String containing `top`, `right`, `left`, `bottom`, `center` combinations to position against the screen.\nFor instance: `top left` - put the overlay at `top left` point of the screen; `bottom` - put overlay at `bottom center` point of the screen"
+          "description": "Set the position target as follows:\n- HTMLElement if overlay is position next to the HTML element\n- String containing `top`, `right`, `left`, `bottom`, `center` combinations to position against the screen.\nFor instance: `top left` - put the overlay at `top left` point of the screen; `bottom` - put overlay at `bottom center` point of the screen",
+          "type": "PositionTarget|null|undefined"
         },
         {
           "name": "horizontalOffset",
@@ -278,7 +288,7 @@
           "type": "{} | undefined"
         },
         {
-          "name": "positionTargetConfig",
+          "name": "positionTargetConfig (readonly)",
           "description": "Get position target configuration based on positionTarget and fullScreen properties\nUsed for caching and calculations"
         },
         {
@@ -287,12 +297,12 @@
           "default": "\"this\""
         },
         {
-          "name": "fullyOpened",
+          "name": "fullyOpened (readonly)",
           "description": "Returns true if the overlay is opened and animation is not running.\nReturns false if overlay is closed and animation is not running",
           "type": "boolean"
         },
         {
-          "name": "transitioning",
+          "name": "transitioning (readonly)",
           "description": "Returns true if overlay is doing opening or closing transition",
           "type": "boolean"
         }

package/lib/overlay/custom-elements.md

@@ -4,35 +4,35 @@ Element to help building modals, dialogs and other overlay content
 
 ## Properties
 
-| Property                 | Attribute                    | Modifiers | Type              | Default | Description                                      |
-|--------------------------|------------------------------|-----------|-------------------|---------|--------------------------------------------------|
-| `focusBoundary`          |                              |           |                   | "this"  | Set focus boundary to restrict tabbing. Default's overlay itself.<br />If external focus is required, set to null |
-| `fullScreen`             | `full-screen`                |           | `boolean`         | false   | Set to true to show overlay in full screen mode  |
-| `fullyOpened`            |                              | readonly  | `boolean`         |         | Returns true if the overlay is opened and animation is not running.<br />Returns false if overlay is closed and animation is not running |
-| `horizontalOffset`       | `horizontal-offset`          |           | `number`          | 0       | A pixel value that will be added to the position calculated on the horizontal axis.<br />The offset will be applied either to the `left` or `right` depending on the `positionTarget` |
-| `interactiveElements`    |                              |           | `object`          | []      | A list of elements, which are active when overlay is opened<br />Valid only if noInteractionLock is false (default) |
-| `lockPositionTarget`     | `lock-position-target`       |           | `boolean`         | false   | True to lock position target<br />Valid only if noInteractionLock is false (default) |
-| `noAutofocus`            | `no-autofocus`               |           | `boolean`         | false   | Set to true to disable autofocusing the overlay or open |
-| `noCancelOnEscKey`       | `no-cancel-on-esc-key`       |           | `boolean`         | false   | Set to true to disable canceling the overlay with the ESC key |
-| `noCancelOnOutsideClick` | `no-cancel-on-outside-click` |           | `boolean`         | false   | Set to true to disable canceling the overlay by clicking outside it |
-| `noFocusManagement`      | `no-focus-management`        |           | `boolean`         | false   | True to not apply focus management.<br />The overlay will not limit Tab behaviour or do auto-focusing |
-| `noInteractionLock`      | `no-interaction-lock`        |           | `boolean`         | false   | Stop preventing user interaction when overlay is visible |
-| `noOverlap`              | `no-overlap`                 |           | `boolean`         | false   | True to not overlap positionTarget               |
-| `offset`                 | `offset`                     |           | `number`          | 0       | A pixel value that will be added to the position calculated on the vertical or horizontal axis.<br />The offset is applied dynamically depending on the `positionTarget` |
-| `opened`                 | `opened`                     |           | `boolean`         | false   | True if the overlay is currently displayed       |
-| `position`               | `position`                   |           | `{} \| undefined` |         | Set position and align against the attach target.<br />Position may contain a single word or a comma separated list to set the priority.<br />Position is not applied if `attachTarget` is not HTML Element.<br />For instance: `[bottom-middle, top-middle]` - default position is bottom-middle, if cannot fit position top-middle;<br />or `[left, right]` - align is not set, set best position on the left or right<br /><br />Position can be: `top`, `right`, `bottom`, `left`, `center`<br />Align can be: `start`, `middle`, `end` |
-| `positionTarget`         | `position-target`            |           |                   |         | Set the position target as follows:<br />- HTMLElement if overlay is position next to the HTML element<br />- String containing `top`, `right`, `left`, `bottom`, `center` combinations to position against the screen.<br />For instance: `top left` - put the overlay at `top left` point of the screen; `bottom` - put overlay at `bottom center` point of the screen |
-| `positionTargetConfig`   |                              | readonly  |                   |         | Get position target configuration based on positionTarget and fullScreen properties<br />Used for caching and calculations |
-| `spacing`                | `spacing`                    |           | `boolean`         | false   | True to apply spacing for overlay content        |
-| `transitionStyle`        | `transition-style`           |           |                   |         | Set the transition style                         |
-| `transitioning`          |                              | readonly  | `boolean`         |         | Returns true if overlay is doing opening or closing transition |
-| `transparent`            | `transparent`                |           | `boolean`         | false   | True to make overlay background transparent      |
-| `verticalOffset`         | `vertical-offset`            |           | `number`          | 0       | A pixel value that will be added to the position calculated on the vertical axis.<br />The offset will be applied either to the `top` or `bottom` depending on the `positionTarget` |
-| `withBackdrop`           | `with-backdrop`              |           | `boolean`         | false   | True to show backdrop                            |
-| `withShadow`             | `with-shadow`                |           | `boolean`         | false   | True to add shadow                               |
-| `x`                      | `x`                          |           |                   |         | Set a specific x coordinate                      |
-| `y`                      | `y`                          |           |                   |         | Set a specific y coordinate                      |
-| `zIndex`                 | `z-index`                    |           |                   |         | Set a preferable z-index to override automatically calculated z-index |
+| Property                          | Attribute                    | Type                               | Default | Description                                      |
+|-----------------------------------|------------------------------|------------------------------------|---------|--------------------------------------------------|
+| `focusBoundary`                   |                              |                                    | "this"  | Set focus boundary to restrict tabbing. Default's overlay itself.<br />If external focus is required, set to null |
+| `fullScreen`                      | `full-screen`                | `boolean`                          | false   | Set to true to show overlay in full screen mode  |
+| `fullyOpened (readonly)`          |                              | `boolean`                          |         | Returns true if the overlay is opened and animation is not running.<br />Returns false if overlay is closed and animation is not running |
+| `horizontalOffset`                | `horizontal-offset`          | `number`                           | 0       | A pixel value that will be added to the position calculated on the horizontal axis.<br />The offset will be applied either to the `left` or `right` depending on the `positionTarget` |
+| `interactiveElements`             |                              | `object`                           | []      | A list of elements, which are active when overlay is opened<br />Valid only if noInteractionLock is false (default) |
+| `lockPositionTarget`              | `lock-position-target`       | `boolean`                          | false   | True to lock position target<br />Valid only if noInteractionLock is false (default) |
+| `noAutofocus`                     | `no-autofocus`               | `boolean`                          | false   | Set to true to disable autofocusing the overlay or open |
+| `noCancelOnEscKey`                | `no-cancel-on-esc-key`       | `boolean`                          | false   | Set to true to disable canceling the overlay with the ESC key |
+| `noCancelOnOutsideClick`          | `no-cancel-on-outside-click` | `boolean`                          | false   | Set to true to disable canceling the overlay by clicking outside it |
+| `noFocusManagement`               | `no-focus-management`        | `boolean`                          | false   | True to not apply focus management.<br />The overlay will not limit Tab behaviour or do auto-focusing |
+| `noInteractionLock`               | `no-interaction-lock`        | `boolean`                          | false   | Stop preventing user interaction when overlay is visible |
+| `noOverlap`                       | `no-overlap`                 | `boolean`                          | false   | True to not overlap positionTarget               |
+| `offset`                          | `offset`                     | `number`                           | 0       | A pixel value that will be added to the position calculated on the vertical or horizontal axis.<br />The offset is applied dynamically depending on the `positionTarget` |
+| `opened`                          | `opened`                     | `boolean`                          | false   | True if the overlay is currently displayed       |
+| `position`                        | `position`                   | `{} \| undefined`                  |         | Set position and align against the attach target.<br />Position may contain a single word or a comma separated list to set the priority.<br />Position is not applied if `attachTarget` is not HTML Element.<br />For instance: `[bottom-middle, top-middle]` - default position is bottom-middle, if cannot fit position top-middle;<br />or `[left, right]` - align is not set, set best position on the left or right<br /><br />Position can be: `top`, `right`, `bottom`, `left`, `center`<br />Align can be: `start`, `middle`, `end` |
+| `positionTarget`                  | `position-target`            | `PositionTarget\|null\|undefined`  |         | Set the position target as follows:<br />- HTMLElement if overlay is position next to the HTML element<br />- String containing `top`, `right`, `left`, `bottom`, `center` combinations to position against the screen.<br />For instance: `top left` - put the overlay at `top left` point of the screen; `bottom` - put overlay at `bottom center` point of the screen |
+| `positionTargetConfig (readonly)` |                              |                                    |         | Get position target configuration based on positionTarget and fullScreen properties<br />Used for caching and calculations |
+| `spacing`                         | `spacing`                    | `boolean`                          | false   | True to apply spacing for overlay content        |
+| `transitionStyle`                 | `transition-style`           | `TransitionStyle\|null\|undefined` |         | Set the transition style                         |
+| `transitioning (readonly)`        |                              | `boolean`                          |         | Returns true if overlay is doing opening or closing transition |
+| `transparent`                     | `transparent`                | `boolean`                          | false   | True to make overlay background transparent      |
+| `verticalOffset`                  | `vertical-offset`            | `number`                           | 0       | A pixel value that will be added to the position calculated on the vertical axis.<br />The offset will be applied either to the `top` or `bottom` depending on the `positionTarget` |
+| `withBackdrop`                    | `with-backdrop`              | `boolean`                          | false   | True to show backdrop                            |
+| `withShadow`                      | `with-shadow`                | `boolean`                          | false   | True to add shadow                               |
+| `x`                               | `x`                          | `number\|null\|undefined`          |         | Set a specific x coordinate                      |
+| `y`                               | `y`                          | `number\|null\|undefined`          |         | Set a specific y coordinate                      |
+| `zIndex`                          | `z-index`                    | `number\|null\|undefined`          |         | Set a preferable z-index to override automatically calculated z-index |
 
 ## Methods
 

package/lib/overlay/elements/overlay.d.ts

@@ -43,18 +43,22 @@ export declare class Overlay extends ResponsiveElement {
     spacing: boolean;
     /**
      * Set the transition style
+     * @type {TransitionStyle|null|undefined}
      */
     transitionStyle: TransitionStyle | NullOrUndefined;
     /**
      * Set a preferable z-index to override automatically calculated z-index
+     * @type {number|null|undefined}
      */
     zIndex: number | NullOrUndefined;
     /**
      * Set a specific x coordinate
+     * @type {number|null|undefined}
      */
     x: number | NullOrUndefined;
     /**
      * Set a specific y coordinate
+     * @type {number|null|undefined}
      */
     y: number | NullOrUndefined;
     /**
@@ -62,6 +66,7 @@ export declare class Overlay extends ResponsiveElement {
      * - HTMLElement if overlay is position next to the HTML element
      * - String containing `top`, `right`, `left`, `bottom`, `center` combinations to position against the screen.
      * For instance: `top left` - put the overlay at `top left` point of the screen; `bottom` - put overlay at `bottom center` point of the screen
+     * @type {PositionTarget|null|undefined}
      */
     positionTarget: HTMLElement | PositionTarget | NullOrUndefined;
     /**

package/lib/overlay-menu/custom-elements.json

@@ -17,21 +17,62 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "with-backdrop",
+          "description": "True to show backdrop",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "no-cancel-on-esc-key",
+          "description": "Set to true to disable canceling the overlay with the ESC key",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "no-cancel-on-outside-click",
+          "description": "Set to true to disable canceling the overlay by clicking outside it",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "lock-position-target",
+          "description": "Set to true to lock position target",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "transition-style",
+          "description": "Set the transition style",
+          "type": "string | null"
+        },
         {
           "name": "value",
           "description": "Returns the first selected item value.",
           "type": "string",
-          "default": "0"
+          "default": "\"\""
         },
         {
           "name": "x",
           "description": "Set a specific x coordinate",
-          "type": "number"
+          "type": "number | undefined"
         },
         {
           "name": "y",
           "description": "Set a specific y coordinate",
-          "type": "number"
+          "type": "number | undefined"
+        },
+        {
+          "name": "horizontal-offset",
+          "description": "A pixel value that will be added to the position calculated on the horizontal axis. The offset will be applied either to the `left` or `right` depending on the `positionTarget`",
+          "type": "number",
+          "default": "0"
+        },
+        {
+          "name": "vertical-offset",
+          "description": "A pixel value that will be added to the position calculated on the vertical axis. The offset will be applied either to the `top` or `bottom` depending on the `positionTarget`",
+          "type": "number",
+          "default": "0"
         },
         {
           "name": "offset",
@@ -41,7 +82,7 @@
         {
           "name": "position",
           "description": "Set position and align against the attach target.",
-          "type": "{} | undefined"
+          "type": "Position[] | undefined"
         },
         {
           "name": "with-backdrop",
@@ -90,11 +131,13 @@
         {
           "name": "values",
           "description": "Array of item's values",
-          "type": "string[]"
+          "type": "string[]",
+          "default": "[]"
         },
         {
           "name": "data",
-          "description": "Construct the menu from data object.\nCannot be used with internal content"
+          "description": "Construct the menu from data object.\nCannot be used with internal content",
+          "type": "OverlayMenuData|undefined"
         },
         {
           "name": "opened",
@@ -105,24 +148,28 @@
         },
         {
           "name": "withBackdrop",
+          "attribute": "with-backdrop",
           "description": "True to show backdrop",
           "type": "boolean",
           "default": "false"
         },
         {
           "name": "noCancelOnEscKey",
+          "attribute": "no-cancel-on-esc-key",
           "description": "Set to true to disable canceling the overlay with the ESC key",
           "type": "boolean",
           "default": "false"
         },
         {
           "name": "noCancelOnOutsideClick",
+          "attribute": "no-cancel-on-outside-click",
           "description": "Set to true to disable canceling the overlay by clicking outside it",
           "type": "boolean",
           "default": "false"
         },
         {
           "name": "lockPositionTarget",
+          "attribute": "lock-position-target",
           "description": "Set to true to lock position target",
           "type": "boolean",
           "default": "false"
@@ -130,41 +177,46 @@
         {
           "name": "positionTarget",
           "description": "Position next to the HTML element",
-          "type": "HTMLElement|null"
+          "type": "HTMLElement | null"
         },
         {
           "name": "transitionStyle",
+          "attribute": "transition-style",
           "description": "Set the transition style",
-          "type": "string|null"
+          "type": "string | null"
         },
         {
           "name": "value",
           "attribute": "value",
           "description": "Returns the first selected item value.",
           "type": "string",
-          "default": "0"
+          "default": "\"\""
         },
         {
           "name": "x",
           "attribute": "x",
           "description": "Set a specific x coordinate",
-          "type": "number"
+          "type": "number | undefined"
         },
         {
           "name": "y",
           "attribute": "y",
           "description": "Set a specific y coordinate",
-          "type": "number"
+          "type": "number | undefined"
         },
         {
           "name": "horizontalOffset",
+          "attribute": "horizontal-offset",
           "description": "A pixel value that will be added to the position calculated on the horizontal axis. The offset will be applied either to the `left` or `right` depending on the `positionTarget`",
-          "type": "number"
+          "type": "number",
+          "default": "0"
         },
         {
           "name": "verticalOffset",
+          "attribute": "vertical-offset",
           "description": "A pixel value that will be added to the position calculated on the vertical axis. The offset will be applied either to the `top` or `bottom` depending on the `positionTarget`",
-          "type": "number"
+          "type": "number",
+          "default": "0"
         },
         {
           "name": "offset",
@@ -176,7 +228,7 @@
           "name": "position",
           "attribute": "position",
           "description": "Set position and align against the attach target.",
-          "type": "{} | undefined"
+          "type": "Position[] | undefined"
         }
       ],
       "events": [

package/lib/overlay-menu/custom-elements.md

@@ -16,25 +16,25 @@ Overlay that supports single-level and multi-level menus
 
 ## Properties
 
-| Property                 | Attribute  | Type                | Default | Description                                      |
-|--------------------------|------------|---------------------|---------|--------------------------------------------------|
-| `compact`                | `compact`  | `boolean`           | false   | Switch to compact style menu                     |
-| `data`                   |            |                     |         | Construct the menu from data object.<br />Cannot be used with internal content |
-| `horizontalOffset`       |            | `number`            |         | A pixel value that will be added to the position calculated on the horizontal axis. The offset will be applied either to the `left` or `right` depending on the `positionTarget` |
-| `lockPositionTarget`     |            | `boolean`           | false   | Set to true to lock position target              |
-| `noCancelOnEscKey`       |            | `boolean`           | false   | Set to true to disable canceling the overlay with the ESC key |
-| `noCancelOnOutsideClick` |            | `boolean`           | false   | Set to true to disable canceling the overlay by clicking outside it |
-| `offset`                 | `offset`   | `number`            |         | A pixel value that will be added to the position calculated on the vertical or horizontal axis. The offset is applied dynamically depending on the `positionTarget` |
-| `opened`                 | `opened`   | `boolean`           | false   | True if the menu is currently displayed          |
-| `position`               | `position` | `{} \| undefined`   |         | Set position and align against the attach target. |
-| `positionTarget`         |            | `HTMLElement\|null` | null    | Position next to the HTML element                |
-| `transitionStyle`        |            | `string\|null`      | null    | Set the transition style                         |
-| `value`                  | `value`    | `string`            | 0       | Returns the first selected item value.           |
-| `values`                 |            | `string[]`          |         | Array of item's values                           |
-| `verticalOffset`         |            | `number`            |         | A pixel value that will be added to the position calculated on the vertical axis. The offset will be applied either to the `top` or `bottom` depending on the `positionTarget` |
-| `withBackdrop`           |            | `boolean`           | false   | True to show backdrop                            |
-| `x`                      | `x`        | `number`            |         | Set a specific x coordinate                      |
-| `y`                      | `y`        | `number`            |         | Set a specific y coordinate                      |
+| Property                 | Attribute                    | Type                         | Default | Description                                      |
+|--------------------------|------------------------------|------------------------------|---------|--------------------------------------------------|
+| `compact`                | `compact`                    | `boolean`                    | false   | Switch to compact style menu                     |
+| `data`                   |                              | `OverlayMenuData\|undefined` |         | Construct the menu from data object.<br />Cannot be used with internal content |
+| `horizontalOffset`       | `horizontal-offset`          | `number`                     | 0       | A pixel value that will be added to the position calculated on the horizontal axis. The offset will be applied either to the `left` or `right` depending on the `positionTarget` |
+| `lockPositionTarget`     | `lock-position-target`       | `boolean`                    | false   | Set to true to lock position target              |
+| `noCancelOnEscKey`       | `no-cancel-on-esc-key`       | `boolean`                    | false   | Set to true to disable canceling the overlay with the ESC key |
+| `noCancelOnOutsideClick` | `no-cancel-on-outside-click` | `boolean`                    | false   | Set to true to disable canceling the overlay by clicking outside it |
+| `offset`                 | `offset`                     | `number`                     |         | A pixel value that will be added to the position calculated on the vertical or horizontal axis. The offset is applied dynamically depending on the `positionTarget` |
+| `opened`                 | `opened`                     | `boolean`                    | false   | True if the menu is currently displayed          |
+| `position`               | `position`                   | `Position[] \| undefined`    |         | Set position and align against the attach target. |
+| `positionTarget`         |                              | `HTMLElement \| null`        | null    | Position next to the HTML element                |
+| `transitionStyle`        | `transition-style`           | `string \| null`             | null    | Set the transition style                         |
+| `value`                  | `value`                      | `string`                     | ""      | Returns the first selected item value.           |
+| `values`                 |                              | `string[]`                   | []      | Array of item's values                           |
+| `verticalOffset`         | `vertical-offset`            | `number`                     | 0       | A pixel value that will be added to the position calculated on the vertical axis. The offset will be applied either to the `top` or `bottom` depending on the `positionTarget` |
+| `withBackdrop`           | `with-backdrop`              | `boolean`                    | false   | True to show backdrop                            |
+| `x`                      | `x`                          | `number \| undefined`        |         | Set a specific x coordinate                      |
+| `y`                      | `y`                          | `number \| undefined`        |         | Set a specific y coordinate                      |
 
 ## Events
 

package/lib/overlay-menu/index.d.ts

@@ -25,30 +25,30 @@ export type { OverlayMenuData };
  * @attr {boolean} lock-position-target - Set to true to lock position target
  * @prop {boolean} [lockPositionTarget=false] - Set to true to lock position target
  *
- * @prop {HTMLElement|null} [positionTarget=null] - Position next to the HTML element
+ * @prop {HTMLElement | null} [positionTarget=null] - Position next to the HTML element
  *
  * @attr {string} transition-style - Set the transition style
- * @prop {string|null} [transitionStyle=null] - Set the transition style
+ * @prop {string | null} [transitionStyle=null] - Set the transition style
  *
- * @prop {string} [value=] - Returns the first selected item from values.
+ * @prop {string} [value=""] - Returns the first selected item from values.
  *
- * @attr {number} x - Set a specific x coordinate
- * @prop {number} x - Set a specific x coordinate
+ * @attr {number | undefined} x - Set a specific x coordinate
+ * @prop {number | undefined} x - Set a specific x coordinate
  *
- * @attr {number} y - Set a specific y coordinate
- * @prop {number} y - Set a specific y coordinate
+ * @attr {number | undefined} y - Set a specific y coordinate
+ * @prop {number | undefined} y - Set a specific y coordinate
  *
  * @attr {number} horizontal-offset - A pixel value that will be added to the position calculated on the horizontal axis. The offset will be applied either to the `left` or `right` depending on the `positionTarget`
- * @prop {number} horizontalOffset - A pixel value that will be added to the position calculated on the horizontal axis. The offset will be applied either to the `left` or `right` depending on the `positionTarget`
+ * @prop {number} [horizontalOffset=0] - A pixel value that will be added to the position calculated on the horizontal axis. The offset will be applied either to the `left` or `right` depending on the `positionTarget`
  *
  * @attr {number} vertical-offset - A pixel value that will be added to the position calculated on the vertical axis. The offset will be applied either to the `top` or `bottom` depending on the `positionTarget`
- * @prop {number} verticalOffset - A pixel value that will be added to the position calculated on the vertical axis. The offset will be applied either to the `top` or `bottom` depending on the `positionTarget`
+ * @prop {number} [verticalOffset=0] - A pixel value that will be added to the position calculated on the vertical axis. The offset will be applied either to the `top` or `bottom` depending on the `positionTarget`
  *
  * @attr {number} offset - A pixel value that will be added to the position calculated on the vertical or horizontal axis. The offset is applied dynamically depending on the `positionTarget`
  * @prop {number} offset - A pixel value that will be added to the position calculated on the vertical or horizontal axis. The offset is applied dynamically depending on the `positionTarget`
  *
- * @attr {{} | undefined} position - Set position and align against the attach target.
- * @prop {{} | undefined} position - Set position and align against the attach target.
+ * @attr {Position[] | undefined} position - Set position and align against the attach target.
+ * @prop {Position[] | undefined} position - Set position and align against the attach target.
  */
 export declare class OverlayMenu extends Overlay {
     /**
@@ -81,6 +81,7 @@ export declare class OverlayMenu extends Overlay {
     /**
      * Array of item's values
      * @type {string[]}
+     * @default []
      */
     get values(): string[];
     set values(values: string[]);
@@ -92,6 +93,7 @@ export declare class OverlayMenu extends Overlay {
     /**
      * Construct the menu from data object.
      * Cannot be used with internal content
+     * @type {OverlayMenuData|undefined}
      */
     get data(): OverlayMenuData | undefined;
     set data(value: OverlayMenuData | undefined);

package/lib/overlay-menu/index.js

@@ -34,30 +34,30 @@ import { OpenedMenusManager } from './managers/menu-manager.js';
  * @attr {boolean} lock-position-target - Set to true to lock position target
  * @prop {boolean} [lockPositionTarget=false] - Set to true to lock position target
  *
- * @prop {HTMLElement|null} [positionTarget=null] - Position next to the HTML element
+ * @prop {HTMLElement | null} [positionTarget=null] - Position next to the HTML element
  *
  * @attr {string} transition-style - Set the transition style
- * @prop {string|null} [transitionStyle=null] - Set the transition style
+ * @prop {string | null} [transitionStyle=null] - Set the transition style
  *
- * @prop {string} [value=] - Returns the first selected item from values.
+ * @prop {string} [value=""] - Returns the first selected item from values.
  *
- * @attr {number} x - Set a specific x coordinate
- * @prop {number} x - Set a specific x coordinate
+ * @attr {number | undefined} x - Set a specific x coordinate
+ * @prop {number | undefined} x - Set a specific x coordinate
  *
- * @attr {number} y - Set a specific y coordinate
- * @prop {number} y - Set a specific y coordinate
+ * @attr {number | undefined} y - Set a specific y coordinate
+ * @prop {number | undefined} y - Set a specific y coordinate
  *
  * @attr {number} horizontal-offset - A pixel value that will be added to the position calculated on the horizontal axis. The offset will be applied either to the `left` or `right` depending on the `positionTarget`
- * @prop {number} horizontalOffset - A pixel value that will be added to the position calculated on the horizontal axis. The offset will be applied either to the `left` or `right` depending on the `positionTarget`
+ * @prop {number} [horizontalOffset=0] - A pixel value that will be added to the position calculated on the horizontal axis. The offset will be applied either to the `left` or `right` depending on the `positionTarget`
  *
  * @attr {number} vertical-offset - A pixel value that will be added to the position calculated on the vertical axis. The offset will be applied either to the `top` or `bottom` depending on the `positionTarget`
- * @prop {number} verticalOffset - A pixel value that will be added to the position calculated on the vertical axis. The offset will be applied either to the `top` or `bottom` depending on the `positionTarget`
+ * @prop {number} [verticalOffset=0] - A pixel value that will be added to the position calculated on the vertical axis. The offset will be applied either to the `top` or `bottom` depending on the `positionTarget`
  *
  * @attr {number} offset - A pixel value that will be added to the position calculated on the vertical or horizontal axis. The offset is applied dynamically depending on the `positionTarget`
  * @prop {number} offset - A pixel value that will be added to the position calculated on the vertical or horizontal axis. The offset is applied dynamically depending on the `positionTarget`
  *
- * @attr {{} | undefined} position - Set position and align against the attach target.
- * @prop {{} | undefined} position - Set position and align against the attach target.
+ * @attr {Position[] | undefined} position - Set position and align against the attach target.
+ * @prop {Position[] | undefined} position - Set position and align against the attach target.
  */
 let OverlayMenu = OverlayMenu_1 = class OverlayMenu extends Overlay {
     constructor() {
@@ -131,6 +131,7 @@ let OverlayMenu = OverlayMenu_1 = class OverlayMenu extends Overlay {
     /**
      * Array of item's values
      * @type {string[]}
+     * @default []
      */
     get values() {
         return this.withData ? this.getDataValues() : this.getSlottedValues();
@@ -156,6 +157,7 @@ let OverlayMenu = OverlayMenu_1 = class OverlayMenu extends Overlay {
     /**
      * Construct the menu from data object.
      * Cannot be used with internal content
+     * @type {OverlayMenuData|undefined}
      */
     get data() {
         return this._data;