@openremote/or-gauge 1.11.0-snapshot.20251103144513 → 1.11.0

package/custom-elements-jsx.d.ts

@@ -0,0 +1,198 @@
+
+import type { OrGauge } from "./lib/index.d.ts";
+
+/**
+ * This type can be used to create scoped tags for your components.
+ *
+ * Usage:
+ *
+ * ```ts
+ * import type { ScopedElements } from "path/to/library/jsx-integration";
+ *
+ * declare module "my-library" {
+ *   namespace JSX {
+ *     interface IntrinsicElements
+ *       extends ScopedElements<'test-', ''> {}
+ *   }
+ * }
+ * ```
+ *
+ * @deprecated Runtime scoped elements result in duplicate types and can confusing for developers. It is recommended to use the `prefix` and `suffix` options to generate new types instead.
+ */
+export type ScopedElements<
+  Prefix extends string = "",
+  Suffix extends string = ""
+> = {
+  [Key in keyof CustomElements as `${Prefix}${Key}${Suffix}`]: CustomElements[Key];
+};
+
+type BaseProps<T extends HTMLElement> = {
+
+  /** Content added between the opening and closing tags of the element */
+  children?: any;
+  /** Used for declaratively styling one or more elements using CSS (Cascading Stylesheets) */
+  class?: string;
+  /** Used for declaratively styling one or more elements using CSS (Cascading Stylesheets) */
+  className?: string;
+  /** Takes an object where the key is the class name(s) and the value is a boolean expression. When true, the class is applied, and when false, it is removed. */
+  classList?: Record<string, boolean | undefined>;
+  /** Specifies the text direction of the element. */
+  dir?: "ltr" | "rtl";
+  /** Contains a space-separated list of the part names of the element that should be exposed on the host element. */
+  exportparts?: string;
+  /** For <label> and <output>, lets you associate the label with some control. */
+  htmlFor?: string;
+  /** Specifies whether the element should be hidden. */
+  hidden?: boolean | string;
+  /** A unique identifier for the element. */
+  id?: string;
+  /** Keys tell React which array item each component corresponds to */
+  key?: string | number;
+  /** Specifies the language of the element. */
+  lang?: string;
+  /** Contains a space-separated list of the part names of the element. Part names allows CSS to select and style specific elements in a shadow tree via the ::part pseudo-element. */
+  part?: string;
+  /** Use the ref attribute with a variable to assign a DOM element to the variable once the element is rendered. */
+  ref?: T | ((e: T) => void);
+  /** Adds a reference for a custom element slot */
+  slot?: string;
+  /** Prop for setting inline styles */
+  style?: Record<string, string | number>;
+  /** Overrides the default Tab button behavior. Avoid using values other than -1 and 0. */
+  tabIndex?: number;
+  /** Specifies the tooltip text for the element. */
+  title?: string;
+  /** Passing 'no' excludes the element content from being translated. */
+  translate?: "yes" | "no";
+  /** The popover global attribute is used to designate an element as a popover element. */
+  popover?: "auto" | "hint" | "manual";
+  /** Turns an element element into a popover control button; takes the ID of the popover element to control as its value. */
+  popovertarget?: "top" | "bottom" | "left" | "right" | "auto";
+  /** Specifies the action to be performed on a popover element being controlled by a control element. */
+  popovertargetaction?: "show" | "hide" | "toggle";
+
+} ;
+
+type BaseEvents = {
+
+
+};
+
+
+
+export type OrGaugeProps = {
+  /**  */
+  "attrRef"?: OrGauge['attrRef'];
+  /**  */
+  "asset"?: OrGauge['asset'];
+  /**  */
+  "assetAttribute"?: OrGauge['assetAttribute'];
+  /**  */
+  "value"?: OrGauge['value'];
+  /**  */
+  "decimals"?: OrGauge['decimals'];
+  /**  */
+  "unit"?: OrGauge['unit'];
+  /**  */
+  "min"?: OrGauge['min'];
+  /**  */
+  "max"?: OrGauge['max'];
+  /**  */
+  "thresholds"?: OrGauge['thresholds'];
+  /**  */
+  "config"?: OrGauge['config'];
+  /**  */
+  "realm"?: OrGauge['realm'];
+
+
+}
+
+  export type CustomElements = {
+
+
+  /**
+     * 
+ * 
+ * ## Attributes & Properties
+ * 
+ * Component attributes and properties that can be applied to the element or by using JavaScript.
+ * 
+ * - `attrRef`: undefined 
+ * - `asset`: undefined 
+ * - `assetAttribute`: undefined 
+ * - `value`: undefined 
+ * - `decimals`: undefined 
+ * - `unit`: undefined 
+ * - `min`: undefined 
+ * - `max`: undefined 
+ * - `thresholds`: undefined 
+ * - `config`: undefined 
+ * - `realm`: undefined 
+ * 
+ * ## Methods
+ * 
+ * Methods that can be called to access component functionality.
+ * 
+ * - `setupGauge() => void`: undefined
+ * - `getGaugeWidth(gaugeSize?: { width: number, height: number }, includeLabelHeight: boolean = true) => string`: undefined
+ * - `shouldShowLabel(gaugeSize: { width: number, height: number }) => boolean`: undefined
+ * - `getLabelSize(width: number) => "s" | "m" | "l" | "xl"`: undefined
+ * - `loadData(attrRef: AttributeRef) => void`: undefined
+ * - `getDefaultConfig() => OrGaugeConfig`: undefined
+  */
+    "or-gauge": Partial<OrGaugeProps & BaseProps<OrGauge> & BaseEvents>;
+  }
+
+export type CustomCssProperties = {
+
+}
+
+
+declare module 'react' {
+  namespace JSX {
+    interface IntrinsicElements extends CustomElements {}
+  }
+  export interface CSSProperties extends CustomCssProperties {}
+}
+
+declare module 'preact' {
+  namespace JSX {
+    interface IntrinsicElements extends CustomElements {}
+  }
+  export interface CSSProperties extends CustomCssProperties {}
+}
+
+declare module '@builder.io/qwik' {
+  namespace JSX {
+    interface IntrinsicElements extends CustomElements {}
+  }
+  export interface CSSProperties extends CustomCssProperties {}
+}
+
+declare module '@stencil/core' {
+  namespace JSX {
+    interface IntrinsicElements extends CustomElements {}
+  }
+  export interface CSSProperties extends CustomCssProperties {}
+}
+
+declare module 'hono/jsx' {
+  namespace JSX {
+    interface IntrinsicElements extends CustomElements {}
+  }
+  export interface CSSProperties extends CustomCssProperties {}
+}
+
+declare module 'react-native' {
+  namespace JSX {
+    interface IntrinsicElements extends CustomElements {}
+  }
+  export interface CSSProperties extends CustomCssProperties {}
+}
+
+declare global {
+  namespace JSX {
+    interface IntrinsicElements extends CustomElements {}
+  }
+  export interface CSSProperties extends CustomCssProperties {}
+}

package/custom-elements.json

@@ -171,7 +171,10 @@
             },
             {
               "kind": "method",
-              "name": "setupGauge"
+              "name": "setupGauge",
+              "type": {
+                "text": "setupGauge() => void"
+              }
             },
             {
               "kind": "method",
@@ -196,7 +199,10 @@
                     "text": "boolean"
                   }
                 }
-              ]
+              ],
+              "type": {
+                "text": "getGaugeWidth(gaugeSize?: { width: number, height: number }, includeLabelHeight: boolean = true) => string"
+              }
             },
             {
               "kind": "method",
@@ -213,7 +219,10 @@
                     "text": "{ width: number, height: number }"
                   }
                 }
-              ]
+              ],
+              "type": {
+                "text": "shouldShowLabel(gaugeSize: { width: number, height: number }) => boolean"
+              }
             },
             {
               "kind": "method",
@@ -230,7 +239,10 @@
                     "text": "number"
                   }
                 }
-              ]
+              ],
+              "type": {
+                "text": "getLabelSize(width: number) => \"s\" | \"m\" | \"l\" | \"xl\""
+              }
             },
             {
               "kind": "method",
@@ -242,7 +254,10 @@
                     "text": "AttributeRef"
                   }
                 }
-              ]
+              ],
+              "type": {
+                "text": "loadData(attrRef: AttributeRef) => void"
+              }
             },
             {
               "kind": "method",
@@ -251,6 +266,9 @@
                 "type": {
                   "text": "OrGaugeConfig"
                 }
+              },
+              "type": {
+                "text": "getDefaultConfig() => OrGaugeConfig"
               }
             }
           ],
@@ -340,7 +358,9 @@
             "package": "lit"
           },
           "tagName": "or-gauge",
-          "customElement": true
+          "customElement": true,
+          "modulePath": "src/index.ts",
+          "definitionPath": "src/index.ts"
         }
       ],
       "exports": [