@oicl/openbridge-webcomponents-svelte 2.0.0-next.159 → 2.0.0-next.160

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (170) hide show
  1. package/README.md +1 -1
  2. package/dist/automation/analog-valve/ObcAnalogValve.svelte +4 -4
  3. package/dist/automation/automation-button/ObcAbstractAutomationButton.svelte +4 -4
  4. package/dist/automation/automation-button/ObcAbstractAutomationButtonMotorized.svelte +4 -4
  5. package/dist/automation/automation-button/ObcAbstractAutomationButtonSquared.svelte +4 -4
  6. package/dist/automation/automation-tank/ObcAutomationTank.svelte +10 -65
  7. package/dist/automation/automation-tank/ObcAutomationTank.svelte.d.ts +5 -60
  8. package/dist/automation/bipolar-transistor/ObcBipolarTransistor.svelte +4 -4
  9. package/dist/automation/capacitor/ObcCapacitor.svelte +4 -4
  10. package/dist/automation/converter/ObcConverter.svelte +4 -4
  11. package/dist/automation/damper/ObcDamper.svelte +4 -4
  12. package/dist/automation/digital-valve/ObcDigitalValve.svelte +4 -4
  13. package/dist/automation/diodes/ObcDiodes.svelte +4 -4
  14. package/dist/automation/fan/ObcFan.svelte +4 -4
  15. package/dist/automation/filter/ObcFilter.svelte +4 -4
  16. package/dist/automation/ground/ObcGround.svelte +4 -4
  17. package/dist/automation/logic/ObcLogic.svelte +4 -4
  18. package/dist/automation/mosfet/ObcMosfet.svelte +4 -4
  19. package/dist/automation/motor/ObcMotor.svelte +4 -4
  20. package/dist/automation/pump/ObcPump.svelte +4 -4
  21. package/dist/automation/resistor/ObcResistor.svelte +4 -4
  22. package/dist/automation/router/ObcRouter.svelte +4 -4
  23. package/dist/automation/source/ObcSource.svelte +4 -4
  24. package/dist/automation/switch/ObcSwitch.svelte +4 -4
  25. package/dist/automation/transformer/ObcTransformer.svelte +4 -4
  26. package/dist/bars-graphs/area-graph/ObcAreaGraph.svelte +4 -21
  27. package/dist/bars-graphs/area-graph/ObcAreaGraph.svelte.d.ts +2 -19
  28. package/dist/bars-graphs/line-graph/ObcLineGraph.svelte +2 -16
  29. package/dist/bars-graphs/line-graph/ObcLineGraph.svelte.d.ts +1 -15
  30. package/dist/building-blocks/chart-line/ObcChartLineBase.svelte +2 -16
  31. package/dist/building-blocks/chart-line/ObcChartLineBase.svelte.d.ts +1 -15
  32. package/dist/building-blocks/circular-progress/ObcCircularProgress.svelte +9 -0
  33. package/dist/building-blocks/circular-progress/ObcCircularProgress.svelte.d.ts +9 -0
  34. package/dist/building-blocks/single-axis-inclinometer/SingleAxisInclinometer.svelte +1 -10
  35. package/dist/building-blocks/single-axis-inclinometer/SingleAxisInclinometer.svelte.d.ts +0 -9
  36. package/dist/components/accordion-card/ObcAccordionCard.svelte +4 -10
  37. package/dist/components/accordion-card/ObcAccordionCard.svelte.d.ts +2 -8
  38. package/dist/components/advice-button/ObcAdviceButton.svelte +6 -6
  39. package/dist/components/advice-button/ObcAdviceButton.svelte.d.ts +5 -5
  40. package/dist/components/advice-floating-item/ObcAdviceFloatingItem.svelte +6 -15
  41. package/dist/components/advice-floating-item/ObcAdviceFloatingItem.svelte.d.ts +3 -12
  42. package/dist/components/advice-message-item/ObcAdviceMessageItem.svelte +4 -14
  43. package/dist/components/advice-message-item/ObcAdviceMessageItem.svelte.d.ts +2 -12
  44. package/dist/components/alert-frame/ObcAlertFrame.svelte +8 -23
  45. package/dist/components/alert-frame/ObcAlertFrame.svelte.d.ts +4 -19
  46. package/dist/components/alert-menu/ObcAlertMenu.svelte +8 -20
  47. package/dist/components/alert-menu/ObcAlertMenu.svelte.d.ts +4 -16
  48. package/dist/components/alert-menu-item/ObcAlertMenuItem.svelte +4 -4
  49. package/dist/components/alert-menu-item/ObcAlertMenuItem.svelte.d.ts +2 -2
  50. package/dist/components/app-button/ObcAppButton.svelte +6 -2
  51. package/dist/components/app-button/ObcAppButton.svelte.d.ts +5 -1
  52. package/dist/components/badge/ObcBadge.svelte +16 -28
  53. package/dist/components/badge/ObcBadge.svelte.d.ts +10 -22
  54. package/dist/components/breadcrumb/ObcBreadcrumb.svelte +2 -6
  55. package/dist/components/breadcrumb/ObcBreadcrumb.svelte.d.ts +1 -5
  56. package/dist/components/button/ObcButton.svelte +4 -11
  57. package/dist/components/button/ObcButton.svelte.d.ts +2 -9
  58. package/dist/components/card/ObcCard.svelte +14 -12
  59. package/dist/components/card/ObcCard.svelte.d.ts +11 -9
  60. package/dist/components/check-button/ObcCheckButton.svelte +4 -8
  61. package/dist/components/check-button/ObcCheckButton.svelte.d.ts +2 -6
  62. package/dist/components/checkbox/ObcCheckbox.svelte +6 -13
  63. package/dist/components/checkbox/ObcCheckbox.svelte.d.ts +3 -10
  64. package/dist/components/command-button/ObcCommandButton.svelte +2 -7
  65. package/dist/components/command-button/ObcCommandButton.svelte.d.ts +1 -6
  66. package/dist/components/context-menu-input/ObcContextMenuInput.svelte +24 -42
  67. package/dist/components/context-menu-input/ObcContextMenuInput.svelte.d.ts +16 -34
  68. package/dist/components/date-item/ObcDateItem.svelte +2 -4
  69. package/dist/components/date-item/ObcDateItem.svelte.d.ts +1 -3
  70. package/dist/components/dropdown-button/ObcDropdownButton.svelte +4 -13
  71. package/dist/components/dropdown-button/ObcDropdownButton.svelte.d.ts +2 -11
  72. package/dist/components/elevated-card/ObcElevatedCard.svelte +6 -19
  73. package/dist/components/elevated-card/ObcElevatedCard.svelte.d.ts +3 -16
  74. package/dist/components/elevated-card-radio-group/ObcElevatedCardRadioGroup.svelte +4 -8
  75. package/dist/components/elevated-card-radio-group/ObcElevatedCardRadioGroup.svelte.d.ts +2 -6
  76. package/dist/components/event-list/ObcEventList.svelte +2 -2
  77. package/dist/components/event-list/ObcEventList.svelte.d.ts +1 -1
  78. package/dist/components/floating-item/ObcFloatingItem.svelte +6 -18
  79. package/dist/components/floating-item/ObcFloatingItem.svelte.d.ts +3 -15
  80. package/dist/components/icon-button/ObcIconButton.svelte +2 -5
  81. package/dist/components/icon-button/ObcIconButton.svelte.d.ts +1 -4
  82. package/dist/components/icon-check-button/ObcIconCheckButton.svelte +16 -24
  83. package/dist/components/icon-check-button/ObcIconCheckButton.svelte.d.ts +10 -18
  84. package/dist/components/menu-button/ObcMenuButton.svelte +4 -17
  85. package/dist/components/menu-button/ObcMenuButton.svelte.d.ts +2 -15
  86. package/dist/components/navigation-item/ObcNavigationItem.svelte +2 -2
  87. package/dist/components/navigation-item/ObcNavigationItem.svelte.d.ts +1 -1
  88. package/dist/components/navigation-item-group/ObcNavigationItemGroup.svelte +2 -2
  89. package/dist/components/navigation-item-group/ObcNavigationItemGroup.svelte.d.ts +1 -1
  90. package/dist/components/navigation-menu/ObcNavigationMenu.svelte +2 -8
  91. package/dist/components/navigation-menu/ObcNavigationMenu.svelte.d.ts +1 -7
  92. package/dist/components/notification-badge-button/ObcNotificationBadgeButton.svelte +2 -2
  93. package/dist/components/notification-badge-button/ObcNotificationBadgeButton.svelte.d.ts +2 -2
  94. package/dist/components/notification-button/ObcNotificationButton.svelte +22 -35
  95. package/dist/components/notification-button/ObcNotificationButton.svelte.d.ts +17 -30
  96. package/dist/components/notification-floating-item/ObcNotificationFloatingItem.svelte +6 -15
  97. package/dist/components/notification-floating-item/ObcNotificationFloatingItem.svelte.d.ts +3 -12
  98. package/dist/components/notification-message-item/ObcNotificationMessageItem.svelte +4 -10
  99. package/dist/components/notification-message-item/ObcNotificationMessageItem.svelte.d.ts +2 -8
  100. package/dist/components/pagination/ObcPagination.svelte +8 -26
  101. package/dist/components/pagination/ObcPagination.svelte.d.ts +4 -22
  102. package/dist/components/pivot-item/ObcPivotItem.svelte +14 -29
  103. package/dist/components/pivot-item/ObcPivotItem.svelte.d.ts +7 -22
  104. package/dist/components/progress-bar/ObcProgressBar.svelte +6 -5
  105. package/dist/components/progress-bar/ObcProgressBar.svelte.d.ts +5 -4
  106. package/dist/components/rich-button/ObcRichButton.svelte +2 -4
  107. package/dist/components/rich-button/ObcRichButton.svelte.d.ts +1 -3
  108. package/dist/components/slider/ObcSlider.svelte +32 -46
  109. package/dist/components/slider/ObcSlider.svelte.d.ts +22 -36
  110. package/dist/components/slider-double/ObcSliderDouble.svelte +7 -21
  111. package/dist/components/slider-double/ObcSliderDouble.svelte.d.ts +4 -18
  112. package/dist/components/start-stop-switch/ObcStartStopSwitch.svelte +18 -48
  113. package/dist/components/start-stop-switch/ObcStartStopSwitch.svelte.d.ts +11 -41
  114. package/dist/components/stepper-box/ObcStepperBox.svelte +2 -7
  115. package/dist/components/stepper-box/ObcStepperBox.svelte.d.ts +1 -6
  116. package/dist/components/system-button/ObcSystemButton.svelte +4 -14
  117. package/dist/components/system-button/ObcSystemButton.svelte.d.ts +2 -12
  118. package/dist/components/tab-item/ObcTabItem.svelte +30 -66
  119. package/dist/components/tab-item/ObcTabItem.svelte.d.ts +17 -53
  120. package/dist/components/tab-row/ObcTabRow.svelte +12 -36
  121. package/dist/components/tab-row/ObcTabRow.svelte.d.ts +6 -30
  122. package/dist/components/toggle-button-group/ObcToggleButtonGroup.svelte +18 -54
  123. package/dist/components/toggle-button-group/ObcToggleButtonGroup.svelte.d.ts +9 -45
  124. package/dist/components/toggle-button-vertical-group/ObcToggleButtonVerticalGroup.svelte +10 -26
  125. package/dist/components/toggle-button-vertical-group/ObcToggleButtonVerticalGroup.svelte.d.ts +5 -21
  126. package/dist/components/toggle-button-vertical-option/ObcToggleButtonVerticalOption.svelte +2 -4
  127. package/dist/components/toggle-button-vertical-option/ObcToggleButtonVerticalOption.svelte.d.ts +1 -3
  128. package/dist/components/toggletip/ObcToggletip.svelte +2 -10
  129. package/dist/components/toggletip/ObcToggletip.svelte.d.ts +1 -9
  130. package/dist/components/tooltip/ObcTooltip.svelte +16 -28
  131. package/dist/components/tooltip/ObcTooltip.svelte.d.ts +12 -24
  132. package/dist/components/top-bar/ObcTopBar.svelte +84 -48
  133. package/dist/components/top-bar/ObcTopBar.svelte.d.ts +45 -9
  134. package/dist/components/topbar-message-item/ObcTopbarMessageItem.svelte +4 -16
  135. package/dist/components/topbar-message-item/ObcTopbarMessageItem.svelte.d.ts +2 -14
  136. package/dist/components/tree-navigation-group/ObcTreeNavigationGroup.svelte +2 -2
  137. package/dist/components/tree-navigation-group/ObcTreeNavigationGroup.svelte.d.ts +1 -1
  138. package/dist/components/tree-navigation-item/ObcTreeNavigationItem.svelte +2 -2
  139. package/dist/components/tree-navigation-item/ObcTreeNavigationItem.svelte.d.ts +1 -1
  140. package/dist/components/user-button/ObcUserButton.svelte +6 -13
  141. package/dist/components/user-button/ObcUserButton.svelte.d.ts +3 -10
  142. package/dist/components/vendor-button/ObcVendorButton.svelte +4 -8
  143. package/dist/components/vendor-button/ObcVendorButton.svelte.d.ts +2 -6
  144. package/dist/integration-systems/integration-dropdown-button/ObcIntegrationDropdownButton.svelte +2 -8
  145. package/dist/integration-systems/integration-dropdown-button/ObcIntegrationDropdownButton.svelte.d.ts +1 -7
  146. package/dist/navigation-instruments/compass/ObcCompass.svelte +6 -8
  147. package/dist/navigation-instruments/compass/ObcCompass.svelte.d.ts +5 -7
  148. package/dist/navigation-instruments/compass-indicator/ObcCompassIndicator.svelte +2 -7
  149. package/dist/navigation-instruments/compass-indicator/ObcCompassIndicator.svelte.d.ts +1 -6
  150. package/dist/navigation-instruments/compass-sector/ObcCompassSector.svelte +6 -7
  151. package/dist/navigation-instruments/compass-sector/ObcCompassSector.svelte.d.ts +5 -6
  152. package/dist/navigation-instruments/gauge-radial/ObcGaugeRadial.svelte +12 -23
  153. package/dist/navigation-instruments/gauge-radial/ObcGaugeRadial.svelte.d.ts +5 -16
  154. package/dist/navigation-instruments/gauge-trend/ObcGaugeTrend.svelte +28 -51
  155. package/dist/navigation-instruments/gauge-trend/ObcGaugeTrend.svelte.d.ts +22 -45
  156. package/dist/navigation-instruments/pitch/ObcPitch.svelte +2 -10
  157. package/dist/navigation-instruments/pitch/ObcPitch.svelte.d.ts +1 -9
  158. package/dist/navigation-instruments/pitch-roll/ObcPitchRoll.svelte +4 -4
  159. package/dist/navigation-instruments/pitch-roll/ObcPitchRoll.svelte.d.ts +2 -2
  160. package/dist/navigation-instruments/roll/ObcRoll.svelte +2 -10
  161. package/dist/navigation-instruments/roll/ObcRoll.svelte.d.ts +1 -9
  162. package/dist/navigation-instruments/rot-indicator/ObcRotIndicator.svelte +2 -6
  163. package/dist/navigation-instruments/rot-indicator/ObcRotIndicator.svelte.d.ts +1 -5
  164. package/dist/navigation-instruments/rot-sector/ObcRotSector.svelte +16 -20
  165. package/dist/navigation-instruments/rot-sector/ObcRotSector.svelte.d.ts +4 -8
  166. package/dist/navigation-instruments/speed-gauge/ObcSpeedGauge.svelte +14 -20
  167. package/dist/navigation-instruments/speed-gauge/ObcSpeedGauge.svelte.d.ts +3 -9
  168. package/dist/navigation-instruments/wind-indicator/ObcWindIndicator.svelte +6 -22
  169. package/dist/navigation-instruments/wind-indicator/ObcWindIndicator.svelte.d.ts +3 -19
  170. package/package.json +2 -2
@@ -7,25 +7,57 @@ export interface Props {
7
7
  style?: string;
8
8
  /** Sets the main application title displayed in the top bar. */
9
9
  appTitle?: string;
10
- /** Sets the current page or section name displayed in the top bar. */
10
+ /**
11
+ * Sets the current page or section name displayed in the top bar.
12
+ *
13
+ * Available when `settings==false`.
14
+ */
11
15
  pageName?: string;
12
16
  /** Available when `settings==false && inactive==false`. */
13
17
  menuButtonIcon?: ObcTopBarMenuButtonIcon;
14
- /** Highlights the menu button as active. */
18
+ /**
19
+ * Highlights the menu button as active.
20
+ *
21
+ * Available when `settings==false && inactive==false`.
22
+ */
15
23
  menuButtonActivated?: boolean;
16
- /** Highlights the dimming (day/night) button as active. */
24
+ /**
25
+ * Highlights the dimming (day/night) button as active.
26
+ *
27
+ * Available when `showDimmingButton==true && inactive==false`.
28
+ */
17
29
  dimmingButtonActivated?: boolean;
18
- /** Highlights the apps button as active. */
30
+ /**
31
+ * Highlights the apps button as active.
32
+ *
33
+ * Available when `showAppsButton==true && inactive==false`.
34
+ */
19
35
  appsButtonActivated?: boolean;
20
- /** Highlights the left more button as active. */
36
+ /**
37
+ * Highlights the left more button as active.
38
+ *
39
+ * Available when `inactive==false`.
40
+ */
21
41
  leftMoreButtonActivated?: boolean;
22
- /** Highlights the user/profile button as active. */
42
+ /**
43
+ * Highlights the user/profile button as active.
44
+ *
45
+ * Available when `showUserButton==true && inactive==false`.
46
+ */
23
47
  userButtonActivated?: boolean;
24
- /** Disables the user/profile button. */
48
+ /**
49
+ * Disables the user/profile button.
50
+ *
51
+ * Available when `showUserButton==true && inactive==false`.
52
+ */
25
53
  userButtonDisabled?: boolean;
26
54
  /** Increases the height of the top bar for larger touch targets. */
27
55
  tall?: boolean;
28
- /** Expands the menu button for wide-rail layouts. */
56
+ /**
57
+ * Expands the menu button for wide-rail layouts.
58
+ *
59
+ * Available when `settings==false && inactive==false`.
60
+ */
29
61
  wideMenuButton?: boolean;
30
62
  /** Shows or hides the apps button. */
31
63
  showAppsButton?: boolean;
@@ -53,7 +85,11 @@ export interface Props {
53
85
  appIconBreakpointPx?: number;
54
86
  /** Enables settings mode, displaying close, back buttons, breadcrumbs, and app title. */
55
87
  settings?: boolean;
56
- /** Array of breadcrumb items for navigation (used in settings mode). */
88
+ /**
89
+ * Array of breadcrumb items for navigation (used in settings mode).
90
+ *
91
+ * Available when `settings==true`.
92
+ */
57
93
  breadcrumbItems?: BreadcrumbItem[];
58
94
  }
59
95
  export interface Events {
@@ -10,22 +10,10 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** Controls the visual and interactive type of the message item.
14
-
15
- - `simple`: No action button, just message content.
16
- - `with-button`: Shows a text-based action button.
17
- - `with-icon-button`: Shows an icon-based action button.
18
- - `inactive`: Shows an empty/inactive state.
19
-
20
- Defaults to `with-button`. */
21
- type?: ObcTopbarMessageItemType;
22
- /** Sets the vertical size of the message item.
23
-
24
- - `regular`: Standard compact height.
25
- - `tall`: Expanded height for more content.
26
-
27
- Defaults to `regular`. */
28
- size?: ObcTopbarMessageItemSize;
13
+ /** Visual and interactive type: `simple` is message content alone, `with-button` (default) adds a text action button, `with-icon-button` an icon action button, and `inactive` shows the empty state. */
14
+ type?: ObcTopbarMessageItemType;
15
+ /** Vertical size: `regular` (default) is the compact height, `tall` the expanded one. */
16
+ size?: ObcTopbarMessageItemSize;
29
17
  /**
30
18
  * Whether to show the title slot.
31
19
  *
@@ -4,21 +4,9 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** Controls the visual and interactive type of the message item.
8
-
9
- - `simple`: No action button, just message content.
10
- - `with-button`: Shows a text-based action button.
11
- - `with-icon-button`: Shows an icon-based action button.
12
- - `inactive`: Shows an empty/inactive state.
13
-
14
- Defaults to `with-button`. */
7
+ /** Visual and interactive type: `simple` is message content alone, `with-button` (default) adds a text action button, `with-icon-button` an icon action button, and `inactive` shows the empty state. */
15
8
  type?: ObcTopbarMessageItemType;
16
- /** Sets the vertical size of the message item.
17
-
18
- - `regular`: Standard compact height.
19
- - `tall`: Expanded height for more content.
20
-
21
- Defaults to `regular`. */
9
+ /** Vertical size: `regular` (default) is the compact height, `tall` the expanded one. */
22
10
  size?: ObcTopbarMessageItemSize;
23
11
  /**
24
12
  * Whether to show the title slot.
@@ -24,8 +24,8 @@
24
24
  hasIcon?: boolean;
25
25
  /** Terminal type for the header row, controlling the alert-header marker shown in the terminal. One of `regular` (default), `aggregated-header`, or `group-header`. */
26
26
  terminalType?: string;
27
- /** [object Object],[object Object],[object Object] */
28
- alerts?: TreeNavigationItemAlerts | undefined;
27
+ /** Per-severity alert counts shown as trailing badges on the header row while the group is collapsed; expanding it hides them, since the rows then carry their own. A group usually sets `combine` so its header shows one badge totalling the alerts of the rows beneath it. */
28
+ alerts?: TreeNavigationItemAlerts | undefined;
29
29
  /** The URL to navigate to when the header is activated. If set, the header row renders as a link; otherwise it acts as a button. */
30
30
  href?: string | undefined
31
31
  }
@@ -18,7 +18,7 @@ export interface Props {
18
18
  hasIcon?: boolean;
19
19
  /** Terminal type for the header row, controlling the alert-header marker shown in the terminal. One of `regular` (default), `aggregated-header`, or `group-header`. */
20
20
  terminalType?: string;
21
- /** [object Object],[object Object],[object Object] */
21
+ /** Per-severity alert counts shown as trailing badges on the header row while the group is collapsed; expanding it hides them, since the rows then carry their own. A group usually sets `combine` so its header shows one badge totalling the alerts of the rows beneath it. */
22
22
  alerts?: TreeNavigationItemAlerts | undefined;
23
23
  /** The URL to navigate to when the header is activated. If set, the header row renders as a link; otherwise it acts as a button. */
24
24
  href?: string | undefined;
@@ -28,8 +28,8 @@
28
28
  hasLeadingIcon?: boolean;
29
29
  /** Terminal type, controlling the alert-header marker shown in the terminal. One of `regular` (default), `aggregated-header`, or `group-header`. */
30
30
  terminalType?: string;
31
- /** [object Object],[object Object],[object Object] */
32
- alerts?: TreeNavigationItemAlerts | undefined;
31
+ /** Per-severity alert counts for the row's trailing badges; omit it, or leave every count at 0, for a row with no alerts. Its `combine` flag collapses them into one badge carrying the total and the highest severity present; otherwise each non-zero count gets its own badge, ordered most to least severe. */
32
+ alerts?: TreeNavigationItemAlerts | undefined;
33
33
  /** The URL to navigate to when the row is activated. If set, the row renders as a link; otherwise it acts as a button. */
34
34
  href?: string | undefined
35
35
  }
@@ -22,7 +22,7 @@ export interface Props {
22
22
  hasLeadingIcon?: boolean;
23
23
  /** Terminal type, controlling the alert-header marker shown in the terminal. One of `regular` (default), `aggregated-header`, or `group-header`. */
24
24
  terminalType?: string;
25
- /** [object Object],[object Object],[object Object] */
25
+ /** Per-severity alert counts for the row's trailing badges; omit it, or leave every count at 0, for a row with no alerts. Its `combine` flag collapses them into one badge carrying the total and the highest severity present; otherwise each non-zero count gets its own badge, ordered most to least severe. */
26
26
  alerts?: TreeNavigationItemAlerts | undefined;
27
27
  /** The URL to navigate to when the row is activated. If set, the row renders as a link; otherwise it acts as a button. */
28
28
  href?: string | undefined;
@@ -10,16 +10,11 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** Controls whether the button displays a user icon (`icon`) or user initials (`initials`).
14
- - `icon`: Shows a user icon (default, or if initials are invalid).
15
- - `initials`: Shows up to two uppercase initials (falls back to icon if empty or longer than two characters). */
16
- variant?: Variant;
13
+ /** What the button displays: `icon` (default) a user icon, `initials` up to two uppercase initials — falling back to the icon when `initials` is empty or longer than two characters. */
14
+ variant?: Variant;
17
15
  size?: Size;
18
- /** Sets the visual style of the button.
19
- - `flat`: Minimal, flat appearance (default).
20
- - `normal`: Outlined with background and border.
21
- - `selected`: Highlighted to indicate selection or active state. */
22
- styleType?: StyleType;
16
+ /** Visual style: `flat` (default) is the minimal appearance, `normal` adds a background and border, `selected` highlights the active state. */
17
+ styleType?: StyleType;
23
18
  /** If true, renders the button as a static (non-interactive) element using a `<div>`. Use for decorative or read-only contexts where user interaction is not required. */
24
19
  static?: boolean;
25
20
  /**
@@ -28,10 +23,8 @@ styleType?: StyleType;
28
23
  * Available when `static==false`.
29
24
  */
30
25
  disabled?: boolean;
31
- /** The initials to display when `variant="initials"`.
32
- - Only the first two non-whitespace characters are used and converted to uppercase.
33
- - If empty or longer than two characters, falls back to the user icon. */
34
- initials?: string;
26
+ /** Initials shown when `variant` is `initials`. Whitespace is stripped and the rest uppercased, then truncated to two characters — three at the `large` size. An empty value falls back to the user icon. */
27
+ initials?: string;
35
28
  /**
36
29
  * Optional label text to display next to the button (not shown in static mode).
37
30
  *
@@ -4,15 +4,10 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** Controls whether the button displays a user icon (`icon`) or user initials (`initials`).
8
- - `icon`: Shows a user icon (default, or if initials are invalid).
9
- - `initials`: Shows up to two uppercase initials (falls back to icon if empty or longer than two characters). */
7
+ /** What the button displays: `icon` (default) a user icon, `initials` up to two uppercase initials — falling back to the icon when `initials` is empty or longer than two characters. */
10
8
  variant?: Variant;
11
9
  size?: Size;
12
- /** Sets the visual style of the button.
13
- - `flat`: Minimal, flat appearance (default).
14
- - `normal`: Outlined with background and border.
15
- - `selected`: Highlighted to indicate selection or active state. */
10
+ /** Visual style: `flat` (default) is the minimal appearance, `normal` adds a background and border, `selected` highlights the active state. */
16
11
  styleType?: StyleType;
17
12
  /** If true, renders the button as a static (non-interactive) element using a `<div>`. Use for decorative or read-only contexts where user interaction is not required. */
18
13
  static?: boolean;
@@ -22,9 +17,7 @@ export interface Props {
22
17
  * Available when `static==false`.
23
18
  */
24
19
  disabled?: boolean;
25
- /** The initials to display when `variant="initials"`.
26
- - Only the first two non-whitespace characters are used and converted to uppercase.
27
- - If empty or longer than two characters, falls back to the user icon. */
20
+ /** Initials shown when `variant` is `initials`. Whitespace is stripped and the rest uppercased, then truncated to two characters — three at the `large` size. An empty value falls back to the user icon. */
28
21
  initials?: string;
29
22
  /**
30
23
  * Optional label text to display next to the button (not shown in static mode).
@@ -9,14 +9,10 @@
9
9
  export interface Props {
10
10
  class?: string;
11
11
  style?: string;
12
- /** The URL of the image to display as the button's content.
13
-
14
- Typically this should be a logo or brand image representing a vendor or external service. */
15
- imageSrc?: string;
16
- /** Alternative text for the image, used for accessibility.
17
-
18
- This should describe the logo or vendor for screen readers. */
19
- alt?: string
12
+ /** The URL of the image to display as the button's content. Typically this should be a logo or brand image representing a vendor or external service. */
13
+ imageSrc?: string;
14
+ /** Alternative text for the image, used for accessibility. This should describe the logo or vendor for screen readers. */
15
+ alt?: string
20
16
  }
21
17
  export interface Events {
22
18
  onClick?: (event: CustomEvent<unknown>) => void
@@ -3,13 +3,9 @@ import type { Snippet } from 'svelte';
3
3
  export interface Props {
4
4
  class?: string;
5
5
  style?: string;
6
- /** The URL of the image to display as the button's content.
7
-
8
- Typically this should be a logo or brand image representing a vendor or external service. */
6
+ /** The URL of the image to display as the button's content. Typically this should be a logo or brand image representing a vendor or external service. */
9
7
  imageSrc?: string;
10
- /** Alternative text for the image, used for accessibility.
11
-
12
- This should describe the logo or vendor for screen readers. */
8
+ /** Alternative text for the image, used for accessibility. This should describe the logo or vendor for screen readers. */
13
9
  alt?: string;
14
10
  }
15
11
  export interface Events {
@@ -10,14 +10,8 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** List of selectable options. Each option is an object with a `value` (string), `label` (string), `icon` (HTMLTemplateResult), and optional `disabled` (boolean).
14
-
15
- Example:
16
- [
17
- { value: 'volvo', label: 'Volvo', icon: html`<obi-ship></obi-ship>` },
18
- { value: 'xc90', label: 'XC 90', icon: html`<obi-ship></obi-ship>` }
19
- ] */
20
- options?: IntegrationDropdownOption[];
13
+ /** Selectable options, each with a `value`, a `label`, an `icon` template and optional `status` text and `disabled` flag. */
14
+ options?: IntegrationDropdownOption[];
21
15
  hasFleet?: boolean;
22
16
  fleetLabel?: string;
23
17
  /** The value of the currently selected option. */
@@ -4,13 +4,7 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** List of selectable options. Each option is an object with a `value` (string), `label` (string), `icon` (HTMLTemplateResult), and optional `disabled` (boolean).
8
-
9
- Example:
10
- [
11
- { value: 'volvo', label: 'Volvo', icon: html`<obi-ship></obi-ship>` },
12
- { value: 'xc90', label: 'XC 90', icon: html`<obi-ship></obi-ship>` }
13
- ] */
7
+ /** Selectable options, each with a `value`, a `label`, an `icon` template and optional `status` text and `disabled` flag. */
14
8
  options?: IntegrationDropdownOption[];
15
9
  hasFleet?: boolean;
16
10
  fleetLabel?: string;
@@ -112,14 +112,12 @@ rotationsPerMinute?: number;
112
112
  rotType?: RotType;
113
113
  /** ROT track position: `'innerCircle'` (default) or `'scale'` (on the outer ring). */
114
114
  rotPosition?: RotPosition;
115
- /** Bar-extent reference value in **degrees per minute**. The bar fills the
116
- full ±`rotArcExtent` arc when the measured ROT equals ±`rotMaxValue`.
117
- Default `60` aligns with ES-TRIN 2025/1 Art. 3.02.
118
-
119
- Note: prior to the introduction of `rateOfTurnDegreesPerMinute` this
120
- property was interpreted in rotations per minute. The unit changed when
121
- the physical ROT API was introduced. */
122
- rotMaxValue?: number;
115
+ /**
116
+ * Bar-extent reference value in degrees per minute: the bar fills the full ±`rotArcExtent` arc when the measured rate of turn reaches ±`rotMaxValue`. The default `60` aligns with ES-TRIN 2025/1 Art. 3.02.
117
+ *
118
+ * Available when `rotType==bar`.
119
+ */
120
+ rotMaxValue?: number;
123
121
  /** Available when `rotType==bar`. */
124
122
  rotArcExtent?: number;
125
123
  rotPortStarboard?: boolean;
@@ -102,13 +102,11 @@ and the bar extent. */
102
102
  rotType?: RotType;
103
103
  /** ROT track position: `'innerCircle'` (default) or `'scale'` (on the outer ring). */
104
104
  rotPosition?: RotPosition;
105
- /** Bar-extent reference value in **degrees per minute**. The bar fills the
106
- full ±`rotArcExtent` arc when the measured ROT equals ±`rotMaxValue`.
107
- Default `60` aligns with ES-TRIN 2025/1 Art. 3.02.
108
-
109
- Note: prior to the introduction of `rateOfTurnDegreesPerMinute` this
110
- property was interpreted in rotations per minute. The unit changed when
111
- the physical ROT API was introduced. */
105
+ /**
106
+ * Bar-extent reference value in degrees per minute: the bar fills the full ±`rotArcExtent` arc when the measured rate of turn reaches ±`rotMaxValue`. The default `60` aligns with ES-TRIN 2025/1 Art. 3.02.
107
+ *
108
+ * Available when `rotType==bar`.
109
+ */
112
110
  rotMaxValue?: number;
113
111
  /** Available when `rotType==bar`. */
114
112
  rotArcExtent?: number;
@@ -12,13 +12,8 @@
12
12
  angle?: number;
13
13
  type?: CompassIndicatorType;
14
14
  direction?: CompassIndicatorDirection;
15
- /** When `true` (default) the compass face stays north-up and the arrow
16
- rotates by `angle`. When `false` the arrow stays pointing up and the
17
- compass face rotates instead (heading-up / course-up presentation).
18
-
19
- Declared with `attribute: false` because the default is `true`; set it
20
- via the JavaScript property (or framework binding) to opt out. */
21
- northUp?: boolean
15
+ /** When `true` (default) the compass face stays north-up and the arrow rotates by `angle`; when `false` the arrow stays pointing up and the face rotates instead, the heading-up presentation. */
16
+ northUp?: boolean
22
17
  }
23
18
  export interface Events {
24
19
 
@@ -7,12 +7,7 @@ export interface Props {
7
7
  angle?: number;
8
8
  type?: CompassIndicatorType;
9
9
  direction?: CompassIndicatorDirection;
10
- /** When `true` (default) the compass face stays north-up and the arrow
11
- rotates by `angle`. When `false` the arrow stays pointing up and the
12
- compass face rotates instead (heading-up / course-up presentation).
13
-
14
- Declared with `attribute: false` because the default is `true`; set it
15
- via the JavaScript property (or framework binding) to opt out. */
10
+ /** When `true` (default) the compass face stays north-up and the arrow rotates by `angle`; when `false` the arrow stays pointing up and the face rotates instead, the heading-up presentation. */
16
11
  northUp?: boolean;
17
12
  }
18
13
  export interface Events {
@@ -53,13 +53,12 @@ import type {CompassSectorPriorityElement} from '@oicl/openbridge-webcomponents/
53
53
  rotDotAnimationFactor?: number;
54
54
  /** Available when `rotType!=undefined && rateOfTurnDegreesPerMinute==undefined`. */
55
55
  rotationsPerMinute?: number;
56
- /** Bar-extent reference value in **degrees per minute**. The bar fills the
57
- full ±`ARC_HALF_EXTENT` arc when the measured ROT equals
58
- ±`rotMaxValue`. Default `60` aligns with ES-TRIN 2025/1 Art. 3.02.
59
-
60
- Note: the unit changed from rotations per minute to degrees per minute
61
- with the introduction of `rateOfTurnDegreesPerMinute`. */
62
- rotMaxValue?: number;
56
+ /**
57
+ * Bar-extent reference value in degrees per minute: the bar fills the full ±`ARC_HALF_EXTENT` arc when the measured rate of turn reaches ±`rotMaxValue`. The default `60` aligns with ES-TRIN 2025/1 Art. 3.02.
58
+ *
59
+ * Available when `rotType==bar`.
60
+ */
61
+ rotMaxValue?: number;
63
62
  /** Available when `rotType!=undefined`. */
64
63
  rotPortStarboard?: boolean;
65
64
  /** Available when `rotType==bar`. */
@@ -45,12 +45,11 @@ export interface Props {
45
45
  rotDotAnimationFactor?: number;
46
46
  /** Available when `rotType!=undefined && rateOfTurnDegreesPerMinute==undefined`. */
47
47
  rotationsPerMinute?: number;
48
- /** Bar-extent reference value in **degrees per minute**. The bar fills the
49
- full ±`ARC_HALF_EXTENT` arc when the measured ROT equals
50
- ±`rotMaxValue`. Default `60` aligns with ES-TRIN 2025/1 Art. 3.02.
51
-
52
- Note: the unit changed from rotations per minute to degrees per minute
53
- with the introduction of `rateOfTurnDegreesPerMinute`. */
48
+ /**
49
+ * Bar-extent reference value in degrees per minute: the bar fills the full ±`ARC_HALF_EXTENT` arc when the measured rate of turn reaches ±`rotMaxValue`. The default `60` aligns with ES-TRIN 2025/1 Art. 3.02.
50
+ *
51
+ * Available when `rotType==bar`.
52
+ */
54
53
  rotMaxValue?: number;
55
54
  /** Available when `rotType!=undefined`. */
56
55
  rotPortStarboard?: boolean;
@@ -40,38 +40,27 @@ animateSetpoint?: boolean;
40
40
  showLabels?: boolean;
41
41
  primaryTickmarkInterval?: number;
42
42
  secondaryTickmarkInterval?: number;
43
- /** Interval for tertiary tickmarks in value units.
44
- When undefined or <= 0, no tertiary tickmarks are shown. */
45
- tertiaryTickmarkInterval?: number | undefined;
43
+ /** Interval for tertiary tickmarks in value units. When undefined or <= 0, no tertiary tickmarks are shown. */
44
+ tertiaryTickmarkInterval?: number | undefined;
46
45
  state?: InstrumentState;
47
46
  priority?: Priority;
48
47
  type?: ObcGaugeRadialType;
49
48
  tickmarksInside?: boolean;
50
49
  tickmarkStyle?: TickmarkStyle;
51
- /** Caution/alert arcs. Ignored on `sector: 90-left` / `90-right`. */
52
- advices?: GaugeRadialAdvice[];
50
+ /** Caution/alert arcs. Ignored on `sector: 90-left` / `90-right`. */
51
+ advices?: GaugeRadialAdvice[];
53
52
  sector?: GaugeRadialSector;
54
- /** Horizontal placement of the dial when the host is wider than the dial
55
- (e.g. a short, wide container shrinks the dial to fit the height, leaving
56
- horizontal slack). Default `center`. */
57
- horizontalAlignment?: GaugeRadialHorizontalAlignment;
58
- /** Vertical placement of the dial when the host is taller than the dial
59
- (e.g. a tall, narrow container shrinks the dial to fit the width, leaving
60
- vertical slack). Default `center`. */
61
- verticalAlignment?: GaugeRadialVerticalAlignment;
62
- /** When `true`, shows the centre `<obc-readout>`(s) with the current value
63
- (and optional `label`/`unit`). Layout depends on `sector` and `type`.
64
- Default `false`. */
65
- hasReadout?: boolean;
53
+ /** Horizontal placement of the dial when the host is wider than the dial (e.g. a short, wide container shrinks the dial to fit the height, leaving horizontal slack). Default `center`. */
54
+ horizontalAlignment?: GaugeRadialHorizontalAlignment;
55
+ /** Vertical placement of the dial when the host is taller than the dial (e.g. a tall, narrow container shrinks the dial to fit the width, leaving vertical slack). Default `center`. */
56
+ verticalAlignment?: GaugeRadialVerticalAlignment;
57
+ /** When `true`, shows the centre `<obc-readout>`(s) with the current value (and optional `label`/`unit`). Layout depends on `sector` and `type`. Default `false`. */
58
+ hasReadout?: boolean;
66
59
  label?: string;
67
60
  unit?: string;
68
61
  fractionDigits?: number;
69
- /** Outer-ring diameter in CSS pixels. When set, the instrument renders at a
70
- fixed intrinsic size derived from the ring, arc shape and label reserve —
71
- so instruments sharing the same value have identical ring circumference
72
- regardless of label width or arc extent (like obc-donut-chart's
73
- fixedHeight). When unset (default), the instrument fills its container. */
74
- faceDiameter?: number | undefined
62
+ /** Outer-ring diameter in CSS pixels. When set, the instrument renders at a fixed intrinsic size derived from the ring, arc shape and label reserve — so instruments sharing the same value have identical ring circumference regardless of label width or arc extent (like obc-donut-chart's fixedHeight). When unset (default), the instrument fills its container. */
63
+ faceDiameter?: number | undefined
75
64
  }
76
65
  export interface Events {
77
66
 
@@ -33,8 +33,7 @@ regardless of instrument state. */
33
33
  showLabels?: boolean;
34
34
  primaryTickmarkInterval?: number;
35
35
  secondaryTickmarkInterval?: number;
36
- /** Interval for tertiary tickmarks in value units.
37
- When undefined or <= 0, no tertiary tickmarks are shown. */
36
+ /** Interval for tertiary tickmarks in value units. When undefined or <= 0, no tertiary tickmarks are shown. */
38
37
  tertiaryTickmarkInterval?: number | undefined;
39
38
  state?: InstrumentState;
40
39
  priority?: Priority;
@@ -44,26 +43,16 @@ When undefined or <= 0, no tertiary tickmarks are shown. */
44
43
  /** Caution/alert arcs. Ignored on `sector: 90-left` / `90-right`. */
45
44
  advices?: GaugeRadialAdvice[];
46
45
  sector?: GaugeRadialSector;
47
- /** Horizontal placement of the dial when the host is wider than the dial
48
- (e.g. a short, wide container shrinks the dial to fit the height, leaving
49
- horizontal slack). Default `center`. */
46
+ /** Horizontal placement of the dial when the host is wider than the dial (e.g. a short, wide container shrinks the dial to fit the height, leaving horizontal slack). Default `center`. */
50
47
  horizontalAlignment?: GaugeRadialHorizontalAlignment;
51
- /** Vertical placement of the dial when the host is taller than the dial
52
- (e.g. a tall, narrow container shrinks the dial to fit the width, leaving
53
- vertical slack). Default `center`. */
48
+ /** Vertical placement of the dial when the host is taller than the dial (e.g. a tall, narrow container shrinks the dial to fit the width, leaving vertical slack). Default `center`. */
54
49
  verticalAlignment?: GaugeRadialVerticalAlignment;
55
- /** When `true`, shows the centre `<obc-readout>`(s) with the current value
56
- (and optional `label`/`unit`). Layout depends on `sector` and `type`.
57
- Default `false`. */
50
+ /** When `true`, shows the centre `<obc-readout>`(s) with the current value (and optional `label`/`unit`). Layout depends on `sector` and `type`. Default `false`. */
58
51
  hasReadout?: boolean;
59
52
  label?: string;
60
53
  unit?: string;
61
54
  fractionDigits?: number;
62
- /** Outer-ring diameter in CSS pixels. When set, the instrument renders at a
63
- fixed intrinsic size derived from the ring, arc shape and label reserve —
64
- so instruments sharing the same value have identical ring circumference
65
- regardless of label width or arc extent (like obc-donut-chart's
66
- fixedHeight). When unset (default), the instrument fills its container. */
55
+ /** Outer-ring diameter in CSS pixels. When set, the instrument renders at a fixed intrinsic size derived from the ring, arc shape and label reserve — so instruments sharing the same value have identical ring circumference regardless of label width or arc extent (like obc-donut-chart's fixedHeight). When unset (default), the instrument fills its container. */
67
56
  faceDiameter?: number | undefined;
68
57
  }
69
58
  export interface Events {