@openremote/or-vaadin-components 1.13.1

package/custom-elements.json

@@ -0,0 +1,772 @@
+{
+  "schemaVersion": "1.0.0",
+  "readme": "",
+  "modules": [
+    {
+      "kind": "javascript-module",
+      "path": "src/or-vaadin-checkbox.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "OrVaadinCheckbox",
+          "superclass": {
+            "name": "Checkbox",
+            "package": "@vaadin/checkbox"
+          },
+          "tagName": "or-vaadin-checkbox",
+          "customElement": true,
+          "modulePath": "src/or-vaadin-checkbox.ts",
+          "definitionPath": "src/or-vaadin-checkbox.ts"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "OrVaadinCheckbox",
+          "declaration": {
+            "name": "OrVaadinCheckbox",
+            "module": "src/or-vaadin-checkbox.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "or-vaadin-checkbox",
+          "declaration": {
+            "name": "OrVaadinCheckbox",
+            "module": "src/or-vaadin-checkbox.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/or-vaadin-dialog.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "OrVaadinDialog",
+          "superclass": {
+            "name": "Dialog",
+            "package": "@vaadin/dialog"
+          },
+          "tagName": "or-vaadin-dialog",
+          "customElement": true,
+          "modulePath": "src/or-vaadin-dialog.ts",
+          "definitionPath": "src/or-vaadin-dialog.ts"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "dialogFooterRenderer",
+          "declaration": {
+            "name": "dialogFooterRenderer",
+            "module": "\"@vaadin/dialog/lit.js\""
+          }
+        },
+        {
+          "kind": "js",
+          "name": "dialogRenderer",
+          "declaration": {
+            "name": "dialogRenderer",
+            "module": "\"@vaadin/dialog/lit.js\""
+          }
+        },
+        {
+          "kind": "js",
+          "name": "OrVaadinDialog",
+          "declaration": {
+            "name": "OrVaadinDialog",
+            "module": "src/or-vaadin-dialog.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "or-vaadin-dialog",
+          "declaration": {
+            "name": "OrVaadinDialog",
+            "module": "src/or-vaadin-dialog.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/or-vaadin-input.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "Custom element that wraps various Vaadin input components based on the specified `type`.\nProvides a unified interface for interacting with different types of inputs.",
+          "name": "OrVaadinInput",
+          "members": [
+            {
+              "kind": "field",
+              "name": "VAADIN_CLASSES",
+              "type": {
+                "text": "(CustomElementConstructor | undefined)[]"
+              },
+              "privacy": "public",
+              "static": true,
+              "readonly": true,
+              "default": "[ customElements.get(\"or-vaadin-numberfield\"), customElements.get(\"or-vaadin-passwordfield\"), customElements.get(\"or-vaadin-select\"), customElements.get(\"or-vaadin-textarea\"), customElements.get(\"or-vaadin-textfield\") ]",
+              "description": "Static list of Vaadin component classes to scan through during attribute changes.\nIt's important that the complete list of CustomElements is defined here.\nBe aware: all CustomElements defined here need to be imported during initialization; dynamic imports are not expected to work."
+            },
+            {
+              "kind": "field",
+              "name": "TEMPLATES",
+              "privacy": "public",
+              "static": true,
+              "readonly": true,
+              "default": "new Map<InputType, (onChange: (ev: Event) => void) => TemplateResult>([ [InputType.CHECKBOX, OrVaadinInput.getCheckboxTemplate], [InputType.BIG_INT, OrVaadinInput.getNumberFieldTemplate], [InputType.NUMBER, OrVaadinInput.getNumberFieldTemplate], [InputType.TEXTAREA, OrVaadinInput.getTextAreaTemplate], [InputType.TEXT, OrVaadinInput.getTextFieldTemplate], [InputType.PASSWORD, OrVaadinInput.getPasswordFieldTemplate], [InputType.SELECT, OrVaadinInput.getSelectTemplate] ])",
+              "description": "Static map of template functions that are used to render the Vaadin components.\nFor example, InputType.CHECKBOX generates a `<or-vaadin-checkbox>` element.\nThe map value contains a function, with an onChange callback parameter for handling events."
+            },
+            {
+              "kind": "field",
+              "name": "CHANGE_EVENTS",
+              "privacy": "public",
+              "static": true,
+              "readonly": true,
+              "default": "new Map<InputType, string>([ [InputType.BIG_INT, \"submit\"], [InputType.NUMBER, \"submit\"], [InputType.TEXTAREA, \"submit\"], [InputType.TEXT, \"submit\"], [InputType.PASSWORD, \"submit\"] ])",
+              "description": "Static map of what HTML event to listen for when a value changes. By default, or when undefined, the \"change\" event is used.\nSometimes you'd like to override this, such as a text field, where it should only be updated \"on submit\"."
+            },
+            {
+              "kind": "field",
+              "name": "FORBIDDEN_ATTRIBUTES",
+              "type": {
+                "text": "array"
+              },
+              "privacy": "public",
+              "static": true,
+              "readonly": true,
+              "default": "[\"id\"]",
+              "description": "List of forbidden attributes that are not processed nor \"bubbled down\" to the child Vaadin component.\nSo `<or-vaadin-input id=\"myId\" type=\"text\">`, wouldn't render `<or-vaadin-textfield id=\"myId\">`, but `<or-vaadin-textfield>`."
+            },
+            {
+              "kind": "field",
+              "name": "type",
+              "type": {
+                "text": "InputType"
+              },
+              "privacy": "public",
+              "description": "The input type that determines which Vaadin component to render.\nRefer to InputType and OrVaadinInput.TEMPLATES for the supported types.",
+              "attribute": "type"
+            },
+            {
+              "kind": "field",
+              "name": "_elem",
+              "type": {
+                "text": "HTMLInputElement | undefined"
+              },
+              "privacy": "protected"
+            },
+            {
+              "kind": "field",
+              "name": "_observer",
+              "privacy": "protected",
+              "default": "new MutationObserver((mutations, observer) => this._onAttributeChange(mutations, observer))",
+              "description": "Internal observer for tracking attribute updates on the root element."
+            },
+            {
+              "kind": "field",
+              "name": "native",
+              "type": {
+                "text": "HTMLInputElement | undefined"
+              },
+              "privacy": "public",
+              "description": "Returns the native Vaadin input element.",
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "name": "nativeValue",
+              "type": {
+                "text": "any"
+              },
+              "privacy": "public",
+              "description": "Returns the value of the native Vaadin input element.",
+              "readonly": true
+            },
+            {
+              "kind": "method",
+              "name": "checkValidity",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "description": "Function that returns a boolean which indicates if the element meets any constraint validation rules applied to it.",
+              "type": {
+                "text": "checkValidity() => boolean"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "_onAttributeChange",
+              "privacy": "protected",
+              "parameters": [
+                {
+                  "name": "mutations",
+                  "type": {
+                    "text": "MutationRecord[]"
+                  },
+                  "description": "Array of mutations occurring in a single event"
+                },
+                {
+                  "name": "_observer",
+                  "type": {
+                    "text": "MutationObserver"
+                  },
+                  "description": "The observer causing the {@link MutationCallback}"
+                }
+              ],
+              "description": "Internal MutationCallback function for handling attribute changes from an MutationObserver."
+            },
+            {
+              "kind": "method",
+              "name": "_onPropertyChange",
+              "privacy": "protected",
+              "parameters": [
+                {
+                  "name": "name",
+                  "type": {
+                    "text": "string"
+                  },
+                  "description": "Property key that was changed"
+                },
+                {
+                  "name": "newValue",
+                  "optional": true,
+                  "type": {
+                    "text": "any"
+                  },
+                  "description": "(optional) the new value to apply"
+                }
+              ],
+              "description": "Internal function for handling property changes during the Lit lifecycle."
+            },
+            {
+              "kind": "method",
+              "name": "_onValueChange",
+              "privacy": "protected",
+              "parameters": [
+                {
+                  "name": "ev",
+                  "type": {
+                    "text": "Event"
+                  },
+                  "description": "Event that occurred"
+                }
+              ],
+              "description": "Internal callback function when a user changes the value inside the Vaadin element.\nNormally this is caused by an `@change` event."
+            },
+            {
+              "kind": "method",
+              "name": "_applyAttribute",
+              "privacy": "protected",
+              "parameters": [
+                {
+                  "name": "name",
+                  "type": {
+                    "text": "string"
+                  },
+                  "description": "Attribute name"
+                },
+                {
+                  "name": "value",
+                  "optional": true,
+                  "type": {
+                    "text": "any"
+                  },
+                  "description": "Value to apply"
+                },
+                {
+                  "name": "elem",
+                  "default": "this._elem",
+                  "description": "Optional {@link HTMLInputElement}to apply the change to\n     * "
+                }
+              ],
+              "description": "Internal function to apply an attribute to the child Vaadin element."
+            },
+            {
+              "kind": "method",
+              "name": "getCheckboxTemplate",
+              "privacy": "public",
+              "static": true,
+              "parameters": [
+                {
+                  "name": "onChange",
+                  "optional": true,
+                  "type": {
+                    "text": "(e: Event) => void"
+                  }
+                }
+              ],
+              "type": {
+                "text": "getCheckboxTemplate(onChange?: (e: Event) => void) => void"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "getNumberFieldTemplate",
+              "privacy": "public",
+              "static": true,
+              "parameters": [
+                {
+                  "name": "onChange",
+                  "optional": true,
+                  "type": {
+                    "text": "(e: Event) => void"
+                  }
+                }
+              ],
+              "type": {
+                "text": "getNumberFieldTemplate(onChange?: (e: Event) => void) => void"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "getTextAreaTemplate",
+              "privacy": "public",
+              "static": true,
+              "parameters": [
+                {
+                  "name": "onChange",
+                  "optional": true,
+                  "type": {
+                    "text": "(e: Event) => void"
+                  }
+                }
+              ],
+              "type": {
+                "text": "getTextAreaTemplate(onChange?: (e: Event) => void) => void"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "getTextFieldTemplate",
+              "privacy": "public",
+              "static": true,
+              "parameters": [
+                {
+                  "name": "onChange",
+                  "optional": true,
+                  "type": {
+                    "text": "(e: Event) => void"
+                  }
+                }
+              ],
+              "type": {
+                "text": "getTextFieldTemplate(onChange?: (e: Event) => void) => void"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "getPasswordFieldTemplate",
+              "privacy": "public",
+              "static": true,
+              "parameters": [
+                {
+                  "name": "onChange",
+                  "optional": true,
+                  "type": {
+                    "text": "(e: Event) => void"
+                  }
+                }
+              ],
+              "type": {
+                "text": "getPasswordFieldTemplate(onChange?: (e: Event) => void) => void"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "getSelectTemplate",
+              "privacy": "public",
+              "static": true,
+              "parameters": [
+                {
+                  "name": "onChange",
+                  "optional": true,
+                  "type": {
+                    "text": "(e: Event) => void"
+                  }
+                }
+              ],
+              "type": {
+                "text": "getSelectTemplate(onChange?: (e: Event) => void) => void"
+              }
+            }
+          ],
+          "events": [
+            {
+              "name": "change",
+              "type": {
+                "text": "CustomEvent"
+              }
+            }
+          ],
+          "attributes": [
+            {
+              "name": "type",
+              "type": {
+                "text": "InputType"
+              },
+              "description": "The input type that determines which Vaadin component to render.\nRefer to InputType and OrVaadinInput.TEMPLATES for the supported types.",
+              "fieldName": "type"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "lit"
+          },
+          "tagName": "or-vaadin-input",
+          "customElement": true,
+          "modulePath": "src/or-vaadin-input.ts",
+          "definitionPath": "src/or-vaadin-input.ts"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "OrVaadinInput",
+          "declaration": {
+            "name": "OrVaadinInput",
+            "module": "src/or-vaadin-input.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "or-vaadin-input",
+          "declaration": {
+            "name": "OrVaadinInput",
+            "module": "src/or-vaadin-input.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/or-vaadin-numberfield.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "OrVaadinNumberfield",
+          "members": [
+            {
+              "kind": "method",
+              "name": "_onEnter",
+              "parameters": [
+                {
+                  "name": "ev",
+                  "type": {
+                    "text": "KeyboardEvent"
+                  }
+                }
+              ],
+              "type": {
+                "text": "_onEnter(ev: KeyboardEvent) => void"
+              }
+            }
+          ],
+          "events": [
+            {
+              "name": "submit",
+              "type": {
+                "text": "CustomEvent"
+              }
+            }
+          ],
+          "superclass": {
+            "module": "src/or-vaadin-numberfield.ts"
+          },
+          "tagName": "or-vaadin-numberfield",
+          "customElement": true,
+          "modulePath": "src/or-vaadin-numberfield.ts",
+          "definitionPath": "src/or-vaadin-numberfield.ts"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "OrVaadinNumberfield",
+          "declaration": {
+            "name": "OrVaadinNumberfield",
+            "module": "src/or-vaadin-numberfield.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "or-vaadin-numberfield",
+          "declaration": {
+            "name": "OrVaadinNumberfield",
+            "module": "src/or-vaadin-numberfield.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/or-vaadin-passwordfield.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "OrVaadinPasswordField",
+          "members": [
+            {
+              "kind": "method",
+              "name": "_onEnter",
+              "parameters": [
+                {
+                  "name": "ev",
+                  "type": {
+                    "text": "KeyboardEvent"
+                  }
+                }
+              ],
+              "type": {
+                "text": "_onEnter(ev: KeyboardEvent) => void"
+              }
+            }
+          ],
+          "events": [
+            {
+              "name": "submit",
+              "type": {
+                "text": "CustomEvent"
+              }
+            }
+          ],
+          "superclass": {
+            "module": "src/or-vaadin-passwordfield.ts"
+          },
+          "tagName": "or-vaadin-passwordfield",
+          "customElement": true,
+          "modulePath": "src/or-vaadin-passwordfield.ts",
+          "definitionPath": "src/or-vaadin-passwordfield.ts"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "OrVaadinPasswordField",
+          "declaration": {
+            "name": "OrVaadinPasswordField",
+            "module": "src/or-vaadin-passwordfield.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "or-vaadin-passwordfield",
+          "declaration": {
+            "name": "OrVaadinPasswordField",
+            "module": "src/or-vaadin-passwordfield.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/or-vaadin-select.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "OrVaadinSelect",
+          "superclass": {
+            "name": "Select",
+            "package": "@vaadin/select"
+          },
+          "tagName": "or-vaadin-select",
+          "customElement": true,
+          "modulePath": "src/or-vaadin-select.ts",
+          "definitionPath": "src/or-vaadin-select.ts"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "OrVaadinSelect",
+          "declaration": {
+            "name": "OrVaadinSelect",
+            "module": "src/or-vaadin-select.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "or-vaadin-select",
+          "declaration": {
+            "name": "OrVaadinSelect",
+            "module": "src/or-vaadin-select.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/or-vaadin-textarea.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "OrVaadinTextarea",
+          "members": [
+            {
+              "kind": "method",
+              "name": "_onEnter",
+              "parameters": [
+                {
+                  "name": "ev",
+                  "type": {
+                    "text": "KeyboardEvent"
+                  }
+                }
+              ],
+              "type": {
+                "text": "_onEnter(ev: KeyboardEvent) => void"
+              }
+            }
+          ],
+          "events": [
+            {
+              "name": "submit",
+              "type": {
+                "text": "CustomEvent"
+              }
+            }
+          ],
+          "superclass": {
+            "module": "src/or-vaadin-textarea.ts"
+          },
+          "tagName": "or-vaadin-textarea",
+          "customElement": true,
+          "modulePath": "src/or-vaadin-textarea.ts",
+          "definitionPath": "src/or-vaadin-textarea.ts"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "OrVaadinTextarea",
+          "declaration": {
+            "name": "OrVaadinTextarea",
+            "module": "src/or-vaadin-textarea.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "or-vaadin-textarea",
+          "declaration": {
+            "name": "OrVaadinTextarea",
+            "module": "src/or-vaadin-textarea.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/or-vaadin-textfield.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "OrVaadinTextfield",
+          "members": [
+            {
+              "kind": "method",
+              "name": "_onEnter",
+              "parameters": [
+                {
+                  "name": "ev",
+                  "type": {
+                    "text": "KeyboardEvent"
+                  }
+                }
+              ],
+              "type": {
+                "text": "_onEnter(ev: KeyboardEvent) => void"
+              }
+            }
+          ],
+          "events": [
+            {
+              "name": "submit",
+              "type": {
+                "text": "CustomEvent"
+              }
+            }
+          ],
+          "superclass": {
+            "module": "src/or-vaadin-textfield.ts"
+          },
+          "tagName": "or-vaadin-textfield",
+          "customElement": true,
+          "modulePath": "src/or-vaadin-textfield.ts",
+          "definitionPath": "src/or-vaadin-textfield.ts"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "OrVaadinTextfield",
+          "declaration": {
+            "name": "OrVaadinTextfield",
+            "module": "src/or-vaadin-textfield.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "or-vaadin-textfield",
+          "declaration": {
+            "name": "OrVaadinTextfield",
+            "module": "src/or-vaadin-textfield.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/util.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "getValueHolderInputTemplateProvider",
+          "parameters": [
+            {
+              "name": "assetDescriptor"
+            },
+            {
+              "name": "valueHolder"
+            },
+            {
+              "name": "valueHolderDescriptor"
+            },
+            {
+              "name": "valueDescriptor"
+            },
+            {
+              "name": "valueChangeNotifier"
+            },
+            {
+              "name": "options"
+            }
+          ],
+          "description": "Internal function to retrieve HTML template based on the Asset-, attribute-, and value descriptors\nIt generates a template using `or-vaadin-input`, together with respective HTML attributes like min/max, pattern, and of course 'input type'.\nFor example, a 'positive number' attribute will render a `<or-vaadin-input type=\"number\" min=\"0\">`.\nIf the Vaadin input doesn't support the 'input type', it will automatically fall back to the older `or-mwc-input`.\n\nThis is mostly copied over from `or-mwc-input`, so this will need optimizing once that has been deprecated."
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "getValueHolderInputTemplateProvider",
+          "declaration": {
+            "name": "getValueHolderInputTemplateProvider",
+            "module": "src/util.ts"
+          }
+        }
+      ]
+    }
+  ]
+}