@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
@@ -9,9 +9,9 @@
9
9
  export interface Props {
10
10
  class?: string;
11
11
  style?: string;
12
- /** Removes the right border for seamless grouping with adjacent buttons. Use when this button is not the last in a horizontal group. */
12
+ /** Removes the right border so the button sits flush against the next one. Use when this button is not the last in a horizontal group. */
13
13
  openRight?: boolean;
14
- /** Removes the left border for seamless grouping with adjacent buttons. Use when this button is not the first in a horizontal group. */
14
+ /** Removes the left border so the button sits flush against the previous one. Use when this button is not the first in a horizontal group. */
15
15
  openLeft?: boolean;
16
16
  /** Applies rounded corners to the left side of the button. Use for the first button in a group or when aligning to a container's left edge. */
17
17
  cornerLeft?: boolean;
@@ -3,9 +3,9 @@ import type { Snippet } from 'svelte';
3
3
  export interface Props {
4
4
  class?: string;
5
5
  style?: string;
6
- /** Removes the right border for seamless grouping with adjacent buttons. Use when this button is not the last in a horizontal group. */
6
+ /** Removes the right border so the button sits flush against the next one. Use when this button is not the last in a horizontal group. */
7
7
  openRight?: boolean;
8
- /** Removes the left border for seamless grouping with adjacent buttons. Use when this button is not the first in a horizontal group. */
8
+ /** Removes the left border so the button sits flush against the previous one. Use when this button is not the first in a horizontal group. */
9
9
  openLeft?: boolean;
10
10
  /** Applies rounded corners to the left side of the button. Use for the first button in a group or when aligning to a container's left edge. */
11
11
  cornerLeft?: boolean;
@@ -10,41 +10,28 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** Visual style of the notification button.
14
-
15
- - `flat`: Minimal icon-only style. Counter is never shown.
16
- - `normal`: Standard notification button. Counter badge appears if `showCount` is true and `isActive` is true.
17
- - `enhanced`: Emphasized style with background and accent color. Counter badge appears if `showCount` is true and `isActive` is true.
18
-
19
- Defaults to `flat`. */
20
- buttonStyle?: NotificationButtonStyle;
21
- /** Number of notifications to display in the counter badge.
22
-
23
- Only shown if `showCount` is true, `isActive` is true, and `buttonStyle` is `normal` or `enhanced`.
24
- Ignored in `flat` style.
25
-
26
- Defaults to 0. */
27
- count?: number;
28
- /** Whether to display the notification count badge.
29
-
30
- If true, and the style is `normal` or `enhanced` and `isActive` is true, the counter badge is shown.
31
- Has no effect in `flat` style.
32
-
33
- Defaults to false. */
34
- showCount?: boolean;
35
- /** Whether the button is in the active (selected) state.
36
-
37
- When true, the button uses the filled notification icon and applies the selected style (`normal` or `enhanced`).
38
- When false, the button always appears in `flat` style with the outlined icon.
39
-
40
- Defaults to false. */
41
- isActive?: boolean;
42
- /** Accessibility label for the button.
43
-
44
- Used as the `aria-label` attribute for screen readers. If the counter is visible, the label will include the count (e.g., "Notifications, 5 new").
45
-
46
- Defaults to "Notifications". */
47
- ariaLabel?: string
13
+ /**
14
+ * Visual style: `flat` (default) is icon-only and never shows the counter, `normal` is the standard button and `enhanced` adds a background and accent colour — both show the counter badge while `showCount` and `isActive` are true.
15
+ *
16
+ * Available when `isActive==true`.
17
+ */
18
+ buttonStyle?: NotificationButtonStyle;
19
+ /**
20
+ * Number of notifications to display in the counter badge. Only shown if `showCount` is true, `isActive` is true, and `buttonStyle` is `normal` or `enhanced`. Ignored in `flat` style. Defaults to 0.
21
+ *
22
+ * Available when `isActive==true && showCount==true && buttonStyle in [Normal, Enhanced]`.
23
+ */
24
+ count?: number;
25
+ /**
26
+ * Whether to display the notification count badge. If true, and the style is `normal` or `enhanced` and `isActive` is true, the counter badge is shown. Has no effect in `flat` style. Defaults to false.
27
+ *
28
+ * Available when `isActive==true && buttonStyle in [Normal, Enhanced]`.
29
+ */
30
+ showCount?: boolean;
31
+ /** Whether the button is in the active (selected) state. When true, the button uses the filled notification icon and applies the selected style (`normal` or `enhanced`). When false, the button always appears in `flat` style with the outlined icon. Defaults to false. */
32
+ isActive?: boolean;
33
+ /** Accessibility label for the button. Used as the `aria-label` attribute for screen readers. If the counter is visible, the label will include the count (e.g., "Notifications, 5 new"). Defaults to "Notifications". */
34
+ ariaLabel?: string
48
35
  }
49
36
  export interface Events {
50
37
  onObcClick?: (event: CustomEvent<NotificationButtonClickEvent>) => void
@@ -4,40 +4,27 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** Visual style of the notification button.
8
-
9
- - `flat`: Minimal icon-only style. Counter is never shown.
10
- - `normal`: Standard notification button. Counter badge appears if `showCount` is true and `isActive` is true.
11
- - `enhanced`: Emphasized style with background and accent color. Counter badge appears if `showCount` is true and `isActive` is true.
12
-
13
- Defaults to `flat`. */
7
+ /**
8
+ * Visual style: `flat` (default) is icon-only and never shows the counter, `normal` is the standard button and `enhanced` adds a background and accent colour — both show the counter badge while `showCount` and `isActive` are true.
9
+ *
10
+ * Available when `isActive==true`.
11
+ */
14
12
  buttonStyle?: NotificationButtonStyle;
15
- /** Number of notifications to display in the counter badge.
16
-
17
- Only shown if `showCount` is true, `isActive` is true, and `buttonStyle` is `normal` or `enhanced`.
18
- Ignored in `flat` style.
19
-
20
- Defaults to 0. */
13
+ /**
14
+ * Number of notifications to display in the counter badge. Only shown if `showCount` is true, `isActive` is true, and `buttonStyle` is `normal` or `enhanced`. Ignored in `flat` style. Defaults to 0.
15
+ *
16
+ * Available when `isActive==true && showCount==true && buttonStyle in [Normal, Enhanced]`.
17
+ */
21
18
  count?: number;
22
- /** Whether to display the notification count badge.
23
-
24
- If true, and the style is `normal` or `enhanced` and `isActive` is true, the counter badge is shown.
25
- Has no effect in `flat` style.
26
-
27
- Defaults to false. */
19
+ /**
20
+ * Whether to display the notification count badge. If true, and the style is `normal` or `enhanced` and `isActive` is true, the counter badge is shown. Has no effect in `flat` style. Defaults to false.
21
+ *
22
+ * Available when `isActive==true && buttonStyle in [Normal, Enhanced]`.
23
+ */
28
24
  showCount?: boolean;
29
- /** Whether the button is in the active (selected) state.
30
-
31
- When true, the button uses the filled notification icon and applies the selected style (`normal` or `enhanced`).
32
- When false, the button always appears in `flat` style with the outlined icon.
33
-
34
- Defaults to false. */
25
+ /** Whether the button is in the active (selected) state. When true, the button uses the filled notification icon and applies the selected style (`normal` or `enhanced`). When false, the button always appears in `flat` style with the outlined icon. Defaults to false. */
35
26
  isActive?: boolean;
36
- /** Accessibility label for the button.
37
-
38
- Used as the `aria-label` attribute for screen readers. If the counter is visible, the label will include the count (e.g., "Notifications, 5 new").
39
-
40
- Defaults to "Notifications". */
27
+ /** Accessibility label for the button. Used as the `aria-label` attribute for screen readers. If the counter is visible, the label will include the count (e.g., "Notifications, 5 new"). Defaults to "Notifications". */
41
28
  ariaLabel?: string;
42
29
  }
43
30
  export interface Events {
@@ -10,16 +10,10 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** Defines the notification type.
14
- - `regular`: Standard notification appearance.
15
- - `application`: Application-level notification with additional icon.
16
- Default is `regular`. */
17
- type?: ObcFloatingItemType;
18
- /** Sets the layout direction of the notification.
19
- - `horizontal`: Content and actions are arranged side-by-side.
20
- - `vertical`: Content and actions are stacked.
21
- Default is `horizontal`. */
22
- direction?: ObcFloatingItemDirection;
13
+ /** Notification type: `regular` (default) is the standard appearance, `application` is the application-level one with a second icon. */
14
+ type?: ObcFloatingItemType;
15
+ /** Layout direction: `horizontal` (default) puts content and actions side-by-side, `vertical` stacks them. */
16
+ direction?: ObcFloatingItemDirection;
23
17
  /** If true, displays a timestamp label (e.g., "09:12:46") in the notification. Default is false. */
24
18
  hasTimestamp?: boolean;
25
19
  /** If true (and `hasTimestamp` is also true), displays a day label (e.g., "Yesterday") in the notification. Default is false. */
@@ -28,11 +22,8 @@ direction?: ObcFloatingItemDirection;
28
22
  action?: boolean;
29
23
  /** If true, displays a secondary action button (e.g., "Undo"). Only available if `action` is also true. Default is false. */
30
24
  action2?: boolean;
31
- /** Sets the line type for the notification content.
32
- - `singleLine`: Compact, single-line layout.
33
- - `multiLine`: Supports longer, multi-line descriptions.
34
- Default is `singleLine`. */
35
- lineType?: ObcFloatingItemLineType
25
+ /** Content line type: `single-line` (default) is the compact one-line layout, `multi-line` allows a longer description to wrap. */
26
+ lineType?: ObcFloatingItemLineType
36
27
  }
37
28
  export interface Events {
38
29
  onActionClick?: (event: CustomEvent<void>) => void;
@@ -4,15 +4,9 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** Defines the notification type.
8
- - `regular`: Standard notification appearance.
9
- - `application`: Application-level notification with additional icon.
10
- Default is `regular`. */
7
+ /** Notification type: `regular` (default) is the standard appearance, `application` is the application-level one with a second icon. */
11
8
  type?: ObcFloatingItemType;
12
- /** Sets the layout direction of the notification.
13
- - `horizontal`: Content and actions are arranged side-by-side.
14
- - `vertical`: Content and actions are stacked.
15
- Default is `horizontal`. */
9
+ /** Layout direction: `horizontal` (default) puts content and actions side-by-side, `vertical` stacks them. */
16
10
  direction?: ObcFloatingItemDirection;
17
11
  /** If true, displays a timestamp label (e.g., "09:12:46") in the notification. Default is false. */
18
12
  hasTimestamp?: boolean;
@@ -22,10 +16,7 @@ Default is `horizontal`. */
22
16
  action?: boolean;
23
17
  /** If true, displays a secondary action button (e.g., "Undo"). Only available if `action` is also true. Default is false. */
24
18
  action2?: boolean;
25
- /** Sets the line type for the notification content.
26
- - `singleLine`: Compact, single-line layout.
27
- - `multiLine`: Supports longer, multi-line descriptions.
28
- Default is `singleLine`. */
19
+ /** Content line type: `single-line` (default) is the compact one-line layout, `multi-line` allows a longer description to wrap. */
29
20
  lineType?: ObcFloatingItemLineType;
30
21
  }
31
22
  export interface Events {
@@ -40,16 +40,10 @@
40
40
  * Available when `type==WithButton`.
41
41
  */
42
42
  actionLabel?: string;
43
- /** Display type of the notification.
44
- - `simple`: Basic notification (default).
45
- - `with-button`: Includes a text action button.
46
- - `with-icon-button`: Includes an icon action.
47
- - `inactive`: Shows empty/inactive state. */
48
- type?: ObcNotificationMessageItemType;
49
- /** Size variant of the notification.
50
- - `regular`: Standard compact layout (default).
51
- - `tall`: Expanded layout for longer content. */
52
- size?: ObcNotificationMessageItemSize;
43
+ /** Display type: `simple` (default) is the basic notification, `with-button` adds a text action button, `with-icon-button` an icon action, and `inactive` shows the empty state. */
44
+ type?: ObcNotificationMessageItemType;
45
+ /** Size variant: `regular` (default) is the compact layout, `tall` the expanded one for longer content. */
46
+ size?: ObcNotificationMessageItemSize;
53
47
  /**
54
48
  * Whether to show the title.
55
49
  *
@@ -34,15 +34,9 @@ export interface Props {
34
34
  * Available when `type==WithButton`.
35
35
  */
36
36
  actionLabel?: string;
37
- /** Display type of the notification.
38
- - `simple`: Basic notification (default).
39
- - `with-button`: Includes a text action button.
40
- - `with-icon-button`: Includes an icon action.
41
- - `inactive`: Shows empty/inactive state. */
37
+ /** Display type: `simple` (default) is the basic notification, `with-button` adds a text action button, `with-icon-button` an icon action, and `inactive` shows the empty state. */
42
38
  type?: ObcNotificationMessageItemType;
43
- /** Size variant of the notification.
44
- - `regular`: Standard compact layout (default).
45
- - `tall`: Expanded layout for longer content. */
39
+ /** Size variant: `regular` (default) is the compact layout, `tall` the expanded one for longer content. */
46
40
  size?: ObcNotificationMessageItemSize;
47
41
  /**
48
42
  * Whether to show the title.
@@ -9,32 +9,14 @@
9
9
  export interface Props {
10
10
  class?: string;
11
11
  style?: string;
12
- /** Visual style variant of the pagination component.
13
-
14
- - `regular`: Standard pagination with numbered page buttons and navigation arrows.
15
- - `flat`: Minimalist, low-elevation style with flat toggle buttons.
16
- - `condensed`: Compact mode with progress indicator dots and navigation arrows only.
17
-
18
- Default: `regular` */
19
- variant?: PaginationVariant;
20
- /** Total number of pages available for navigation.
21
-
22
- Must be a positive integer (minimum 1). If set below 1, defaults to 1.
23
-
24
- Default: `3` */
25
- pages?: number;
26
- /** The currently selected (active) page, 1-based index.
27
-
28
- If set below 1 or above the total number of pages, it is clamped to the valid range.
29
-
30
- Default: `1` */
31
- currentPage?: number;
32
- /** Expands the pagination controls to fill the width of the container.
33
-
34
- When enabled, the page indicators (toggle button group or progress dots) stretch to align with the container.
35
-
36
- Default: `false` */
37
- fullWidth?: boolean;
12
+ /** Visual variant: `regular` (default) shows numbered page buttons and navigation arrows, `flat` is the low-elevation style with flat toggle buttons, and `condensed` replaces the numbers with progress indicator dots. */
13
+ variant?: PaginationVariant;
14
+ /** Total number of pages available for navigation. Must be a positive integer (minimum 1). If set below 1, defaults to 1. */
15
+ pages?: number;
16
+ /** The currently selected (active) page, 1-based index. If set below 1 or above the total number of pages, it is clamped to the valid range. */
17
+ currentPage?: number;
18
+ /** Expands the pagination controls to fill the width of the container. When enabled, the page indicators (toggle button group or progress dots) stretch to align with the container. */
19
+ fullWidth?: boolean;
38
20
  disabled?: boolean
39
21
  }
40
22
  export interface Events {
@@ -4,31 +4,13 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** Visual style variant of the pagination component.
8
-
9
- - `regular`: Standard pagination with numbered page buttons and navigation arrows.
10
- - `flat`: Minimalist, low-elevation style with flat toggle buttons.
11
- - `condensed`: Compact mode with progress indicator dots and navigation arrows only.
12
-
13
- Default: `regular` */
7
+ /** Visual variant: `regular` (default) shows numbered page buttons and navigation arrows, `flat` is the low-elevation style with flat toggle buttons, and `condensed` replaces the numbers with progress indicator dots. */
14
8
  variant?: PaginationVariant;
15
- /** Total number of pages available for navigation.
16
-
17
- Must be a positive integer (minimum 1). If set below 1, defaults to 1.
18
-
19
- Default: `3` */
9
+ /** Total number of pages available for navigation. Must be a positive integer (minimum 1). If set below 1, defaults to 1. */
20
10
  pages?: number;
21
- /** The currently selected (active) page, 1-based index.
22
-
23
- If set below 1 or above the total number of pages, it is clamped to the valid range.
24
-
25
- Default: `1` */
11
+ /** The currently selected (active) page, 1-based index. If set below 1 or above the total number of pages, it is clamped to the valid range. */
26
12
  currentPage?: number;
27
- /** Expands the pagination controls to fill the width of the container.
28
-
29
- When enabled, the page indicators (toggle button group or progress dots) stretch to align with the container.
30
-
31
- Default: `false` */
13
+ /** Expands the pagination controls to fill the width of the container. When enabled, the page indicators (toggle button group or progress dots) stretch to align with the container. */
32
14
  fullWidth?: boolean;
33
15
  disabled?: boolean;
34
16
  }
@@ -10,35 +10,20 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** The value associated with this pivot item. Used to identify the item within a group.
14
-
15
- Set a unique value for each item in a group to track selection state. */
16
- value?: string;
17
- /** Whether this item is currently selected. Only one item should be selected in a group.
18
-
19
- When `true`, the item is visually highlighted and does not emit the `selected` event on click. */
20
- selected?: boolean;
21
- /** Layout direction for the item: `horizontal` (default) or `vertical`.
22
- Should match the direction of the containing group.
23
-
24
- Use `horizontal` for row/tab layouts and `vertical` for column/rail layouts. */
25
- direction?: ObcPivotItemDirection;
26
- /** Whether to display a leading icon. If true, renders the `icon` slot.
27
-
28
- Place an icon element (e.g., `<obi-home slot="icon"></obi-home>`) in the slot to show an icon. */
29
- hasLeadingIcon?: boolean;
30
- /** Whether to display a text label. If true and `label` is non-empty, shows the label.
31
-
32
- Use in combination with `hasLeadingIcon` for icon+label layouts. */
33
- hasLabel?: boolean;
34
- /** The text label to display for the item. Only shown if `hasLabel` is true and label is non-empty.
35
-
36
- Keep labels concise for best appearance, especially in horizontal layouts. */
37
- label?: string;
38
- /** Disables the item, preventing interaction and applying a disabled style.
39
-
40
- When `true`, the item cannot be selected and is visually muted. */
41
- disabled?: boolean
13
+ /** The value associated with this pivot item. Used to identify the item within a group. Set a unique value for each item in a group to track selection state. */
14
+ value?: string;
15
+ /** Whether this item is currently selected. Only one item should be selected in a group. When `true`, the item is visually highlighted and does not emit the `selected` event on click. */
16
+ selected?: boolean;
17
+ /** Layout direction for the item: `horizontal` (default) or `vertical`. Should match the direction of the containing group. Use `horizontal` for row/tab layouts and `vertical` for column/rail layouts. */
18
+ direction?: ObcPivotItemDirection;
19
+ /** Whether to display a leading icon. If true, renders the `icon` slot. Place an icon element (e.g., `<obi-home slot="icon"></obi-home>`) in the slot to show an icon. */
20
+ hasLeadingIcon?: boolean;
21
+ /** Whether to display a text label. If true and `label` is non-empty, shows the label. Use in combination with `hasLeadingIcon` for icon+label layouts. */
22
+ hasLabel?: boolean;
23
+ /** The text label to display for the item. Only shown if `hasLabel` is true and label is non-empty. Keep labels concise for best appearance, especially in horizontal layouts. */
24
+ label?: string;
25
+ /** Disables the item, preventing interaction and applying a disabled style. When `true`, the item cannot be selected and is visually muted. */
26
+ disabled?: boolean
42
27
  }
43
28
  export interface Events {
44
29
  onSelected?: (event: CustomEvent<{value: string}>) => void
@@ -4,34 +4,19 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** The value associated with this pivot item. Used to identify the item within a group.
8
-
9
- Set a unique value for each item in a group to track selection state. */
7
+ /** The value associated with this pivot item. Used to identify the item within a group. Set a unique value for each item in a group to track selection state. */
10
8
  value?: string;
11
- /** Whether this item is currently selected. Only one item should be selected in a group.
12
-
13
- When `true`, the item is visually highlighted and does not emit the `selected` event on click. */
9
+ /** Whether this item is currently selected. Only one item should be selected in a group. When `true`, the item is visually highlighted and does not emit the `selected` event on click. */
14
10
  selected?: boolean;
15
- /** Layout direction for the item: `horizontal` (default) or `vertical`.
16
- Should match the direction of the containing group.
17
-
18
- Use `horizontal` for row/tab layouts and `vertical` for column/rail layouts. */
11
+ /** Layout direction for the item: `horizontal` (default) or `vertical`. Should match the direction of the containing group. Use `horizontal` for row/tab layouts and `vertical` for column/rail layouts. */
19
12
  direction?: ObcPivotItemDirection;
20
- /** Whether to display a leading icon. If true, renders the `icon` slot.
21
-
22
- Place an icon element (e.g., `<obi-home slot="icon"></obi-home>`) in the slot to show an icon. */
13
+ /** Whether to display a leading icon. If true, renders the `icon` slot. Place an icon element (e.g., `<obi-home slot="icon"></obi-home>`) in the slot to show an icon. */
23
14
  hasLeadingIcon?: boolean;
24
- /** Whether to display a text label. If true and `label` is non-empty, shows the label.
25
-
26
- Use in combination with `hasLeadingIcon` for icon+label layouts. */
15
+ /** Whether to display a text label. If true and `label` is non-empty, shows the label. Use in combination with `hasLeadingIcon` for icon+label layouts. */
27
16
  hasLabel?: boolean;
28
- /** The text label to display for the item. Only shown if `hasLabel` is true and label is non-empty.
29
-
30
- Keep labels concise for best appearance, especially in horizontal layouts. */
17
+ /** The text label to display for the item. Only shown if `hasLabel` is true and label is non-empty. Keep labels concise for best appearance, especially in horizontal layouts. */
31
18
  label?: string;
32
- /** Disables the item, preventing interaction and applying a disabled style.
33
-
34
- When `true`, the item cannot be selected and is visually muted. */
19
+ /** Disables the item, preventing interaction and applying a disabled style. When `true`, the item cannot be selected and is visually muted. */
35
20
  disabled?: boolean;
36
21
  }
37
22
  export interface Events {
@@ -58,11 +58,12 @@ import type {Priority} from '@oicl/openbridge-webcomponents/dist/navigation-inst
58
58
  * Available when `type==linear && hasDescription==true`.
59
59
  */
60
60
  description?: string;
61
- /** Shows the `stateLabel` next to the value.
62
-
63
- **TODO(designer):** Confirm the intended purpose of the state indicator — the story labels
64
- this a "future feature". */
65
- showState?: boolean;
61
+ /**
62
+ * Shows the `stateLabel` next to the value. **TODO(designer):** Confirm the intended purpose of the state indicator — the story labels this a "future feature".
63
+ *
64
+ * Available when `type==linear && showValue==true && mode==determinate`.
65
+ */
66
+ showState?: boolean;
66
67
  /**
67
68
  * Text shown alongside the value when `showState` is enabled.
68
69
  *
@@ -51,10 +51,11 @@ export interface Props {
51
51
  * Available when `type==linear && hasDescription==true`.
52
52
  */
53
53
  description?: string;
54
- /** Shows the `stateLabel` next to the value.
55
-
56
- **TODO(designer):** Confirm the intended purpose of the state indicator — the story labels
57
- this a "future feature". */
54
+ /**
55
+ * Shows the `stateLabel` next to the value. **TODO(designer):** Confirm the intended purpose of the state indicator — the story labels this a "future feature".
56
+ *
57
+ * Available when `type==linear && showValue==true && mode==determinate`.
58
+ */
58
59
  showState?: boolean;
59
60
  /**
60
61
  * Text shown alongside the value when `showState` is enabled.
@@ -16,10 +16,8 @@ import type {RichButtonDirection} from '@oicl/openbridge-webcomponents/dist/comp
16
16
  label?: string | HTMLTemplateResult;
17
17
  /** Optional supporting description text (up to two lines, truncated if too long). */
18
18
  description?: string;
19
- /** Layout direction for the button content.
20
- - `vertical` (default): Icons and text are stacked vertically.
21
- - `horizontal`: Icons and text are arranged side by side. */
22
- direction?: RichButtonDirection;
19
+ /** Layout direction for the button content: `vertical` (default) stacks icons and text, `horizontal` puts them side by side. */
20
+ direction?: RichButtonDirection;
23
21
  /** If true, displays the leading icon slot before the label. */
24
22
  hasLeadingIcon?: boolean;
25
23
  /** If true, displays the trailing icon slot after the description. */
@@ -9,9 +9,7 @@ export interface Props {
9
9
  label?: string | HTMLTemplateResult;
10
10
  /** Optional supporting description text (up to two lines, truncated if too long). */
11
11
  description?: string;
12
- /** Layout direction for the button content.
13
- - `vertical` (default): Icons and text are stacked vertically.
14
- - `horizontal`: Icons and text are arranged side by side. */
12
+ /** Layout direction for the button content: `vertical` (default) stacks icons and text, `horizontal` puts them side by side. */
15
13
  direction?: RichButtonDirection;
16
14
  /** If true, displays the leading icon slot before the label. */
17
15
  hasLeadingIcon?: boolean;
@@ -10,52 +10,38 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** The current value of the slider.
14
-
15
- Updates as the user drags the thumb, clicks the track (if `allowSeeking`), or uses the increment/decrement buttons. */
16
- value?: number;
17
- /** The minimum allowed value for the slider.
18
-
19
- Default is 0. */
20
- min?: number;
21
- /** The maximum allowed value for the slider.
22
-
23
- Default is 100. */
24
- max?: number;
25
- /** The step granularity for slider value changes.
26
-
27
- If set, the slider will snap to multiples of this value between min and max.
28
- Optional; if not set, the slider is continuous. */
29
- step?: number | undefined;
30
- /** The amount to increment or decrement the value when clicking the left/right icon buttons.
31
-
32
- Default is 10. */
33
- stepClick?: number;
34
- /** The visual and interaction style of the slider.
35
-
36
- - `normal`: Standard appearance.
37
- - `enhanced`: Larger track and thumb for emphasis.
38
- - `no-input`: Read-only; disables all user input.
39
-
40
- Default is `normal`. */
41
- variant?: ObcSliderVariant;
42
- /** Whether to display a left icon button for decrementing the value.
43
-
44
- When true, the `icon-left` slot is rendered as a button. */
45
- hasLeftIcon?: boolean;
46
- /** Whether to display a right icon button for incrementing the value.
47
-
48
- When true, the `icon-right` slot is rendered as a button. */
49
- hasRightIcon?: boolean;
50
- /** Enables animated seeking: clicking or dragging along the track will set the value to the clicked position, animating smoothly.
51
-
52
- Default is false. */
53
- allowSeeking?: boolean;
54
- /** The speed of the smooth animation that moves the value to the clicked position (used when `allowSeeking` is false).
55
-
56
- Expressed as the inverse of seconds to go from min to max (e.g., 1/3 means 3 seconds for full range).
57
- Default is 1/3. */
58
- seekingSpeed?: number;
13
+ /** The current value of the slider. Updates as the user drags the thumb, clicks the track (if `allowSeeking`), or uses the increment/decrement buttons. */
14
+ value?: number;
15
+ /** The minimum allowed value for the slider. Default is 0. */
16
+ min?: number;
17
+ /** The maximum allowed value for the slider. Default is 100. */
18
+ max?: number;
19
+ /** The step granularity for slider value changes. If set, the slider will snap to multiples of this value between min and max. Optional; if not set, the slider is continuous. */
20
+ step?: number | undefined;
21
+ /**
22
+ * The amount to increment or decrement the value when clicking the left/right icon buttons. Default is 10.
23
+ *
24
+ * Available when `hasLeftIcon==true || hasRightIcon==true`.
25
+ */
26
+ stepClick?: number;
27
+ /** Visual and interaction style: `normal` (default) is the standard appearance, `enhanced` has a larger track and thumb for emphasis, and `no-input` is read-only. */
28
+ variant?: ObcSliderVariant;
29
+ /** Whether to display a left icon button for decrementing the value. When true, the `icon-left` slot is rendered as a button. */
30
+ hasLeftIcon?: boolean;
31
+ /** Whether to display a right icon button for incrementing the value. When true, the `icon-right` slot is rendered as a button. */
32
+ hasRightIcon?: boolean;
33
+ /**
34
+ * Moves the value straight to the position clicked or dragged to. Left off, the value animates there instead, at `seekingSpeed`. Default is false.
35
+ *
36
+ * Available when `variant!=no-input && disabled==false`.
37
+ */
38
+ allowSeeking?: boolean;
39
+ /**
40
+ * The speed of the smooth animation that moves the value to the clicked position (used when `allowSeeking` is false). Expressed as the inverse of seconds to go from min to max (e.g., 1/3 means 3 seconds for full range). Default is 1/3.
41
+ *
42
+ * Available when `allowSeeking==false && variant!=no-input && disabled==false`.
43
+ */
44
+ seekingSpeed?: number;
59
45
  disabled?: boolean
60
46
  }
61
47
  export interface Events {