@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
@@ -10,26 +10,14 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** If true, displays the "Shelved" tab and enables shelving support for alerts.
14
- Set to false to hide the "Shelved" tab and related filtering.
15
-
16
- Default: false. */
17
- hasShelved?: boolean;
18
- /** If true, enables the "ACK visible" button, allowing users to acknowledge all currently visible alerts in the active tab.
19
- Should be set to true only when there are unacknowledged alerts in view.
20
-
21
- Default: false. */
22
- canAckAll?: boolean;
23
- /** If true, shows the "Silence" button in the action bar.
24
- When hidden, the "ACK visible" button expands to fill the freed space.
25
-
26
- Default: true. */
27
- showSilenceButton?: boolean;
28
- /** If true, shows the "Alerts" navigation button in the action bar.
29
- When hidden, the "ACK visible" button expands to fill the freed space.
30
-
31
- Default: true. */
32
- showAlertListButton?: boolean
13
+ /** If true, displays the "Shelved" tab and enables shelving support for alerts. Set to false to hide the "Shelved" tab and related filtering. */
14
+ hasShelved?: boolean;
15
+ /** If true, enables the "ACK visible" button, allowing users to acknowledge all currently visible alerts in the active tab. Should be set to true only when there are unacknowledged alerts in view. */
16
+ canAckAll?: boolean;
17
+ /** If true, shows the "Silence" button in the action bar. When hidden, the "ACK visible" button expands to fill the freed space. */
18
+ showSilenceButton?: boolean;
19
+ /** If true, shows the "Alerts" navigation button in the action bar. When hidden, the "ACK visible" button expands to fill the freed space. */
20
+ showAlertListButton?: boolean
33
21
  }
34
22
  export interface Events {
35
23
  onAckAllVisibleClick?: (event: ObcAckAllVisibleClickEvent) => void;
@@ -4,25 +4,13 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** If true, displays the "Shelved" tab and enables shelving support for alerts.
8
- Set to false to hide the "Shelved" tab and related filtering.
9
-
10
- Default: false. */
7
+ /** If true, displays the "Shelved" tab and enables shelving support for alerts. Set to false to hide the "Shelved" tab and related filtering. */
11
8
  hasShelved?: boolean;
12
- /** If true, enables the "ACK visible" button, allowing users to acknowledge all currently visible alerts in the active tab.
13
- Should be set to true only when there are unacknowledged alerts in view.
14
-
15
- Default: false. */
9
+ /** If true, enables the "ACK visible" button, allowing users to acknowledge all currently visible alerts in the active tab. Should be set to true only when there are unacknowledged alerts in view. */
16
10
  canAckAll?: boolean;
17
- /** If true, shows the "Silence" button in the action bar.
18
- When hidden, the "ACK visible" button expands to fill the freed space.
19
-
20
- Default: true. */
11
+ /** If true, shows the "Silence" button in the action bar. When hidden, the "ACK visible" button expands to fill the freed space. */
21
12
  showSilenceButton?: boolean;
22
- /** If true, shows the "Alerts" navigation button in the action bar.
23
- When hidden, the "ACK visible" button expands to fill the freed space.
24
-
25
- Default: true. */
13
+ /** If true, shows the "Alerts" navigation button in the action bar. When hidden, the "ACK visible" button expands to fill the freed space. */
26
14
  showAlertListButton?: boolean;
27
15
  }
28
16
  export interface Events {
@@ -34,10 +34,10 @@ import type {ObcMessageMenuItemSize} from '@oicl/openbridge-webcomponents/dist/c
34
34
  animateIntro?: boolean;
35
35
  /** The label for the secondary action button. Unlike the primary (ACK) action, the secondary label is not derived from `status`; it must be provided explicitly. The secondary action is only shown when a non-empty label is set and `secondaryActionState` is not `none`. */
36
36
  secondaryActionLabel?: string;
37
- /** [object Object],[object Object],[object Object] */
38
- primaryActionState?: ObcAlertMenuItemActionState;
39
- /** [object Object],[object Object],[object Object] */
40
- secondaryActionState?: ObcAlertMenuItemActionState
37
+ /** Appearance of the primary (ACK) action: `enabled`, `disabled` or `none`, which hides it. */
38
+ primaryActionState?: ObcAlertMenuItemActionState;
39
+ /** Appearance of the secondary action: `enabled`, `disabled` or `none`, which hides it. */
40
+ secondaryActionState?: ObcAlertMenuItemActionState
41
41
  }
42
42
  export interface Events {
43
43
  onAckClick?: (event: CustomEvent<void>) => void;
@@ -27,9 +27,9 @@ export interface Props {
27
27
  animateIntro?: boolean;
28
28
  /** The label for the secondary action button. Unlike the primary (ACK) action, the secondary label is not derived from `status`; it must be provided explicitly. The secondary action is only shown when a non-empty label is set and `secondaryActionState` is not `none`. */
29
29
  secondaryActionLabel?: string;
30
- /** [object Object],[object Object],[object Object] */
30
+ /** Appearance of the primary (ACK) action: `enabled`, `disabled` or `none`, which hides it. */
31
31
  primaryActionState?: ObcAlertMenuItemActionState;
32
- /** [object Object],[object Object],[object Object] */
32
+ /** Appearance of the secondary action: `enabled`, `disabled` or `none`, which hides it. */
33
33
  secondaryActionState?: ObcAlertMenuItemActionState;
34
34
  }
35
35
  export interface Events {
@@ -10,8 +10,12 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** Sets the button's text label. */
14
- label?: string;
13
+ /**
14
+ * Sets the button's text label.
15
+ *
16
+ * Available when `showLabel==true`.
17
+ */
18
+ label?: string;
15
19
  /** If true, applies the "checked" visual style to indicate selection or active state. */
16
20
  checked?: boolean;
17
21
  /** If true, shows the button's label. */
@@ -4,7 +4,11 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** Sets the button's text label. */
7
+ /**
8
+ * Sets the button's text label.
9
+ *
10
+ * Available when `showLabel==true`.
11
+ */
8
12
  label?: string;
9
13
  /** If true, applies the "checked" visual style to indicate selection or active state. */
10
14
  checked?: boolean;
@@ -10,34 +10,22 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** The number to display in the badge. Set to 0 for no count.
14
-
15
- If `showNumber` is false, the number is hidden. */
16
- number?: number;
17
- /** Shows the number in the badge when true.
18
-
19
- Set to `false` for symbolic or icon-only badges. */
20
- showNumber?: boolean;
21
- /** Visual style/type of the badge.
22
-
23
- Possible values: `regular`, `alarm`, `warning`, `caution`, `level-critical`, `level-high`, `level-medium`, `level-low`, `level-diagnostic`, `running`, `notification`, `enhance`, `automation`, `outline`, `empty`.
24
-
25
- Defaults to `regular`. */
26
- type?: string;
27
- /** Badge size.
28
-
29
- Possible values: `regular` (default), `large`. */
30
- size?: string;
31
- /** Badge variant.
32
-
33
- - `default`: Filled background and border (default).
34
- - `flat`: Minimal background and outline. */
35
- variant?: BadgeVariant;
36
- /** Whether to show an icon in the badge.
37
-
38
- For built-in types (`alarm`, `warning`, `caution`, the `level-*` severities, and `running`), a contextual icon is shown automatically.
39
- For other types, provide a custom icon in the `badge-icon` slot. */
40
- showIcon?: boolean
13
+ /**
14
+ * The number to display in the badge. Set to 0 for no count. If `showNumber` is false, the number is hidden.
15
+ *
16
+ * Available when `showNumber==true`.
17
+ */
18
+ number?: number;
19
+ /** Shows the number in the badge when true. Set to `false` for symbolic or icon-only badges. */
20
+ showNumber?: boolean;
21
+ /** Visual style/type of the badge. Possible values: `regular`, `alarm`, `warning`, `caution`, `level-critical`, `level-high`, `level-medium`, `level-low`, `level-diagnostic`, `running`, `notification`, `enhance`, `automation`, `outline`, `empty`. Defaults to `regular`. */
22
+ type?: string;
23
+ /** Badge size. Possible values: `regular` (default), `large`. */
24
+ size?: string;
25
+ /** Badge variant: `default` has a filled background and border, `flat` a minimal background and outline. */
26
+ variant?: BadgeVariant;
27
+ /** Whether to show an icon in the badge. For built-in types (`alarm`, `warning`, `caution`, the `level-*` severities, and `running`), a contextual icon is shown automatically. For other types, provide a custom icon in the `badge-icon` slot. */
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
- /** The number to display in the badge. Set to 0 for no count.
8
-
9
- If `showNumber` is false, the number is hidden. */
7
+ /**
8
+ * The number to display in the badge. Set to 0 for no count. If `showNumber` is false, the number is hidden.
9
+ *
10
+ * Available when `showNumber==true`.
11
+ */
10
12
  number?: number;
11
- /** Shows the number in the badge when true.
12
-
13
- Set to `false` for symbolic or icon-only badges. */
13
+ /** Shows the number in the badge when true. Set to `false` for symbolic or icon-only badges. */
14
14
  showNumber?: boolean;
15
- /** Visual style/type of the badge.
16
-
17
- Possible values: `regular`, `alarm`, `warning`, `caution`, `level-critical`, `level-high`, `level-medium`, `level-low`, `level-diagnostic`, `running`, `notification`, `enhance`, `automation`, `outline`, `empty`.
18
-
19
- Defaults to `regular`. */
15
+ /** Visual style/type of the badge. Possible values: `regular`, `alarm`, `warning`, `caution`, `level-critical`, `level-high`, `level-medium`, `level-low`, `level-diagnostic`, `running`, `notification`, `enhance`, `automation`, `outline`, `empty`. Defaults to `regular`. */
20
16
  type?: string;
21
- /** Badge size.
22
-
23
- Possible values: `regular` (default), `large`. */
17
+ /** Badge size. Possible values: `regular` (default), `large`. */
24
18
  size?: string;
25
- /** Badge variant.
26
-
27
- - `default`: Filled background and border (default).
28
- - `flat`: Minimal background and outline. */
19
+ /** Badge variant: `default` has a filled background and border, `flat` a minimal background and outline. */
29
20
  variant?: BadgeVariant;
30
- /** Whether to show an icon in the badge.
31
-
32
- For built-in types (`alarm`, `warning`, `caution`, the `level-*` severities, and `running`), a contextual icon is shown automatically.
33
- For other types, provide a custom icon in the `badge-icon` slot. */
21
+ /** Whether to show an icon in the badge. For built-in types (`alarm`, `warning`, `caution`, the `level-*` severities, and `running`), a contextual icon is shown automatically. For other types, provide a custom icon in the `badge-icon` slot. */
34
22
  showIcon?: boolean;
35
23
  }
36
24
  export interface Events {
@@ -9,12 +9,8 @@
9
9
  export interface Props {
10
10
  class?: string;
11
11
  style?: string;
12
- /** The list of breadcrumb items to display, in order from root to current location.
13
-
14
- Each item should be an object with a `label` property (string). The component renders each label in sequence, separated by a chevron icon.
15
-
16
- Example: `[ {label: 'Home'}, {label: 'Section'}, {label: 'Page'} ]` */
17
- items?: BreadcrumbItem[];
12
+ /** The list of breadcrumb items to display, in order from root to current location. Each item should be an object with a `label` property (string). The component renders each label in sequence, separated by a chevron icon. Example: `[ {label: 'Home'}, {label: 'Section'}, {label: 'Page'} ]` */
13
+ items?: BreadcrumbItem[];
18
14
  iconOnly?: boolean
19
15
  }
20
16
  export interface Events {
@@ -4,11 +4,7 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** The list of breadcrumb items to display, in order from root to current location.
8
-
9
- Each item should be an object with a `label` property (string). The component renders each label in sequence, separated by a chevron icon.
10
-
11
- Example: `[ {label: 'Home'}, {label: 'Section'}, {label: 'Page'} ]` */
7
+ /** The list of breadcrumb items to display, in order from root to current location. Each item should be an object with a `label` property (string). The component renders each label in sequence, separated by a chevron icon. Example: `[ {label: 'Home'}, {label: 'Section'}, {label: 'Page'} ]` */
12
8
  items?: BreadcrumbItem[];
13
9
  iconOnly?: boolean;
14
10
  }
@@ -10,11 +10,8 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** Controls the button's visual style.
14
- - `normal`: Standard button (default)
15
- - `raised`: Elevated button for emphasis
16
- - `flat`: Minimal, low-emphasis button */
17
- variant?: ButtonVariant;
13
+ /** Visual style: `normal` (default) is the standard button, `raised` is elevated for emphasis, `flat` is minimal and low-emphasis. */
14
+ variant?: ButtonVariant;
18
15
  /** Expands the button to fill the width of its container when true. */
19
16
  fullWidth?: boolean;
20
17
  /** Disables the button or link, preventing user interaction and applying disabled styling. */
@@ -27,12 +24,8 @@ variant?: ButtonVariant;
27
24
  href?: string | undefined;
28
25
  /** Specifies the target for the anchor link (only applies when `href` is set). Common values: `_blank`, `_self`, `_parent`, `_top`. */
29
26
  target?: string | undefined;
30
- /** Defines the segment position when used in a segmented button group.
31
- - `single`: Standalone button
32
- - `start`: First button in a group
33
- - `middle`: Middle button in a group
34
- - `end`: Last button in a group */
35
- segmentPosition?: segmentPosition
27
+ /** Position within a segmented button group: `single` stands alone, `start`, `middle` and `end` shape the button for the first, an inner and the last segment. */
28
+ segmentPosition?: segmentPosition
36
29
  }
37
30
  export interface Events {
38
31
  onClick?: (event: CustomEvent<unknown>) => void
@@ -4,10 +4,7 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** Controls the button's visual style.
8
- - `normal`: Standard button (default)
9
- - `raised`: Elevated button for emphasis
10
- - `flat`: Minimal, low-emphasis button */
7
+ /** Visual style: `normal` (default) is the standard button, `raised` is elevated for emphasis, `flat` is minimal and low-emphasis. */
11
8
  variant?: ButtonVariant;
12
9
  /** Expands the button to fill the width of its container when true. */
13
10
  fullWidth?: boolean;
@@ -21,11 +18,7 @@ export interface Props {
21
18
  href?: string | undefined;
22
19
  /** Specifies the target for the anchor link (only applies when `href` is set). Common values: `_blank`, `_self`, `_parent`, `_top`. */
23
20
  target?: string | undefined;
24
- /** Defines the segment position when used in a segmented button group.
25
- - `single`: Standalone button
26
- - `start`: First button in a group
27
- - `middle`: Middle button in a group
28
- - `end`: Last button in a group */
21
+ /** Position within a segmented button group: `single` stands alone, `start`, `middle` and `end` shape the button for the first, an inner and the last segment. */
29
22
  segmentPosition?: segmentPosition;
30
23
  }
31
24
  export interface Events {
@@ -11,18 +11,20 @@
11
11
  class?: string;
12
12
  style?: string;
13
13
  showTitle?: boolean;
14
- /** Enables dialog mode. When true, the card acts as a button and opens a modal dialog on click.
15
-
16
- When `hasDialog` is false, the card is a static container. When true, clicking the card opens a modal dialog overlay, displaying content from the `dialog-title` and `dialog-content` slots. */
17
- hasDialog?: boolean;
18
- /** Total time in seconds before the dialog auto-closes. Use `0` to disable auto-close.
19
-
20
- When greater than zero, the dialog closes after this duration unless reset by user activity. The countdown indicator appears for the last `dialogVisibleTimerSeconds` seconds. */
21
- dialogTimeOutSeconds?: number;
22
- /** Duration in seconds for which the countdown indicator is shown before auto-dismiss.
23
-
24
- The countdown indicator is visible for the last `dialogVisibleTimerSeconds` seconds of the dialog's lifetime when auto-close is enabled. User activity resets the timer. */
25
- dialogVisibleTimerSeconds?: number
14
+ /** Enables dialog mode. When true, the card acts as a button and opens a modal dialog on click. When `hasDialog` is false, the card is a static container. When true, clicking the card opens a modal dialog overlay, displaying content from the `dialog-title` and `dialog-content` slots. */
15
+ hasDialog?: boolean;
16
+ /**
17
+ * Total time in seconds before the dialog auto-closes. Use `0` to disable auto-close. When greater than zero, the dialog closes after this duration unless reset by user activity. The countdown indicator appears for the last `dialogVisibleTimerSeconds` seconds.
18
+ *
19
+ * Available when `hasDialog==true`.
20
+ */
21
+ dialogTimeOutSeconds?: number;
22
+ /**
23
+ * Duration in seconds for which the countdown indicator is shown before auto-dismiss. The countdown indicator is visible for the last `dialogVisibleTimerSeconds` seconds of the dialog's lifetime when auto-close is enabled. User activity resets the timer.
24
+ *
25
+ * Available when `hasDialog==true`.
26
+ */
27
+ dialogVisibleTimerSeconds?: number
26
28
  }
27
29
  export interface Events {
28
30
 
@@ -4,17 +4,19 @@ export interface Props {
4
4
  class?: string;
5
5
  style?: string;
6
6
  showTitle?: boolean;
7
- /** Enables dialog mode. When true, the card acts as a button and opens a modal dialog on click.
8
-
9
- When `hasDialog` is false, the card is a static container. When true, clicking the card opens a modal dialog overlay, displaying content from the `dialog-title` and `dialog-content` slots. */
7
+ /** Enables dialog mode. When true, the card acts as a button and opens a modal dialog on click. When `hasDialog` is false, the card is a static container. When true, clicking the card opens a modal dialog overlay, displaying content from the `dialog-title` and `dialog-content` slots. */
10
8
  hasDialog?: boolean;
11
- /** Total time in seconds before the dialog auto-closes. Use `0` to disable auto-close.
12
-
13
- When greater than zero, the dialog closes after this duration unless reset by user activity. The countdown indicator appears for the last `dialogVisibleTimerSeconds` seconds. */
9
+ /**
10
+ * Total time in seconds before the dialog auto-closes. Use `0` to disable auto-close. When greater than zero, the dialog closes after this duration unless reset by user activity. The countdown indicator appears for the last `dialogVisibleTimerSeconds` seconds.
11
+ *
12
+ * Available when `hasDialog==true`.
13
+ */
14
14
  dialogTimeOutSeconds?: number;
15
- /** Duration in seconds for which the countdown indicator is shown before auto-dismiss.
16
-
17
- The countdown indicator is visible for the last `dialogVisibleTimerSeconds` seconds of the dialog's lifetime when auto-close is enabled. User activity resets the timer. */
15
+ /**
16
+ * Duration in seconds for which the countdown indicator is shown before auto-dismiss. The countdown indicator is visible for the last `dialogVisibleTimerSeconds` seconds of the dialog's lifetime when auto-close is enabled. User activity resets the timer.
17
+ *
18
+ * Available when `hasDialog==true`.
19
+ */
18
20
  dialogVisibleTimerSeconds?: number;
19
21
  }
20
22
  export interface Events {
@@ -10,14 +10,10 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** Determines the visual style and toggle behavior of the button.
14
- - `regular`: Standard button with optional icon and label.
15
- - `checkbox`: Checkbox-style toggle with checked/unchecked icons. */
16
- type?: CheckButtonType;
17
- /** Whether the button is currently checked (selected/on).
18
-
19
- When clicked, this state toggles and the `check-button-click` event is fired. */
20
- checked?: boolean;
13
+ /** Visual style and toggle behaviour: `regular` (default) is a standard button with an optional icon and label, `checkbox` is a checkbox-style toggle with checked and unchecked icons. */
14
+ type?: CheckButtonType;
15
+ /** Whether the button is currently checked (selected/on). When clicked, this state toggles and the `check-button-click` event is fired. */
16
+ checked?: boolean;
21
17
  /** Disables the button, preventing user interaction and applying disabled styling. */
22
18
  disabled?: boolean;
23
19
  /** If false, button width adapts to its content (fit-content). If true, uses the `width` property (if set) or expands to 100% of parent. */
@@ -4,13 +4,9 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** Determines the visual style and toggle behavior of the button.
8
- - `regular`: Standard button with optional icon and label.
9
- - `checkbox`: Checkbox-style toggle with checked/unchecked icons. */
7
+ /** Visual style and toggle behaviour: `regular` (default) is a standard button with an optional icon and label, `checkbox` is a checkbox-style toggle with checked and unchecked icons. */
10
8
  type?: CheckButtonType;
11
- /** Whether the button is currently checked (selected/on).
12
-
13
- When clicked, this state toggles and the `check-button-click` event is fired. */
9
+ /** Whether the button is currently checked (selected/on). When clicked, this state toggles and the `check-button-click` event is fired. */
14
10
  checked?: boolean;
15
11
  /** Disables the button, preventing user interaction and applying disabled styling. */
16
12
  disabled?: boolean;
@@ -9,19 +9,12 @@
9
9
  export interface Props {
10
10
  class?: string;
11
11
  style?: string;
12
- /** Controls the checkbox status: `checked`, `unchecked`, or `mixed` (indeterminate).
13
-
14
- Defaults to `unchecked`. */
15
- status?: CheckboxStatus;
16
- /** Controls the visual state: `enabled` or `loading`.
17
-
18
- Defaults to `enabled`. */
19
- state?: CheckboxState;
20
- /** Disables the checkbox and prevents user interaction.
21
-
22
- When `true`, the checkbox is visually styled as disabled and does not respond to user input.
23
- Interaction is also locked when `state === loading`. */
24
- disabled?: boolean;
12
+ /** Controls the checkbox status: `checked`, `unchecked`, or `mixed` (indeterminate). Defaults to `unchecked`. */
13
+ status?: CheckboxStatus;
14
+ /** Controls the visual state: `enabled` or `loading`. Defaults to `enabled`. */
15
+ state?: CheckboxState;
16
+ /** Disables the checkbox and prevents user interaction. When `true`, the checkbox is visually styled as disabled and does not respond to user input. Interaction is also locked when `state === loading`. */
17
+ disabled?: boolean;
25
18
  /** Internal: controls hover effects on the checkbox. Used by wrapper components such as `obc-checkbox-item`. */
26
19
  hasHoverEffects?: boolean
27
20
  }
@@ -4,18 +4,11 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** Controls the checkbox status: `checked`, `unchecked`, or `mixed` (indeterminate).
8
-
9
- Defaults to `unchecked`. */
7
+ /** Controls the checkbox status: `checked`, `unchecked`, or `mixed` (indeterminate). Defaults to `unchecked`. */
10
8
  status?: CheckboxStatus;
11
- /** Controls the visual state: `enabled` or `loading`.
12
-
13
- Defaults to `enabled`. */
9
+ /** Controls the visual state: `enabled` or `loading`. Defaults to `enabled`. */
14
10
  state?: CheckboxState;
15
- /** Disables the checkbox and prevents user interaction.
16
-
17
- When `true`, the checkbox is visually styled as disabled and does not respond to user input.
18
- Interaction is also locked when `state === loading`. */
11
+ /** Disables the checkbox and prevents user interaction. When `true`, the checkbox is visually styled as disabled and does not respond to user input. Interaction is also locked when `state === loading`. */
19
12
  disabled?: boolean;
20
13
  /** Internal: controls hover effects on the checkbox. Used by wrapper components such as `obc-checkbox-item`. */
21
14
  hasHoverEffects?: boolean;
@@ -9,13 +9,8 @@
9
9
  export interface Props {
10
10
  class?: string;
11
11
  style?: string;
12
- /** Whether the command is currently active.
13
-
14
- When `true`, the button displays the "in command" icon and uses active styling.
15
- When `false`, the button displays the "no command" icon and uses default styling.
16
-
17
- Default: `false` */
18
- inCommand?: boolean
12
+ /** Whether the command is currently active. When `true`, the button displays the "in command" icon and uses active styling. When `false`, the button displays the "no command" icon and uses default styling. */
13
+ inCommand?: boolean
19
14
  }
20
15
  export interface Events {
21
16
  onClick?: (event: CustomEvent<unknown>) => void
@@ -3,12 +3,7 @@ import type { Snippet } from 'svelte';
3
3
  export interface Props {
4
4
  class?: string;
5
5
  style?: string;
6
- /** Whether the command is currently active.
7
-
8
- When `true`, the button displays the "in command" icon and uses active styling.
9
- When `false`, the button displays the "no command" icon and uses default styling.
10
-
11
- Default: `false` */
6
+ /** Whether the command is currently active. When `true`, the button displays the "in command" icon and uses active styling. When `false`, the button displays the "no command" icon and uses default styling. */
12
7
  inCommand?: boolean;
13
8
  }
14
9
  export interface Events {
@@ -9,54 +9,36 @@
9
9
  export interface Props {
10
10
  class?: string;
11
11
  style?: string;
12
- /** The variant type of context menu to display.
13
-
14
- - `'regular'`: Single-select navigation menu.
15
- - `'checkboxes'`: Multi-select with checkboxes.
16
- - `'nested-checkboxes'`: Multi-select with nested/hierarchical checkboxes.
17
- - `'flyout'`: Menu with expandable/cascading groups.
18
- - `'multi'`: Multi-column menu.
19
- - `'multi-with-subtitles'`: Multi-column menu with group subtitles.
20
-
21
- Defaults to `'regular'`. */
22
- type?: ContextMenuType;
23
- /** Array of menu options to display.
24
-
25
- Each option should have a unique `value`, a `label`, and can optionally include:
26
- - `icon`: TemplateResult for a leading icon (e.g., `<obi-placeholder slot="icon"></obi-placeholder>`)
27
- - `level`: For nested checkboxes, indicates nesting depth.
28
- - `children`: For flyout/nested menus, an array of child options. */
29
- options?: ContextMenuOption[];
30
- /** Array of currently selected option values.
31
-
32
- For multi-select variants, can contain multiple values. For single-select, contains at most one value. */
33
- selectedValues?: string[];
34
- /** Whether to show a title bar with close button at the top of the menu.
35
-
36
- If true, displays the `title` property and a close icon button. */
37
- hasTitleBar?: boolean;
12
+ /** Menu variant: `regular` (default) is a single-select navigation menu, `checkboxes` and `nested-checkboxes` are flat and hierarchical multi-select, `flyout` has expandable cascading groups, and `multi` and `multi-with-subtitles` lay the menu out in columns, the latter with group subtitles. */
13
+ type?: ContextMenuType;
14
+ /** Menu options, each with a unique `value` and a `label`, and optionally an `icon` template for the leading icon, a `level` giving the nesting depth for nested checkboxes, and `children` for a flyout or nested menu. */
15
+ options?: ContextMenuOption[];
16
+ /** Array of currently selected option values. For multi-select variants, can contain multiple values. For single-select, contains at most one value. */
17
+ selectedValues?: string[];
18
+ /** Whether to show a title bar with close button at the top of the menu. If true, displays the `title` property and a close icon button. */
19
+ hasTitleBar?: boolean;
38
20
  /**
39
21
  * Title text displayed in the title bar (if `hasTitleBar` is true).
40
22
  *
41
23
  * Available when `hasTitleBar==true`.
42
24
  */
43
25
  title?: string;
44
- /** Array of column groups for the `multi-with-subtitles` layout.
45
-
46
- Each group defines a `title`, `columns` (number of columns in the group), and `options` (array of options for that group). */
47
- columnGroups?: ColumnGroup[];
48
- /** Number of items per column in multi-column layouts.
49
-
50
- Used in `multi` and `multi-with-subtitles` variants to control column splitting. */
51
- itemsPerColumn?: number;
52
- /** Whether multiple selections are allowed.
53
-
54
- If not set, defaults to true for checkbox/multi variants, false for regular/flyout. */
55
- multiSelect?: boolean | undefined;
56
- /** If true, restricts selection to one option per group or column (used in flyout and multi-column).
57
-
58
- When enabled, only one option can be selected in each group or column. */
59
- selectPerGroup?: boolean | undefined
26
+ /**
27
+ * Array of column groups for the `multi-with-subtitles` layout. Each group defines a `title`, `columns` (number of columns in the group), and `options` (array of options for that group).
28
+ *
29
+ * Available when `type==MultiWithSubtitles`.
30
+ */
31
+ columnGroups?: ColumnGroup[];
32
+ /**
33
+ * Number of items per column in multi-column layouts. Used in `multi` and `multi-with-subtitles` variants to control column splitting.
34
+ *
35
+ * Available when `type in [Multi, MultiWithSubtitles]`.
36
+ */
37
+ itemsPerColumn?: number;
38
+ /** Whether multiple selections are allowed. If not set, defaults to true for checkbox/multi variants, false for regular/flyout. */
39
+ multiSelect?: boolean | undefined;
40
+ /** If true, restricts selection to one option per group or column (used in flyout and multi-column). When enabled, only one option can be selected in each group or column. */
41
+ selectPerGroup?: boolean | undefined
60
42
  }
61
43
  export interface Events {
62
44
  onChange?: (event: ObcContextMenuInputChangeEvent) => void;