@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
@@ -4,42 +4,18 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** The list of tabs to display. Each tab is defined by an object with properties such as `id`, `title`, `subtitle`, `showSubtitle`, `hasLeadingIcon`, `hasBadge`, `badgeCount`, `badgeType`, `badgeSize`, `badgeShowNumber`, `showLeadingBadgeIcon`, and `disabled`.
8
-
9
- - `id` (string): Unique identifier for the tab.
10
- - `title` (string): Display label for the tab.
11
- - `subtitle` (string): Contextual text shown below the title when subtitle display is enabled.
12
- - `showSubtitle` (boolean): Optional per-tab override for displaying the subtitle.
13
- - `hasLeadingIcon` (boolean): Whether to show a leading icon (default: true).
14
- - `badges` (TabItemBadge[]): One or more badges to display on the tab. Takes precedence over the deprecated single-badge fields below.
15
- - `hasBadge` (boolean, deprecated): Whether to show a badge on the tab.
16
- - `badgeCount` (number, deprecated): Number to display in the badge.
17
- - `badgeType` (BadgeType, deprecated): Visual style of the badge (e.g., notification, alarm, enhance).
18
- - `badgeSize` (BadgeSize, deprecated): Size of the badge (e.g., regular, large).
19
- - `badgeShowNumber` (boolean, deprecated): If true, shows the badge number.
20
- - `showLeadingBadgeIcon` (boolean, deprecated): If true, shows a badge icon.
21
- - `disabled` (boolean): If true, disables the tab. */
7
+ /** Tabs to display. Each carries a unique `id`, a `title`, an optional `subtitle` with a per-tab `showSubtitle` override, `hasLeadingIcon`, `disabled`, and a `badges` array that takes precedence over the deprecated single-badge fields (`hasBadge`, `badgeCount`, `badgeType`, `badgeSize`, `badgeShowNumber`, `showLeadingBadgeIcon`). */
22
8
  tabs?: TabData[];
23
- /** The `id` of the currently selected tab. Only one tab can be selected at a time.
24
-
25
- Changing this property updates the selected tab visually and emits the `tab-selected` event when changed by user interaction. */
9
+ /** The `id` of the currently selected tab. Only one tab can be selected at a time. Changing this property updates the selected tab visually and emits the `tab-selected` event when changed by user interaction. */
26
10
  selectedTabId?: string;
27
- /** Whether to display a close button on each tab. When enabled, users can remove tabs individually.
28
-
29
- Default: `false`. */
11
+ /** Whether to display a close button on each tab. When enabled, users can remove tabs individually. */
30
12
  hasClose?: boolean;
31
13
  centerContent?: boolean;
32
- /** Enables "hug" mode for a more compact tab layout with reduced padding.
33
-
34
- Default: `false`. */
14
+ /** Enables "hug" mode for a more compact tab layout with reduced padding. */
35
15
  hug?: boolean;
36
- /** Whether to display subtitle text for each tab. Individual tabs can override this with `tab.showSubtitle`.
37
-
38
- Default: `false`. */
16
+ /** Whether to display subtitle text for each tab. Individual tabs can override this with `tab.showSubtitle`. */
39
17
  showSubtitle?: boolean;
40
- /** Whether to display an "add new tab" button at the end of the tab row. When clicked, emits the `add-new-tab` event.
41
-
42
- Default: `false`. */
18
+ /** Whether to display an "add new tab" button at the end of the tab row. When clicked, emits the `add-new-tab` event. */
43
19
  hasAddNewTab?: boolean;
44
20
  }
45
21
  export interface Events {
@@ -9,60 +9,24 @@
9
9
  export interface Props {
10
10
  class?: string;
11
11
  style?: string;
12
- /** The currently selected option's value.
13
-
14
- Set this property to programmatically select an option. When the user selects a different option, this property updates and a `value` event is fired.
15
-
16
- If set to a value that does not match any enabled option, the first enabled option is selected by default. */
17
- value?: string;
18
- /** The value of the option that is activated.
19
-
20
- When the group is controlled by an external source, this property is used to set the value of the option that is activated.
21
- This is a visual indication that the option is clicked but not yet stored. */
22
- activated?: string | undefined;
23
- /** The visual type of the toggle button options.
24
-
25
- - `text` (default): Options display text only.
26
- - `icon`: Options display only an icon.
27
- - `iconText`: Options display an icon and text side-by-side.
28
- - `iconTextUnder`: Options display an icon above the text.
29
-
30
- This setting is propagated to all child `<obc-toggle-button-option>` elements. */
31
- type?: ObcToggleButtonOptionType;
32
- /** The visual variant of the toggle button group.
33
-
34
- - `regular` (default): Standard appearance with background and border.
35
- - `flat`: Minimal style with no background or border.
36
- - `normal`: Alternative style variant.
37
-
38
- This setting is propagated to all child `<obc-toggle-button-option>` elements. */
39
- variant?: ObcToggleButtonOptionVariant;
40
- /** If true, the group shrinks to fit its content ("hug" the text) instead of stretching to fill the container.
41
-
42
- This setting is propagated to all child `<obc-toggle-button-option>` elements. */
43
- hugText?: boolean;
44
- /** If true, the group is controlled by an external source.
45
-
46
- When true, the group will not update its selection when the `value` property changes.
47
-
48
- Defaults to false. */
49
- externalControl?: boolean;
50
- /** If true, a `value` that does not match any enabled option leaves the group with no option selected
51
- instead of defaulting to the first enabled option.
52
-
53
- This also applies when the currently selected option becomes disabled: the group clears its selection
54
- rather than falling back to another option.
55
-
56
- Defaults to false (the first enabled option is selected when the value does not match). */
57
- allowEmptySelection?: boolean;
58
- /** Disables the entire toggle button group and all contained options when true.
59
-
60
- When disabled, no option can be selected or interacted with. */
61
- disabled?: boolean;
62
- /** If true, the group and all contained options use a larger size.
63
-
64
- This setting is propagated to all child `<obc-toggle-button-option>` elements. */
65
- large?: boolean
12
+ /** The currently selected option's value. Set this property to programmatically select an option. When the user selects a different option, this property updates and a `value` event is fired. If set to a value that does not match any enabled option, the first enabled option is selected by default. */
13
+ value?: string;
14
+ /** The value of the option that is activated. When the group is controlled by an external source, this property is used to set the value of the option that is activated. This is a visual indication that the option is clicked but not yet stored. */
15
+ activated?: string | undefined;
16
+ /** Visual type of the options, propagated to every child `<obc-toggle-button-option>`: `text` (default) is text only, `icon` an icon only, `iconText` an icon beside the text, `iconTextUnder` an icon above it. */
17
+ type?: ObcToggleButtonOptionType;
18
+ /** Visual variant, propagated to every child `<obc-toggle-button-option>`: `regular` (default) has a background and border, `flat` has neither, and `normal` is the alternative style. */
19
+ variant?: ObcToggleButtonOptionVariant;
20
+ /** If true, the group shrinks to fit its content ("hug" the text) instead of stretching to fill the container. This setting is propagated to all child `<obc-toggle-button-option>` elements. */
21
+ hugText?: boolean;
22
+ /** Makes a click emit `selected` without moving the selection, so the parent decides by setting `value`. Setting `value` programmatically always updates the selection, with or without this flag. When true, the group will not update its selection when the `value` property changes. Defaults to false. */
23
+ externalControl?: boolean;
24
+ /** Lets the group hold no selection: a `value` matching no enabled option, or a selected option that becomes disabled, clears the selection instead of falling back to the first enabled option. */
25
+ allowEmptySelection?: boolean;
26
+ /** Disables the entire toggle button group and all contained options when true. When disabled, no option can be selected or interacted with. */
27
+ disabled?: boolean;
28
+ /** If true, the group and all contained options use a larger size. This setting is propagated to all child `<obc-toggle-button-option>` elements. */
29
+ large?: boolean
66
30
  }
67
31
  export interface Events {
68
32
  onValue?: (event: CustomEvent<{value: string, previousValue: string}>) => void;
@@ -4,59 +4,23 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** The currently selected option's value.
8
-
9
- Set this property to programmatically select an option. When the user selects a different option, this property updates and a `value` event is fired.
10
-
11
- If set to a value that does not match any enabled option, the first enabled option is selected by default. */
7
+ /** The currently selected option's value. Set this property to programmatically select an option. When the user selects a different option, this property updates and a `value` event is fired. If set to a value that does not match any enabled option, the first enabled option is selected by default. */
12
8
  value?: string;
13
- /** The value of the option that is activated.
14
-
15
- When the group is controlled by an external source, this property is used to set the value of the option that is activated.
16
- This is a visual indication that the option is clicked but not yet stored. */
9
+ /** The value of the option that is activated. When the group is controlled by an external source, this property is used to set the value of the option that is activated. This is a visual indication that the option is clicked but not yet stored. */
17
10
  activated?: string | undefined;
18
- /** The visual type of the toggle button options.
19
-
20
- - `text` (default): Options display text only.
21
- - `icon`: Options display only an icon.
22
- - `iconText`: Options display an icon and text side-by-side.
23
- - `iconTextUnder`: Options display an icon above the text.
24
-
25
- This setting is propagated to all child `<obc-toggle-button-option>` elements. */
11
+ /** Visual type of the options, propagated to every child `<obc-toggle-button-option>`: `text` (default) is text only, `icon` an icon only, `iconText` an icon beside the text, `iconTextUnder` an icon above it. */
26
12
  type?: ObcToggleButtonOptionType;
27
- /** The visual variant of the toggle button group.
28
-
29
- - `regular` (default): Standard appearance with background and border.
30
- - `flat`: Minimal style with no background or border.
31
- - `normal`: Alternative style variant.
32
-
33
- This setting is propagated to all child `<obc-toggle-button-option>` elements. */
13
+ /** Visual variant, propagated to every child `<obc-toggle-button-option>`: `regular` (default) has a background and border, `flat` has neither, and `normal` is the alternative style. */
34
14
  variant?: ObcToggleButtonOptionVariant;
35
- /** If true, the group shrinks to fit its content ("hug" the text) instead of stretching to fill the container.
36
-
37
- This setting is propagated to all child `<obc-toggle-button-option>` elements. */
15
+ /** If true, the group shrinks to fit its content ("hug" the text) instead of stretching to fill the container. This setting is propagated to all child `<obc-toggle-button-option>` elements. */
38
16
  hugText?: boolean;
39
- /** If true, the group is controlled by an external source.
40
-
41
- When true, the group will not update its selection when the `value` property changes.
42
-
43
- Defaults to false. */
17
+ /** Makes a click emit `selected` without moving the selection, so the parent decides by setting `value`. Setting `value` programmatically always updates the selection, with or without this flag. When true, the group will not update its selection when the `value` property changes. Defaults to false. */
44
18
  externalControl?: boolean;
45
- /** If true, a `value` that does not match any enabled option leaves the group with no option selected
46
- instead of defaulting to the first enabled option.
47
-
48
- This also applies when the currently selected option becomes disabled: the group clears its selection
49
- rather than falling back to another option.
50
-
51
- Defaults to false (the first enabled option is selected when the value does not match). */
19
+ /** Lets the group hold no selection: a `value` matching no enabled option, or a selected option that becomes disabled, clears the selection instead of falling back to the first enabled option. */
52
20
  allowEmptySelection?: boolean;
53
- /** Disables the entire toggle button group and all contained options when true.
54
-
55
- When disabled, no option can be selected or interacted with. */
21
+ /** Disables the entire toggle button group and all contained options when true. When disabled, no option can be selected or interacted with. */
56
22
  disabled?: boolean;
57
- /** If true, the group and all contained options use a larger size.
58
-
59
- This setting is propagated to all child `<obc-toggle-button-option>` elements. */
23
+ /** If true, the group and all contained options use a larger size. This setting is propagated to all child `<obc-toggle-button-option>` elements. */
60
24
  large?: boolean;
61
25
  }
62
26
  export interface Events {
@@ -9,32 +9,16 @@
9
9
  export interface Props {
10
10
  class?: string;
11
11
  style?: string;
12
- /** The value of the currently selected option.
13
-
14
- Setting this property programmatically updates the selection. If the value does not match any enabled option, the group selects the first available enabled option. */
15
- value?: string;
16
- /** Visual style for all options in the group.
17
-
18
- One of: "flat", "regular", "normal". */
19
- type?: ObcToggleButtonVerticalOptionType;
20
- /** If true, the group shrinks to fit its content width instead of stretching to fill its container.
21
-
22
- Defaults to false. */
23
- hugWidth?: boolean;
24
- /** If true, a `value` that does not match any enabled option leaves the group with no option selected
25
- instead of defaulting to the first enabled option.
26
-
27
- This also applies when the currently selected option becomes disabled: the group clears its selection
28
- rather than falling back to another option.
29
-
30
- Defaults to false (the first enabled option is selected when the value does not match). */
31
- allowEmptySelection?: boolean;
32
- /** Disables the entire group and all contained options.
33
-
34
- When set to true, all options become non-interactive, regardless of their individual disabled state.
35
-
36
- Defaults to false. */
37
- disabled?: boolean
12
+ /** The value of the currently selected option. Setting this property programmatically updates the selection. If the value does not match any enabled option, the group selects the first available enabled option. */
13
+ value?: string;
14
+ /** Visual style for all options in the group. One of: "flat", "regular", "normal". */
15
+ type?: ObcToggleButtonVerticalOptionType;
16
+ /** If true, the group shrinks to fit its content width instead of stretching to fill its container. Defaults to false. */
17
+ hugWidth?: boolean;
18
+ /** Lets the group hold no selection: a `value` matching no enabled option, or a selected option that becomes disabled, clears the selection instead of falling back to the first enabled option. */
19
+ allowEmptySelection?: boolean;
20
+ /** Disables the entire group and all contained options. When set to true, all options become non-interactive, regardless of their individual disabled state. Defaults to false. */
21
+ disabled?: boolean
38
22
  }
39
23
  export interface Events {
40
24
  onValue?: (event: CustomEvent<{value: string, previousValue: string}>) => void;
@@ -4,31 +4,15 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** The value of the currently selected option.
8
-
9
- Setting this property programmatically updates the selection. If the value does not match any enabled option, the group selects the first available enabled option. */
7
+ /** The value of the currently selected option. Setting this property programmatically updates the selection. If the value does not match any enabled option, the group selects the first available enabled option. */
10
8
  value?: string;
11
- /** Visual style for all options in the group.
12
-
13
- One of: "flat", "regular", "normal". */
9
+ /** Visual style for all options in the group. One of: "flat", "regular", "normal". */
14
10
  type?: ObcToggleButtonVerticalOptionType;
15
- /** If true, the group shrinks to fit its content width instead of stretching to fill its container.
16
-
17
- Defaults to false. */
11
+ /** If true, the group shrinks to fit its content width instead of stretching to fill its container. Defaults to false. */
18
12
  hugWidth?: boolean;
19
- /** If true, a `value` that does not match any enabled option leaves the group with no option selected
20
- instead of defaulting to the first enabled option.
21
-
22
- This also applies when the currently selected option becomes disabled: the group clears its selection
23
- rather than falling back to another option.
24
-
25
- Defaults to false (the first enabled option is selected when the value does not match). */
13
+ /** Lets the group hold no selection: a `value` matching no enabled option, or a selected option that becomes disabled, clears the selection instead of falling back to the first enabled option. */
26
14
  allowEmptySelection?: boolean;
27
- /** Disables the entire group and all contained options.
28
-
29
- When set to true, all options become non-interactive, regardless of their individual disabled state.
30
-
31
- Defaults to false. */
15
+ /** Disables the entire group and all contained options. When set to true, all options become non-interactive, regardless of their individual disabled state. Defaults to false. */
32
16
  disabled?: boolean;
33
17
  }
34
18
  export interface Events {
@@ -24,10 +24,8 @@
24
24
  label?: string;
25
25
  /** If true, the option is disabled and cannot be interacted with. */
26
26
  disabled?: boolean;
27
- /** Controls the layout of icon and label.
28
- - `inline`: Icon and label displayed side-by-side.
29
- - `under`: Label displayed below the icon. */
30
- labelPlacement?: ObcToggleButtonLabelPlacement
27
+ /** Layout of icon and label: `inline` puts them side-by-side, `under` puts the label below the icon. */
28
+ labelPlacement?: ObcToggleButtonLabelPlacement
31
29
  }
32
30
  export interface Events {
33
31
  onSelected?: (event: CustomEvent<{value: string}>) => void
@@ -18,9 +18,7 @@ export interface Props {
18
18
  label?: string;
19
19
  /** If true, the option is disabled and cannot be interacted with. */
20
20
  disabled?: boolean;
21
- /** Controls the layout of icon and label.
22
- - `inline`: Icon and label displayed side-by-side.
23
- - `under`: Label displayed below the icon. */
21
+ /** Layout of icon and label: `inline` puts them side-by-side, `under` puts the label below the icon. */
24
22
  labelPlacement?: ObcToggleButtonLabelPlacement;
25
23
  }
26
24
  export interface Events {
@@ -10,16 +10,8 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** Visual style and semantic meaning of the toggletip.
14
-
15
- - `normal` (default): Standard informational toggletip.
16
- - `raised`: Elevated importance with dark header.
17
- - `enhanced`: Used for enhanced or primary information.
18
- - `eco-feedback`: Environmental or positive feedback messaging.
19
- - `caution`: Indicates caution or minor issues.
20
- - `warning`: Highlights warnings or potential problems.
21
- - `alarm`: Signals critical or urgent conditions. */
22
- variant?: ToggletipVariant;
13
+ /** Visual style and meaning: `normal` (default) is informational, `raised` carries a dark header for higher importance, `enhanced` marks primary information, `eco-feedback` positive environmental feedback, and `caution`, `warning` and `alarm` the three alert severities. */
14
+ variant?: ToggletipVariant;
23
15
  /** Title text displayed in the header. */
24
16
  title?: string;
25
17
  /** Description text shown in the content area. */
@@ -4,15 +4,7 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** Visual style and semantic meaning of the toggletip.
8
-
9
- - `normal` (default): Standard informational toggletip.
10
- - `raised`: Elevated importance with dark header.
11
- - `enhanced`: Used for enhanced or primary information.
12
- - `eco-feedback`: Environmental or positive feedback messaging.
13
- - `caution`: Indicates caution or minor issues.
14
- - `warning`: Highlights warnings or potential problems.
15
- - `alarm`: Signals critical or urgent conditions. */
7
+ /** Visual style and meaning: `normal` (default) is informational, `raised` carries a dark header for higher importance, `enhanced` marks primary information, `eco-feedback` positive environmental feedback, and `caution`, `warning` and `alarm` the three alert severities. */
16
8
  variant?: ToggletipVariant;
17
9
  /** Title text displayed in the header. */
18
10
  title?: string;
@@ -10,34 +10,22 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** Type of tooltip display.
14
-
15
- - `icon`: Shows only an icon.
16
- - `label`: Shows text with optional leading icon.
17
-
18
- Default: `label` */
19
- type?: TooltipType;
20
- /** Visual style and semantic meaning of the tooltip.
21
-
22
- - `normal` (default): Standard informational tooltip.
23
- - `enhanced`: Highlighted/important notification (blue).
24
- - `eco`: Environmental/positive state (green).
25
- - `raised`: Elevated/raised visual style.
26
- - `caution`: Indicates caution or minor issues (yellow).
27
- - `warning`: Highlights warnings or potential problems (orange).
28
- - `alarm`: Signals critical or urgent conditions (red).
29
-
30
- Default: `normal` */
31
- variant?: TooltipVariant;
32
- /** Text content displayed in the tooltip (only used when `type="label"`).
33
-
34
- Default: `'Label'` */
35
- label?: string;
36
- /** Whether to show the leading icon when `type="label"`.
37
- Has no effect when `type="icon"`.
38
-
39
- Default: `false` */
40
- showIcon?: boolean
13
+ /** Display type: `label` (default) shows text with an optional leading icon, `icon` shows the icon alone. */
14
+ type?: TooltipType;
15
+ /** Visual style and meaning: `normal` (default) is informational, `enhanced` is a highlighted blue notification, `eco` a green positive state, `raised` the elevated style, and `caution`, `warning` and `alarm` the yellow, orange and red alert severities. */
16
+ variant?: TooltipVariant;
17
+ /**
18
+ * Text content displayed in the tooltip (only used when `type="label"`).
19
+ *
20
+ * Available when `type==label`.
21
+ */
22
+ label?: string;
23
+ /**
24
+ * Whether to show the leading icon when `type="label"`. Has no effect when `type="icon"`.
25
+ *
26
+ * Available when `type==label`.
27
+ */
28
+ showIcon?: boolean
41
29
  }
42
30
  export interface Events {
43
31
 
@@ -4,33 +4,21 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** Type of tooltip display.
8
-
9
- - `icon`: Shows only an icon.
10
- - `label`: Shows text with optional leading icon.
11
-
12
- Default: `label` */
7
+ /** Display type: `label` (default) shows text with an optional leading icon, `icon` shows the icon alone. */
13
8
  type?: TooltipType;
14
- /** Visual style and semantic meaning of the tooltip.
15
-
16
- - `normal` (default): Standard informational tooltip.
17
- - `enhanced`: Highlighted/important notification (blue).
18
- - `eco`: Environmental/positive state (green).
19
- - `raised`: Elevated/raised visual style.
20
- - `caution`: Indicates caution or minor issues (yellow).
21
- - `warning`: Highlights warnings or potential problems (orange).
22
- - `alarm`: Signals critical or urgent conditions (red).
23
-
24
- Default: `normal` */
9
+ /** Visual style and meaning: `normal` (default) is informational, `enhanced` is a highlighted blue notification, `eco` a green positive state, `raised` the elevated style, and `caution`, `warning` and `alarm` the yellow, orange and red alert severities. */
25
10
  variant?: TooltipVariant;
26
- /** Text content displayed in the tooltip (only used when `type="label"`).
27
-
28
- Default: `'Label'` */
11
+ /**
12
+ * Text content displayed in the tooltip (only used when `type="label"`).
13
+ *
14
+ * Available when `type==label`.
15
+ */
29
16
  label?: string;
30
- /** Whether to show the leading icon when `type="label"`.
31
- Has no effect when `type="icon"`.
32
-
33
- Default: `false` */
17
+ /**
18
+ * Whether to show the leading icon when `type="label"`. Has no effect when `type="icon"`.
19
+ *
20
+ * Available when `type==label`.
21
+ */
34
22
  showIcon?: boolean;
35
23
  }
36
24
  export interface Events {
@@ -12,56 +12,92 @@ import type {ObcTopBarMenuButtonIcon} from '@oicl/openbridge-webcomponents/dist/
12
12
  export interface Props {
13
13
  class?: string;
14
14
  style?: string;
15
- /** Sets the main application title displayed in the top bar. */
16
- appTitle?: string;
17
- /** Sets the current page or section name displayed in the top bar. */
18
- pageName?: string;
15
+ /** Sets the main application title displayed in the top bar. */
16
+ appTitle?: string;
17
+ /**
18
+ * Sets the current page or section name displayed in the top bar.
19
+ *
20
+ * Available when `settings==false`.
21
+ */
22
+ pageName?: string;
19
23
  /** Available when `settings==false && inactive==false`. */
20
24
  menuButtonIcon?: ObcTopBarMenuButtonIcon;
21
- /** Highlights the menu button as active. */
22
- menuButtonActivated?: boolean;
23
- /** Highlights the dimming (day/night) button as active. */
24
- dimmingButtonActivated?: boolean;
25
- /** Highlights the apps button as active. */
26
- appsButtonActivated?: boolean;
27
- /** Highlights the left more button as active. */
28
- leftMoreButtonActivated?: boolean;
29
- /** Highlights the user/profile button as active. */
30
- userButtonActivated?: boolean;
31
- /** Disables the user/profile button. */
32
- userButtonDisabled?: boolean;
33
- /** Increases the height of the top bar for larger touch targets. */
34
- tall?: boolean;
35
- /** Expands the menu button for wide-rail layouts. */
36
- wideMenuButton?: boolean;
37
- /** Shows or hides the apps button. */
38
- showAppsButton?: boolean;
39
- /** Shows or hides the dimming (day/night) button. */
40
- showDimmingButton?: boolean;
41
- /** Shows or hides the user/profile button. */
42
- showUserButton?: boolean;
43
- /** Shows or hides the clock. */
44
- showClock?: boolean;
45
- /** Shows or hides the date in the clock display. */
46
- showDate?: boolean;
47
- /** Shows or hides the app icon slot. */
48
- showAppIcon?: boolean;
49
- /** Disables interaction and visually de-emphasizes the bar. */
50
- inactive?: boolean;
51
- /** Controls the breakpoint (in px) for showing/hiding the apps button. */
52
- appButtonBreakpointPx?: number;
53
- /** Controls the breakpoint (in px) for showing/hiding the dimming button. */
54
- dimmingButtonBreakpointPx?: number;
55
- /** Controls the breakpoint (in px) for showing/hiding the app title. */
56
- appTitleBreakpointPx?: number;
57
- /** Controls the breakpoint (in px) for showing/hiding the user button. */
58
- userButtonBreakpointPx?: number;
59
- /** Controls the breakpoint (in px) for showing/hiding the app icon. */
60
- appIconBreakpointPx?: number;
61
- /** Enables settings mode, displaying close, back buttons, breadcrumbs, and app title. */
62
- settings?: boolean;
63
- /** Array of breadcrumb items for navigation (used in settings mode). */
64
- breadcrumbItems?: BreadcrumbItem[]
25
+ /**
26
+ * Highlights the menu button as active.
27
+ *
28
+ * Available when `settings==false && inactive==false`.
29
+ */
30
+ menuButtonActivated?: boolean;
31
+ /**
32
+ * Highlights the dimming (day/night) button as active.
33
+ *
34
+ * Available when `showDimmingButton==true && inactive==false`.
35
+ */
36
+ dimmingButtonActivated?: boolean;
37
+ /**
38
+ * Highlights the apps button as active.
39
+ *
40
+ * Available when `showAppsButton==true && inactive==false`.
41
+ */
42
+ appsButtonActivated?: boolean;
43
+ /**
44
+ * Highlights the left more button as active.
45
+ *
46
+ * Available when `inactive==false`.
47
+ */
48
+ leftMoreButtonActivated?: boolean;
49
+ /**
50
+ * Highlights the user/profile button as active.
51
+ *
52
+ * Available when `showUserButton==true && inactive==false`.
53
+ */
54
+ userButtonActivated?: boolean;
55
+ /**
56
+ * Disables the user/profile button.
57
+ *
58
+ * Available when `showUserButton==true && inactive==false`.
59
+ */
60
+ userButtonDisabled?: boolean;
61
+ /** Increases the height of the top bar for larger touch targets. */
62
+ tall?: boolean;
63
+ /**
64
+ * Expands the menu button for wide-rail layouts.
65
+ *
66
+ * Available when `settings==false && inactive==false`.
67
+ */
68
+ wideMenuButton?: boolean;
69
+ /** Shows or hides the apps button. */
70
+ showAppsButton?: boolean;
71
+ /** Shows or hides the dimming (day/night) button. */
72
+ showDimmingButton?: boolean;
73
+ /** Shows or hides the user/profile button. */
74
+ showUserButton?: boolean;
75
+ /** Shows or hides the clock. */
76
+ showClock?: boolean;
77
+ /** Shows or hides the date in the clock display. */
78
+ showDate?: boolean;
79
+ /** Shows or hides the app icon slot. */
80
+ showAppIcon?: boolean;
81
+ /** Disables interaction and visually de-emphasizes the bar. */
82
+ inactive?: boolean;
83
+ /** Controls the breakpoint (in px) for showing/hiding the apps button. */
84
+ appButtonBreakpointPx?: number;
85
+ /** Controls the breakpoint (in px) for showing/hiding the dimming button. */
86
+ dimmingButtonBreakpointPx?: number;
87
+ /** Controls the breakpoint (in px) for showing/hiding the app title. */
88
+ appTitleBreakpointPx?: number;
89
+ /** Controls the breakpoint (in px) for showing/hiding the user button. */
90
+ userButtonBreakpointPx?: number;
91
+ /** Controls the breakpoint (in px) for showing/hiding the app icon. */
92
+ appIconBreakpointPx?: number;
93
+ /** Enables settings mode, displaying close, back buttons, breadcrumbs, and app title. */
94
+ settings?: boolean;
95
+ /**
96
+ * Array of breadcrumb items for navigation (used in settings mode).
97
+ *
98
+ * Available when `settings==true`.
99
+ */
100
+ breadcrumbItems?: BreadcrumbItem[]
65
101
  }
66
102
  export interface Events {
67
103
  onMenuButtonClicked?: (event: CustomEvent<unknown>) => void;