@kvaser/canking-api 7.2.1 → 7.3.0

package/dist/ElectronAPIFake.js

@@ -1 +1 @@
-"use strict";var p=Object.defineProperty;var d=(r,e,s)=>e in r?p(r,e,{enumerable:!0,configurable:!0,writable:!0,value:s}):r[e]=s;var t=(r,e,s)=>d(r,typeof e!="symbol"?e+"":e,s);require("long");const v=require("./measurement_settings.js");class F{constructor(e){t(this,"userSettings");this.userSettings=e}on(e,s){return()=>{}}once(e,s){return()=>{}}removeAllListeners(e){}removeListener(e,s){return this}send(e,...s){}invoke(e,...s){switch(e){case"rpc-get-devices":const n=[];return Promise.resolve(n);case"app-get-session-data":return Promise.resolve(null);case"app-get-user-settings":return Promise.resolve(this.userSettings);case"rpc-get-online-status":const o={isOnline:!1};return Promise.resolve(o);case"rpc-get-node-statuses":const c=[];return Promise.resolve(c);case"prj-get-meas-setup":return Promise.resolve(v.MeasurementSetup.create());case"prj-get-workspaces":const i=[];return Promise.resolve(i);case"prj-get-workspace-panes":const l=[];return Promise.resolve(l);case"app-get-workspace-view-session-data":case"rpc-start-periodic-transmission":return Promise.resolve("");case"rpc-get-message-log-file-formats":const u=[];return Promise.resolve(u);case"rpc-get-signal-log-file-formats":const m=[];return Promise.resolve(m);case"rpc-get-frame-definitions":const g=[];return Promise.resolve(g);case"mm-get-measurement-data-buffer":case"mm-get-latest-measurement-data":return Promise.resolve(frames);default:return Promise.resolve()}}postMessage(e,s,n){}sendSync(e,...s){}sendTo(e,s,...n){}sendToHost(e,...s){}}class f{insertCSS(e){return""}setZoomFactor(e){}setZoomLevel(e){}}class P{constructor(){t(this,"platform");t(this,"versions");t(this,"env")}}const a=r=>{const e={version:"1.0.0",theme:"light",language:"en",strings:{},showToolsPanel:!0,useHexNumericBase:!0,maxDataBytes:16,defaultProjectFolder:"",defaultLogFilesFolder:"",defaultCANDatabasesFolder:"",defaultLINDatabasesFolder:"",currentProjectFile:"",currentProjectFileName:"",recentProjectFiles:[],closeAppServiceAction:"prompt"};return{ipcRenderer:new F(r??e),webFrame:new f,process:new P}},h=a();exports.createElectronApiFake=a;exports.electronApiFake=h;
+"use strict";var g=Object.defineProperty;var d=(r,e,s)=>e in r?g(r,e,{enumerable:!0,configurable:!0,writable:!0,value:s}):r[e]=s;var t=(r,e,s)=>d(r,typeof e!="symbol"?e+"":e,s);require("long");const v=require("./measurement_settings.js");class F{constructor(e){t(this,"userSettings");this.userSettings=e}on(e,s){return()=>{}}once(e,s){return()=>{}}removeAllListeners(e){}removeListener(e,s){return this}send(e,...s){}invoke(e,...s){switch(e){case"rpc-get-devices":const n=[];return Promise.resolve(n);case"app-get-session-data":return Promise.resolve(null);case"app-get-user-settings":return Promise.resolve(this.userSettings);case"rpc-get-online-status":const o={isOnline:!1};return Promise.resolve(o);case"rpc-get-node-statuses":const c=[];return Promise.resolve(c);case"prj-get-meas-setup":return Promise.resolve(v.MeasurementSetup.create());case"prj-get-workspaces":const i=[];return Promise.resolve(i);case"prj-get-workspace-panes":const l=[];return Promise.resolve(l);case"app-get-workspace-view-session-data":case"rpc-start-periodic-transmission":return Promise.resolve("");case"rpc-get-message-log-file-formats":const m=[];return Promise.resolve(m);case"rpc-get-signal-log-file-formats":const u=[];return Promise.resolve(u);case"rpc-get-frame-definitions":const p=[];return Promise.resolve(p);case"mm-get-measurement-data-before-timestamp":return Promise.resolve(frames);case"mm-get-latest-timestamp":return Promise.resolve(0);default:return Promise.resolve()}}postMessage(e,s,n){}sendSync(e,...s){}sendTo(e,s,...n){}sendToHost(e,...s){}}class P{insertCSS(e){return""}setZoomFactor(e){}setZoomLevel(e){}}class f{constructor(){t(this,"platform");t(this,"versions");t(this,"env")}}const a=r=>{const e={version:"1.0.0",theme:"light",language:"en",strings:{},showToolsPanel:!0,useHexNumericBase:!0,maxDataBytes:16,defaultProjectFolder:"",defaultLogFilesFolder:"",defaultCANDatabasesFolder:"",defaultLINDatabasesFolder:"",currentProjectFile:"",currentProjectFileName:"",recentProjectFiles:[],closeAppServiceAction:"prompt"};return{ipcRenderer:new F(r??e),webFrame:new P,process:new f}},h=a();exports.createElectronApiFake=a;exports.electronApiFake=h;

package/dist/ElectronAPIFake.mjs

@@ -2,7 +2,7 @@ var p = Object.defineProperty;
 var g = (r, e, s) => e in r ? p(r, e, { enumerable: !0, configurable: !0, writable: !0, value: s }) : r[e] = s;
 var t = (r, e, s) => g(r, typeof e != "symbol" ? e + "" : e, s);
 import "long";
-import { aI as d } from "./measurement_settings.mjs";
+import { aJ as d } from "./measurement_settings.mjs";
 class v {
   /**
    * Creates a new IpcRendererFake.
@@ -129,9 +129,10 @@ class v {
       case "rpc-get-frame-definitions":
         const u = [];
         return Promise.resolve(u);
-      case "mm-get-measurement-data-buffer":
-      case "mm-get-latest-measurement-data":
+      case "mm-get-measurement-data-before-timestamp":
         return Promise.resolve(frames);
+      case "mm-get-latest-timestamp":
+        return Promise.resolve(0);
       default:
         return Promise.resolve();
     }
@@ -193,7 +194,7 @@ class v {
   sendToHost(e, ...s) {
   }
 }
-class f {
+class F {
   /**
    * A key for the inserted CSS that can later be used to remove the CSS via
    * `webFrame.removeInsertedCSS(key)`.
@@ -225,7 +226,7 @@ class f {
   setZoomLevel(e) {
   }
 }
-class F {
+class P {
   constructor() {
     /**
      * The process.platform property returns a string identifying the operating system platform
@@ -242,7 +243,7 @@ class F {
     t(this, "env");
   }
 }
-const P = (r) => {
+const f = (r) => {
   const e = {
     version: "1.0.0",
     theme: "light",
@@ -262,11 +263,11 @@ const P = (r) => {
   };
   return {
     ipcRenderer: new v(r ?? e),
-    webFrame: new f(),
-    process: new F()
+    webFrame: new F(),
+    process: new P()
   };
-}, S = P();
+}, S = f();
 export {
-  P as c,
+  f as c,
   S as e
 };

package/dist/controls/CanChannelSelectControl.d.ts

@@ -6,8 +6,8 @@ export interface CanChannelSelectControlProps {
     channelIdentifier: string;
     /**
      * Callback that will be called when a new channel has been selected.
-     * @param identifier The new channel identifier.
-     * @param canFdSupport True if the new CAN channel supports CAN-FD.
+     * @param identifier - The new channel identifier.
+     * @param canFdSupport - True if the new CAN channel supports CAN-FD.
      */
     onChannelIdentifierChange: (identifier: string, canFdSupport: boolean) => void;
     /** Set to true to hide all silent channels e.g., when the control is used for selecting output channel. */
@@ -22,13 +22,13 @@ export interface CanChannelSelectControlProps {
     collapsed?: boolean;
     /**
      * Callback that will be called when collapse state has changed.
-     * @param value The new collapse state.
+     * @param value - The new collapse state.
      */
     collapsedChange?: (value: boolean) => void;
 }
 /**
  * Creates an UI control for selecting a CAN channel from the current measurement setup.
- * @param props Component properties.
+ * @param props - Component properties.
  * @returns The CanChannelSelectControl React component.
  */
 declare function CanChannelSelectControl({ channelIdentifier, onChannelIdentifierChange, hideSilentChannels, hideSectionControl, disabled, collapsible, collapsed, collapsedChange, }: CanChannelSelectControlProps): import("react/jsx-runtime").JSX.Element;

package/dist/controls/CanIdentifierControl.d.ts

@@ -8,7 +8,7 @@
  * @packageDocumentation
  */
 import React from 'react';
-import { PeriodicTransmissionSettings, WriteFrame } from '../models';
+import { PeriodicTransmissionSettings, SignalDefinition, WriteFrame } from '../models';
 /** Possible CAN identifier types, standard (11-bits) or extended (29-bits). */
 export type canIdentifierType = 'standard' | 'extended';
 /** Possible CAN identifier generator types. */
@@ -23,36 +23,46 @@ interface CanIdentifierControlProps {
     canIdentifierType: canIdentifierType;
     /**
      * Callback that will be called when the CAN identifier has changed.
-     * @param identifier The new CAN identifier.
-     * @param idType The new CAN identifier type.
+     * @param identifier - The new CAN identifier.
+     * @param idType - The new CAN identifier type.
      */
     onCanIdentifierChange: (identifier: string, idType: canIdentifierType) => void;
+    /**
+     * Callback that will be called when the settings have changed after selecting a signal.
+     * If this property is set, then the onCanIdentifierChange callback will not be called.
+     * @param identifier - The new CAN identifier.
+     * @param idType - The new CAN identifier type.
+     * @param signal - The new signal or undefined if no signal is selected.
+     */
+    onSignalChange?: (identifier: string, idType: canIdentifierType, signal: SignalDefinition | undefined) => void;
     /**
      * Callback that will be called when the errors state has changed.
-     * @param errors The new errors state.
+     * @param errors - The new errors state.
      */
     onErrorsChange?: (errors: boolean) => void;
+    /** Set to true to disable this control. */
+    disabled?: boolean;
     /**
-     * Callback that will be called when the select message dialog has been opened or closed.
-     * @param value The new show select message dialog state.
+     * Name of a parent dialog, if any, that is used as the parent for the select message and select signal dialogs.
+     * Leave undefined if there is no parent dialog.
      */
-    showSelectMessageDialogChange?: (value: boolean) => void;
+    parentDialogTitle?: string;
+    /** Set to true if the select message and select signal dialogs should be full screen dialogs. */
+    fullScreen?: boolean;
     /**
-     * Callback that will be called when the select signal dialog has been opened or closed.
-     * @param value The new show select signal dialog state.
+     * Identifier of the node that will be used to filter messages and signals in the select dialogs.
+     * Leave undefined if no filtering should be done.
      */
-    showSelectSignalDialogChange?: (value: boolean) => void;
-    /** Set to true to disable this control. */
-    disabled?: boolean;
+    nodeIdentifier?: string;
     /** Set to true if the select message button should be disabled. */
     disableSelectMessageButton?: boolean;
     /** Set to true if the select signal button should be disabled. */
     disableSelectSignalButton?: boolean;
     /** Set to true if this control shouldn't be encapsulated inside a SectionControl. */
     hideSection?: boolean;
-    /** Set to true if the select message button shouldn't be visible. */
+    /** Set to true if the select message button should be hidden. */
     hideSelectMessageButton?: boolean;
-    /** Set to true if the select signal button shouldn't be visible. */
+    /** Set to true if the select signal button should be visible. If set to true, then the select message button will be hidden. */
     showSelectSignalButton?: boolean;
     /** Set to true if the SectionControl should be collapsible, ignored if hideSectionControl is true. */
     collapsible?: boolean;
@@ -60,16 +70,16 @@ interface CanIdentifierControlProps {
     collapsed?: boolean;
     /**
      * Callback that will be called when collapse state has changed.
-     * @param value The new collapse state.
+     * @param value - The new collapse state.
      */
     collapsedChange?: (value: boolean) => void;
 }
 /**
  * Creates an UI control for editing a CAN identifier.
- * @param props Component properties.
+ * @param props - Component properties.
  * @returns The CanIdentifierControl React component.
  */
-declare function CanIdentifierControl({ canIdentifier, canIdentifierType, onCanIdentifierChange, onErrorsChange, showSelectMessageDialogChange, showSelectSignalDialogChange, disabled, disableSelectMessageButton, disableSelectSignalButton, hideSection, hideSelectMessageButton, showSelectSignalButton, collapsible, collapsed, collapsedChange, }: CanIdentifierControlProps): import("react/jsx-runtime").JSX.Element;
+declare function CanIdentifierControl({ canIdentifier, canIdentifierType, onCanIdentifierChange, onErrorsChange, onSignalChange, disabled, parentDialogTitle, fullScreen, nodeIdentifier, disableSelectMessageButton, disableSelectSignalButton, hideSection, hideSelectMessageButton, showSelectSignalButton, collapsible, collapsed, collapsedChange, }: CanIdentifierControlProps): import("react/jsx-runtime").JSX.Element;
 /**
  * Properties of the CanIdentifierFrameControl React component.
  */
@@ -78,50 +88,48 @@ interface CanIdentifierFrameControlProps {
     frame: WriteFrame;
     /**
      * Callback that will be called when the frame is updated after the CAN identifier has changed.
-     * @param value The new frame object.
+     * @param value - The new frame object.
      */
     onFrameChange: (value: WriteFrame) => void;
     /**
      * Callback that will be called when the errors state has changed.
-     * @param errors The new errors state.
+     * @param errors - The new errors state.
      */
     onErrorsChange?: (errors: boolean) => void;
     /**
-     * Callback that will be called when the select message dialog has been opened or closed.
-     * @param value The new show select message dialog state.
+     * Name of a parent dialog, if any, that is used as the parent for the select message and select signal dialogs.
+     * Leave undefined if there is no parent dialog.
      */
-    showSelectMessageDialogChange?: (value: boolean) => void;
+    parentDialogTitle?: string;
+    /** Set to true if the select message and select signal dialogs should be full screen dialogs. */
+    fullScreen?: boolean;
     /**
-     * Callback that will be called when the select signal dialog has been opened or closed.
-     * @param value The new show select signal dialog state.
+     * Identifier of the node that will be used to filter messages and signals in the select dialogs.
+     * Leave undefined if no filtering should be done.
      */
-    showSelectSignalDialogChange?: (value: boolean) => void;
+    nodeIdentifier?: string;
     /** Set to true if the select message button should be disabled. */
     disableSelectMessageButton?: boolean;
-    /** Set to true if the select signal button should be disabled. */
-    disableSelectSignalButton?: boolean;
     /** Set to true if this control shouldn't be encapsulated inside a SectionControl. */
     hideSection?: boolean;
-    /** Set to true if the select message button shouldn't be visible. */
+    /** Set to true if the select message button should be hidden. */
     hideSelectMessageButton?: boolean;
-    /** Set to true if the select signal button should be visible. */
-    showSelectSignalButton?: boolean;
     /** Set to true if the SectionControl should be collapsible. */
     collapsible?: boolean;
     /** Current collapse state of the SectionControl. */
     collapsed?: boolean;
     /**
      * Callback that will be called when collapse state has changed.
-     * @param value The new collapse state.
+     * @param value - The new collapse state.
      */
     collapsedChange?: (value: boolean) => void;
 }
 /**
  * Creates an UI control for editing a CAN identifier using a Frame as source.
- * @param props Component properties.
+ * @param props - Component properties.
  * @returns The CanIdentifierFrameControl React component.
  */
-declare function CanIdentifierFrameControl({ frame, onFrameChange, onErrorsChange, showSelectMessageDialogChange, showSelectSignalDialogChange, disableSelectMessageButton, disableSelectSignalButton, hideSection, hideSelectMessageButton, showSelectSignalButton, collapsible, collapsed, collapsedChange, }: CanIdentifierFrameControlProps): import("react/jsx-runtime").JSX.Element;
+declare function CanIdentifierFrameControl({ frame, onFrameChange, onErrorsChange, parentDialogTitle, fullScreen, nodeIdentifier, disableSelectMessageButton, hideSection, hideSelectMessageButton, collapsible, collapsed, collapsedChange, }: CanIdentifierFrameControlProps): import("react/jsx-runtime").JSX.Element;
 /**
  * Properties of the CanIdentifierGeneratorControl React component.
  */
@@ -143,15 +151,15 @@ interface CanIdentifierGeneratorControlProps {
     canIdentifierType: canIdentifierType;
     /**
      * Callback that will be called when the CAN identifier(s) has changed.
-     * @param newCanIdentifier The new constant CAN identifier.
-     * @param newIdentifierGeneratorType The new generator type.
-     * @param newMinCanIdentifier The new min CAN identifier.
-     * @param newMaxCanIdentifier The new max CAN identifier.
+     * @param newCanIdentifier - The new constant CAN identifier.
+     * @param newIdentifierGeneratorType - The new generator type.
+     * @param newMinCanIdentifier - The new min CAN identifier.
+     * @param newMaxCanIdentifier - The new max CAN identifier.
      */
     onChange: (newCanIdentifier: string, newIdentifierGeneratorType: canIdentifierGeneratorType, newMinCanIdentifier: string, newMaxCanIdentifier: string, newIdentifierType: canIdentifierType) => void;
     /**
      * Callback that will be called when the errors state has changed.
-     * @param errors The new errors state.
+     * @param errors - The new errors state.
      */
     onErrorsChange?: (errors: boolean) => void;
     /** The current error state. */
@@ -164,24 +172,32 @@ interface CanIdentifierGeneratorControlProps {
     collapsed?: boolean;
     /**
      * Callback that will be called when collapse state has changed.
-     * @param value The new collapse state.
+     * @param value - The new collapse state.
      */
     collapsedChange?: (value: boolean) => void;
-    /**
-     * Callback for specifying if the select message dialog should be visible.
-     */
-    showSelectMessageDialogChange: (value: boolean) => void;
     /**
      * Callback for specifying if the signal values table should be visible.
      */
     showSignalValuesTable: (value: boolean) => void;
+    /**
+     * Name of a parent dialog, if any, that is used as the parent for the select message dialog.
+     * Leave undefined if there is no parent dialog.
+     */
+    parentDialogTitle?: string;
+    /** Set to true if the select message dialog should be a full screen dialog. */
+    fullScreen?: boolean;
+    /**
+     * Identifier of the node that will be used to filter messages in the select dialog.
+     * Leave undefined if no filtering should be done.
+     */
+    nodeIdentifier?: string;
 }
 /**
  * Creates an UI control for editing CAN identifier(s) used by a message generator.
- * @param props Component properties.
+ * @param props - Component properties.
  * @returns The CanIdentifierGeneratorControl React component.
  */
-declare function CanIdentifierGeneratorControl({ canIdentifier, identifierGeneratorType, minCanIdentifier, maxCanIdentifier, canIdentifierType, onChange, onErrorsChange, canIdentifierGeneratorSettingsError, disabled, collapsible, collapsed, collapsedChange, showSelectMessageDialogChange, showSignalValuesTable, }: CanIdentifierGeneratorControlProps): import("react/jsx-runtime").JSX.Element;
+declare function CanIdentifierGeneratorControl({ canIdentifier, identifierGeneratorType, minCanIdentifier, maxCanIdentifier, canIdentifierType, onChange, onErrorsChange, canIdentifierGeneratorSettingsError, disabled, collapsible, collapsed, collapsedChange, showSignalValuesTable, parentDialogTitle, fullScreen, nodeIdentifier, }: CanIdentifierGeneratorControlProps): import("react/jsx-runtime").JSX.Element;
 /**
  * Properties of the CanIdentifierGeneratorSettingsControl React component.
  */
@@ -190,12 +206,12 @@ interface CanIdentifierGeneratorSettingsControlProps {
     settings: PeriodicTransmissionSettings;
     /**
      * Callback that will be called when the settings are updated after the CAN identifiers have changed.
-     * @param value The new settings object.
+     * @param value - The new settings object.
      */
     onSettingsChange: (value: PeriodicTransmissionSettings) => void;
     /**
      * Callback that will be called when the errors state has changed.
-     * @param errors The new errors state.
+     * @param errors - The new errors state.
      */
     onErrorsChange?: (errors: boolean) => void;
     /** The current error state. */
@@ -208,24 +224,32 @@ interface CanIdentifierGeneratorSettingsControlProps {
     collapsed?: boolean;
     /**
      * Callback that will be called when collapse state has changed.
-     * @param value The new collapse state.
+     * @param value - The new collapse state.
      */
     collapsedChange?: (value: boolean) => void;
-    /**
-     * Callback for specifying if the select message dialog should be visible.
-     */
-    showSelectMessageDialogChange: (value: boolean) => void;
     /**
      * Callback for specifying if the signal values table should be visible.
      */
     showSignalValuesTable: (value: boolean) => void;
+    /**
+     * Name of a parent dialog, if any, that is used as the parent for the select message dialog.
+     * Leave undefined if there is no parent dialog.
+     */
+    parentDialogTitle?: string;
+    /** Set to true if the select message dialog should be a full screen dialog. */
+    fullScreen?: boolean;
+    /**
+     * Identifier of the node that will be used to filter messages in the select dialog.
+     * Leave undefined if no filtering should be done.
+     */
+    nodeIdentifier?: string;
 }
 /**
  * Creates an UI control for editing CAN identifier(s) used by a message generator
  * using a PeriodicTransmissionSettings as source.
- * @param props Component properties.
+ * @param props - Component properties.
  * @returns The CanIdentifierGeneratorSettingsControl React component.
  */
-declare function CanIdentifierGeneratorSettingsControl({ settings, onSettingsChange, onErrorsChange, canIdentifierGeneratorSettingsError, disabled, collapsible, collapsed, collapsedChange, showSelectMessageDialogChange, showSignalValuesTable, }: CanIdentifierGeneratorSettingsControlProps): import("react/jsx-runtime").JSX.Element;
+declare function CanIdentifierGeneratorSettingsControl({ settings, onSettingsChange, onErrorsChange, canIdentifierGeneratorSettingsError, disabled, collapsible, collapsed, collapsedChange, showSignalValuesTable, parentDialogTitle, fullScreen, nodeIdentifier, }: CanIdentifierGeneratorSettingsControlProps): import("react/jsx-runtime").JSX.Element;
 export default CanIdentifierControl;
 export { type CanIdentifierControlProps, CanIdentifierControl, type CanIdentifierFrameControlProps, CanIdentifierFrameControl, type CanIdentifierGeneratorControlProps, CanIdentifierGeneratorControl, type CanIdentifierGeneratorSettingsControlProps, CanIdentifierGeneratorSettingsControl, };

package/dist/controls/CanKingDataProvider.d.ts

@@ -19,7 +19,7 @@
  * @packageDocumentation
  */
 import React from 'react';
-import { Device, NodeStatus, LogMessage, MeasurementSetup, OnlineStatus, IUserSettings, IWorkspacePaneData } from '../models';
+import { Device, Frame, NodeStatus, LogMessage, MeasurementSetup, OnlineStatus, IUserSettings, IWorkspacePaneData, FixedPosFrameIdentifier } from '../models';
 /**
  * Possible CanKing event channels for an extension to listen to.
  */
@@ -63,6 +63,35 @@ export declare const DevicesContext: React.Context<Device[]>;
  * @internal
  */
 export declare const MeasurementStatusContext: React.Context<NodeStatus[]>;
+/**
+ * Calculates a unique subscription key for a given frame identifier.
+ * @param identifier - The frame identifier.
+ * @returns The subscription key.
+ * @internal
+ */
+export declare const calculateSubscriptionKey: (identifier: FixedPosFrameIdentifier) => string;
+/**
+ * Subscribes to measurement data for the given frame identifiers.
+ * @param identifiers - The frame identifiers to subscribe to.
+ * @internal
+ */
+export declare const subscribeToData: (identifiers: FixedPosFrameIdentifier[]) => void;
+/**
+ * Unsubscribes from measurement data for the given frame identifiers.
+ * @param identifiers - The frame identifiers to unsubscribe from.
+ * @internal
+ */
+export declare const unsubscribeFromData: (identifiers: FixedPosFrameIdentifier[]) => void;
+interface IMeasurementData {
+    scrollData: Frame[];
+    fixedPositionData: Frame[];
+    subscribedData: Map<string, Frame[]>;
+}
+/**
+ * The MeasurementData context
+ * @internal
+ */
+export declare const MeasurementDataContext: React.Context<IMeasurementData>;
 /**
  * The MeasurementSetup context
  * @internal
@@ -106,7 +135,7 @@ export declare const WorkspacePanesContext: React.Context<[IWorkspacePaneData[],
  * );
  * ```
  *
- * @param props Component properties.
+ * @param props - Component properties.
  * @returns The CanKingDataProvider React component.
  */
 declare const CanKingDataProvider: ({ initialUserSettings, children, }: {

package/dist/controls/CheckboxControl.d.ts

@@ -11,7 +11,7 @@ export interface CheckboxControlProps {
     checked: boolean;
     /**
      * Callback that is called when the checked state has changed.
-     * @param checked The new checked state.
+     * @param checked - The new checked state.
      */
     onChange: (checked: boolean) => void;
     /** Set to true to disable this control. */
@@ -23,7 +23,7 @@ export interface CheckboxControlProps {
 }
 /**
  * Creates a checkbox UI control.
- * @param props Component properties.
+ * @param props - Component properties.
  * @returns The CheckboxControl React component.
  */
 declare function CheckboxControl({ id, label, checked, onChange, disabled, size, sx, }: CheckboxControlProps): import("react/jsx-runtime").JSX.Element;

package/dist/controls/ColumnItemControl.d.ts

@@ -20,7 +20,7 @@ export interface ColumnItem {
 export declare const useColumnItem: () => ColumnItem;
 /**
  * Calculate max width from all specified column items as soon as all items have widths values.
- * @param columnItems All column items to set width for.
+ * @param columnItems - All column items to set width for.
  * @returns The max width, the width to use
  */
 export declare const useColumnItems: (...columnItems: ColumnItem[]) => number;

package/dist/controls/ContextMenu.d.ts

@@ -29,7 +29,7 @@ export interface ContextMenuProps {
     options: ContextMenuOption[];
     /**
      * A callback that will be called when the user selects one of the menu items in this context menu.
-     * @param value Value of the selected menu option.
+     * @param value - Value of the selected menu option.
      */
     onSelect: (value: number) => void;
     /** Children nodes that will be using this context menu. */
@@ -37,7 +37,7 @@ export interface ContextMenuProps {
 }
 /**
  * Creates a context menu UI control.
- * @param props Component properties.
+ * @param props - Component properties.
  * @returns The ContextMenu React component.
  */
 declare function ContextMenu({ options, onSelect, children }: ContextMenuProps): import("react/jsx-runtime").JSX.Element;

package/dist/controls/DropdownButton.d.ts

@@ -31,13 +31,13 @@ export interface DropdownButtonTextItemsProps extends DropdownButtonChildrenProp
     }[];
     /**
      * Callback that is called when the user selects one of the drop down items.
-     * @param itemKey The key of the selected item.
+     * @param itemKey - The key of the selected item.
      */
     onSelect: (itemKey: string, itemText?: string) => void;
 }
 /**
  * Creates a drop down control that displays a menu with text strings.
- * @param props Component properties.
+ * @param props - Component properties.
  * @returns The DropdownButtonTextItems React component.
  */
 export declare function DropdownButtonTextItems({ items, onSelect, onClose }: DropdownButtonTextItemsProps): import("react/jsx-runtime").JSX.Element;
@@ -66,7 +66,7 @@ export interface DropdownButtonProps {
 }
 /**
  * Creates a drop down button control.
- * @param props Component properties.
+ * @param props - Component properties.
  * @returns The DropdownButton React component.
  */
 declare function DropdownButton({ id, startIcon, endIcon, text, variant, color, size, disabled, children, }: DropdownButtonProps): import("react/jsx-runtime").JSX.Element;

package/dist/controls/DropdownPanel.d.ts

@@ -34,7 +34,7 @@ export interface DropdownPanelProps {
 }
 /**
  * Creates a drop down panel control.
- * @param props Component properties.
+ * @param props - Component properties.
  * @returns The DropdownPanel React component.
  */
 declare function DropdownPanel({ id, position, parentWidth, parentHeight, maxLength, dropDownSize, autoHideTimeout, forceShow, children, }: DropdownPanelProps): import("react/jsx-runtime").JSX.Element;

package/dist/controls/FormControlRow.d.ts

@@ -23,7 +23,7 @@ export interface FormControlRowProps {
 }
 /**
  * Creates a form control row.
- * @param props Component properties.
+ * @param props - Component properties.
  * @returns The FormControlRow React component.
  */
 declare function FormControlRow({ children, fullWidth, spacing, alignItems, }: React.PropsWithChildren<FormControlRowProps>): import("react/jsx-runtime").JSX.Element;

package/dist/controls/InlineEditor.d.ts

@@ -9,7 +9,7 @@ export interface InlineEditorProps {
     value: string;
     /**
      * Callback that will be called when the value has been changed.
-     * @param value The new value.
+     * @param value - The new value.
      */
     onValueChange: (value: string) => void;
     /** An aria label. */
@@ -19,7 +19,7 @@ export interface InlineEditorProps {
 }
 /**
  * Creates an inline editor.
- * @param props Component properties.
+ * @param props - Component properties.
  * @returns The InlineEditor React component.
  */
 declare function InlineEditor({ editMode, value, onValueChange, ariaLabel, variant }: InlineEditorProps): import("react/jsx-runtime").JSX.Element;

package/dist/controls/LinChannelSelectControl.d.ts

@@ -8,7 +8,7 @@ export interface LinChannelSelectControlProps {
     selectMasterChannels: boolean;
     /**
      * Callback that will be called when a new channel has been selected.
-     * @param identifier The new channel identifier.
+     * @param identifier - The new channel identifier.
      */
     onChannelIdentifierChange: (identifier: string) => void;
     /** Set to true if this control shouldn't be encapsulated inside a SectionControl. */
@@ -21,13 +21,13 @@ export interface LinChannelSelectControlProps {
     collapsed?: boolean;
     /**
      * Callback that will be called when collapse state has changed.
-     * @param value The new collapse state.
+     * @param value - The new collapse state.
      */
     collapsedChange?: (value: boolean) => void;
 }
 /**
  * Creates an UI control for selecting a LIN channel from the current measurement setup.
- * @param props Component properties.
+ * @param props - Component properties.
  * @returns The LinChannelSelectControl React component.
  */
 declare function LinChannelSelectControl({ channelIdentifier, selectMasterChannels, onChannelIdentifierChange, hideSectionControl, disabled, collapsible, collapsed, collapsedChange, }: LinChannelSelectControlProps): import("react/jsx-runtime").JSX.Element;