@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
@@ -36,8 +36,8 @@ import type {RouterAlternativeIcon} from '@oicl/openbridge-webcomponents/dist/au
36
36
  /** Available when `showReadoutStack==true`. */
37
37
  tag?: string | null;
38
38
  positioning?: AutomationButtonPositioning;
39
- /** Enables the activated background color, used to indicate that the button is activated/selected. */
40
- activated?: boolean;
39
+ /** Enables the activated background color, used to indicate that the button is activated/selected. */
40
+ activated?: boolean;
41
41
  alert?: boolean;
42
42
  /** Available when `alert==true`. */
43
43
  alertFrameType?: ObcAlertFrameType;
@@ -51,8 +51,8 @@ activated?: boolean;
51
51
  showAlertCategoryIcon?: boolean;
52
52
  /** Available when `alert==true`. */
53
53
  showAlertIcon?: boolean;
54
- /** Shows a progress indicator, used to indicate that an user action is in progress */
55
- progress?: boolean;
54
+ /** Shows a progress indicator, used to indicate that an user action is in progress */
55
+ progress?: boolean;
56
56
  /** Available when `progress==true`. */
57
57
  progressMode?: CircularProgressMode;
58
58
  /** Available when `progress==true && progressMode in [determinate, progressiveIndeterminate]`. */
@@ -36,8 +36,8 @@ import type {SourceAlternativeIcon} from '@oicl/openbridge-webcomponents/dist/au
36
36
  /** Available when `showReadoutStack==true`. */
37
37
  tag?: string | null;
38
38
  positioning?: AutomationButtonPositioning;
39
- /** Enables the activated background color, used to indicate that the button is activated/selected. */
40
- activated?: boolean;
39
+ /** Enables the activated background color, used to indicate that the button is activated/selected. */
40
+ activated?: boolean;
41
41
  alert?: boolean;
42
42
  /** Available when `alert==true`. */
43
43
  alertFrameType?: ObcAlertFrameType;
@@ -51,8 +51,8 @@ activated?: boolean;
51
51
  showAlertCategoryIcon?: boolean;
52
52
  /** Available when `alert==true`. */
53
53
  showAlertIcon?: boolean;
54
- /** Shows a progress indicator, used to indicate that an user action is in progress */
55
- progress?: boolean;
54
+ /** Shows a progress indicator, used to indicate that an user action is in progress */
55
+ progress?: boolean;
56
56
  /** Available when `progress==true`. */
57
57
  progressMode?: CircularProgressMode;
58
58
  /** Available when `progress==true && progressMode in [determinate, progressiveIndeterminate]`. */
@@ -36,8 +36,8 @@ import type {SwitchAlternativeIcon} from '@oicl/openbridge-webcomponents/dist/au
36
36
  /** Available when `showReadoutStack==true`. */
37
37
  tag?: string | null;
38
38
  positioning?: AutomationButtonPositioning;
39
- /** Enables the activated background color, used to indicate that the button is activated/selected. */
40
- activated?: boolean;
39
+ /** Enables the activated background color, used to indicate that the button is activated/selected. */
40
+ activated?: boolean;
41
41
  alert?: boolean;
42
42
  /** Available when `alert==true`. */
43
43
  alertFrameType?: ObcAlertFrameType;
@@ -51,8 +51,8 @@ activated?: boolean;
51
51
  showAlertCategoryIcon?: boolean;
52
52
  /** Available when `alert==true`. */
53
53
  showAlertIcon?: boolean;
54
- /** Shows a progress indicator, used to indicate that an user action is in progress */
55
- progress?: boolean;
54
+ /** Shows a progress indicator, used to indicate that an user action is in progress */
55
+ progress?: boolean;
56
56
  /** Available when `progress==true`. */
57
57
  progressMode?: CircularProgressMode;
58
58
  /** Available when `progress==true && progressMode in [determinate, progressiveIndeterminate]`. */
@@ -36,8 +36,8 @@ import type {TransformerAlternativeIcon} from '@oicl/openbridge-webcomponents/di
36
36
  /** Available when `showReadoutStack==true`. */
37
37
  tag?: string | null;
38
38
  positioning?: AutomationButtonPositioning;
39
- /** Enables the activated background color, used to indicate that the button is activated/selected. */
40
- activated?: boolean;
39
+ /** Enables the activated background color, used to indicate that the button is activated/selected. */
40
+ activated?: boolean;
41
41
  alert?: boolean;
42
42
  /** Available when `alert==true`. */
43
43
  alertFrameType?: ObcAlertFrameType;
@@ -51,8 +51,8 @@ activated?: boolean;
51
51
  showAlertCategoryIcon?: boolean;
52
52
  /** Available when `alert==true`. */
53
53
  showAlertIcon?: boolean;
54
- /** Shows a progress indicator, used to indicate that an user action is in progress */
55
- progress?: boolean;
54
+ /** Shows a progress indicator, used to indicate that an user action is in progress */
55
+ progress?: boolean;
56
56
  /** Available when `progress==true`. */
57
57
  progressMode?: CircularProgressMode;
58
58
  /** Available when `progress==true && progressMode in [determinate, progressiveIndeterminate]`. */
@@ -65,22 +65,8 @@ import type {AreaFillMode} from '@oicl/openbridge-webcomponents/dist/bars-graphs
65
65
  showGridY?: boolean;
66
66
  /** Show axis tick marks and labels. */
67
67
  showTickMarks?: boolean;
68
- /** Reserve canvas padding for axis tick labels on sides without an external scale.
69
-
70
- When `true` (default), the chart leaves room for tick labels and renders them
71
- (subject to `showTickMarks` and the 192px auto-compact threshold).
72
-
73
- When `false`, the chart renders edge-to-edge on sides without a slotted external
74
- scale AND axis tick labels are force-hidden so they cannot be clipped. This also
75
- suppresses the automatic edge-to-edge switch that normally happens below the
76
- 192px threshold, eliminating the visible padding "jump" when crossing it.
77
-
78
- Useful when embedding the chart inside another component that owns framing
79
- and never wants to show axis labels (e.g. `obc-automation-tank`).
80
-
81
- Defaults to `true` to preserve existing behavior. Declared with `attribute: false`
82
- because a `true`-default boolean cannot work as an HTML boolean attribute. */
83
- hasLabelPadding?: boolean;
68
+ /** Reserves canvas padding for axis tick labels on the sides that have no slotted external scale. `false` renders those sides edge-to-edge and hides the tick labels so they cannot be clipped, and it also suppresses the automatic edge-to-edge switch below the 192px threshold, removing the padding jump at that crossing. Set it when a host owns the framing and never wants axis labels, as `obc-automation-tank` does. */
69
+ hasLabelPadding?: boolean;
84
70
  /**
85
71
  * Labels kept below the 192px threshold, where the axis labels are otherwise hidden: 'y' draws min, max and (inside the range) 0 in a gutter on the y-axis side; 'x' draws the first and last x value in a bottom gutter; 'xy' both. Ignored when `hasLabelPadding` is false.
86
72
  *
@@ -125,11 +111,8 @@ hasLabelPadding?: boolean;
125
111
  * Available when `instrumentMode==true`.
126
112
  */
127
113
  borderRadius?: number | undefined;
128
- /** Fill rendering mode for area charts.
129
- - `'semitransparent'`: 50% alpha fill (default)
130
- - `'solid'`: Opaque fill
131
- - `'threshold'`: single-series only, falls back to semitransparent for multi-series */
132
- fillMode?: AreaFillMode;
114
+ /** Fill rendering mode: `semitransparent` (default) fills at 50% alpha, `solid` fills opaque, and `threshold` colours above and below the threshold — single-series only, falling back to semitransparent when the chart has more than one series. */
115
+ fillMode?: AreaFillMode;
133
116
  /** Stack multi-series datasets vertically on y-axis. Ignored for single-series and threshold fill mode. */
134
117
  stacked?: boolean
135
118
  }
@@ -58,21 +58,7 @@ export interface Props {
58
58
  showGridY?: boolean;
59
59
  /** Show axis tick marks and labels. */
60
60
  showTickMarks?: boolean;
61
- /** Reserve canvas padding for axis tick labels on sides without an external scale.
62
-
63
- When `true` (default), the chart leaves room for tick labels and renders them
64
- (subject to `showTickMarks` and the 192px auto-compact threshold).
65
-
66
- When `false`, the chart renders edge-to-edge on sides without a slotted external
67
- scale AND axis tick labels are force-hidden so they cannot be clipped. This also
68
- suppresses the automatic edge-to-edge switch that normally happens below the
69
- 192px threshold, eliminating the visible padding "jump" when crossing it.
70
-
71
- Useful when embedding the chart inside another component that owns framing
72
- and never wants to show axis labels (e.g. `obc-automation-tank`).
73
-
74
- Defaults to `true` to preserve existing behavior. Declared with `attribute: false`
75
- because a `true`-default boolean cannot work as an HTML boolean attribute. */
61
+ /** Reserves canvas padding for axis tick labels on the sides that have no slotted external scale. `false` renders those sides edge-to-edge and hides the tick labels so they cannot be clipped, and it also suppresses the automatic edge-to-edge switch below the 192px threshold, removing the padding jump at that crossing. Set it when a host owns the framing and never wants axis labels, as `obc-automation-tank` does. */
76
62
  hasLabelPadding?: boolean;
77
63
  /**
78
64
  * Labels kept below the 192px threshold, where the axis labels are otherwise hidden: 'y' draws min, max and (inside the range) 0 in a gutter on the y-axis side; 'x' draws the first and last x value in a bottom gutter; 'xy' both. Ignored when `hasLabelPadding` is false.
@@ -118,10 +104,7 @@ because a `true`-default boolean cannot work as an HTML boolean attribute. */
118
104
  * Available when `instrumentMode==true`.
119
105
  */
120
106
  borderRadius?: number | undefined;
121
- /** Fill rendering mode for area charts.
122
- - `'semitransparent'`: 50% alpha fill (default)
123
- - `'solid'`: Opaque fill
124
- - `'threshold'`: single-series only, falls back to semitransparent for multi-series */
107
+ /** Fill rendering mode: `semitransparent` (default) fills at 50% alpha, `solid` fills opaque, and `threshold` colours above and below the threshold — single-series only, falling back to semitransparent when the chart has more than one series. */
125
108
  fillMode?: AreaFillMode;
126
109
  /** Stack multi-series datasets vertically on y-axis. Ignored for single-series and threshold fill mode. */
127
110
  stacked?: boolean;
@@ -63,22 +63,8 @@ import type {InstrumentState, Priority, FrameStyle, BorderRadiusPosition} from '
63
63
  showGridY?: boolean;
64
64
  /** Show axis tick marks and labels. */
65
65
  showTickMarks?: boolean;
66
- /** Reserve canvas padding for axis tick labels on sides without an external scale.
67
-
68
- When `true` (default), the chart leaves room for tick labels and renders them
69
- (subject to `showTickMarks` and the 192px auto-compact threshold).
70
-
71
- When `false`, the chart renders edge-to-edge on sides without a slotted external
72
- scale AND axis tick labels are force-hidden so they cannot be clipped. This also
73
- suppresses the automatic edge-to-edge switch that normally happens below the
74
- 192px threshold, eliminating the visible padding "jump" when crossing it.
75
-
76
- Useful when embedding the chart inside another component that owns framing
77
- and never wants to show axis labels (e.g. `obc-automation-tank`).
78
-
79
- Defaults to `true` to preserve existing behavior. Declared with `attribute: false`
80
- because a `true`-default boolean cannot work as an HTML boolean attribute. */
81
- hasLabelPadding?: boolean;
66
+ /** Reserves canvas padding for axis tick labels on the sides that have no slotted external scale. `false` renders those sides edge-to-edge and hides the tick labels so they cannot be clipped, and it also suppresses the automatic edge-to-edge switch below the 192px threshold, removing the padding jump at that crossing. Set it when a host owns the framing and never wants axis labels, as `obc-automation-tank` does. */
67
+ hasLabelPadding?: boolean;
82
68
  /**
83
69
  * Labels kept below the 192px threshold, where the axis labels are otherwise hidden: 'y' draws min, max and (inside the range) 0 in a gutter on the y-axis side; 'x' draws the first and last x value in a bottom gutter; 'xy' both. Ignored when `hasLabelPadding` is false.
84
70
  *
@@ -57,21 +57,7 @@ export interface Props {
57
57
  showGridY?: boolean;
58
58
  /** Show axis tick marks and labels. */
59
59
  showTickMarks?: boolean;
60
- /** Reserve canvas padding for axis tick labels on sides without an external scale.
61
-
62
- When `true` (default), the chart leaves room for tick labels and renders them
63
- (subject to `showTickMarks` and the 192px auto-compact threshold).
64
-
65
- When `false`, the chart renders edge-to-edge on sides without a slotted external
66
- scale AND axis tick labels are force-hidden so they cannot be clipped. This also
67
- suppresses the automatic edge-to-edge switch that normally happens below the
68
- 192px threshold, eliminating the visible padding "jump" when crossing it.
69
-
70
- Useful when embedding the chart inside another component that owns framing
71
- and never wants to show axis labels (e.g. `obc-automation-tank`).
72
-
73
- Defaults to `true` to preserve existing behavior. Declared with `attribute: false`
74
- because a `true`-default boolean cannot work as an HTML boolean attribute. */
60
+ /** Reserves canvas padding for axis tick labels on the sides that have no slotted external scale. `false` renders those sides edge-to-edge and hides the tick labels so they cannot be clipped, and it also suppresses the automatic edge-to-edge switch below the 192px threshold, removing the padding jump at that crossing. Set it when a host owns the framing and never wants axis labels, as `obc-automation-tank` does. */
75
61
  hasLabelPadding?: boolean;
76
62
  /**
77
63
  * Labels kept below the 192px threshold, where the axis labels are otherwise hidden: 'y' draws min, max and (inside the range) 0 in a gutter on the y-axis side; 'x' draws the first and last x value in a bottom gutter; 'xy' both. Ignored when `hasLabelPadding` is false.
@@ -63,22 +63,8 @@ import type {InstrumentState, Priority, FrameStyle, BorderRadiusPosition} from '
63
63
  showGridY?: boolean;
64
64
  /** Show axis tick marks and labels. */
65
65
  showTickMarks?: boolean;
66
- /** Reserve canvas padding for axis tick labels on sides without an external scale.
67
-
68
- When `true` (default), the chart leaves room for tick labels and renders them
69
- (subject to `showTickMarks` and the 192px auto-compact threshold).
70
-
71
- When `false`, the chart renders edge-to-edge on sides without a slotted external
72
- scale AND axis tick labels are force-hidden so they cannot be clipped. This also
73
- suppresses the automatic edge-to-edge switch that normally happens below the
74
- 192px threshold, eliminating the visible padding "jump" when crossing it.
75
-
76
- Useful when embedding the chart inside another component that owns framing
77
- and never wants to show axis labels (e.g. `obc-automation-tank`).
78
-
79
- Defaults to `true` to preserve existing behavior. Declared with `attribute: false`
80
- because a `true`-default boolean cannot work as an HTML boolean attribute. */
81
- hasLabelPadding?: boolean;
66
+ /** Reserves canvas padding for axis tick labels on the sides that have no slotted external scale. `false` renders those sides edge-to-edge and hides the tick labels so they cannot be clipped, and it also suppresses the automatic edge-to-edge switch below the 192px threshold, removing the padding jump at that crossing. Set it when a host owns the framing and never wants axis labels, as `obc-automation-tank` does. */
67
+ hasLabelPadding?: boolean;
82
68
  /**
83
69
  * Labels kept below the 192px threshold, where the axis labels are otherwise hidden: 'y' draws min, max and (inside the range) 0 in a gutter on the y-axis side; 'x' draws the first and last x value in a bottom gutter; 'xy' both. Ignored when `hasLabelPadding` is false.
84
70
  *
@@ -57,21 +57,7 @@ export interface Props {
57
57
  showGridY?: boolean;
58
58
  /** Show axis tick marks and labels. */
59
59
  showTickMarks?: boolean;
60
- /** Reserve canvas padding for axis tick labels on sides without an external scale.
61
-
62
- When `true` (default), the chart leaves room for tick labels and renders them
63
- (subject to `showTickMarks` and the 192px auto-compact threshold).
64
-
65
- When `false`, the chart renders edge-to-edge on sides without a slotted external
66
- scale AND axis tick labels are force-hidden so they cannot be clipped. This also
67
- suppresses the automatic edge-to-edge switch that normally happens below the
68
- 192px threshold, eliminating the visible padding "jump" when crossing it.
69
-
70
- Useful when embedding the chart inside another component that owns framing
71
- and never wants to show axis labels (e.g. `obc-automation-tank`).
72
-
73
- Defaults to `true` to preserve existing behavior. Declared with `attribute: false`
74
- because a `true`-default boolean cannot work as an HTML boolean attribute. */
60
+ /** Reserves canvas padding for axis tick labels on the sides that have no slotted external scale. `false` renders those sides edge-to-edge and hides the tick labels so they cannot be clipped, and it also suppresses the automatic edge-to-edge switch below the 192px threshold, removing the padding jump at that crossing. Set it when a host owns the framing and never wants axis labels, as `obc-automation-tank` does. */
75
61
  hasLabelPadding?: boolean;
76
62
  /**
77
63
  * Labels kept below the 192px threshold, where the axis labels are otherwise hidden: 'y' draws min, max and (inside the range) 0 in a gutter on the y-axis side; 'x' draws the first and last x value in a bottom gutter; 'xy' both. Ignored when `hasLabelPadding` is false.
@@ -9,10 +9,19 @@
9
9
  export interface Props {
10
10
  class?: string;
11
11
  style?: string;
12
+ /** Progress mode: `determinate`, `indeterminate` or `progressive-indeterminate`. */
12
13
  mode?: CircularProgressMode;
14
+ /**
15
+ * Progress in percent, clamped to 0–100.
16
+ *
17
+ * Available when `mode!=indeterminate`.
18
+ */
13
19
  value?: number;
20
+ /** Ring stroke width in viewBox units. */
14
21
  strokeWidth?: number;
22
+ /** Side of the square viewBox the ring is drawn in. */
15
23
  viewBoxSize?: number;
24
+ /** Extra inset in viewBox units, shrinking the ring inside its box. */
16
25
  padding?: number
17
26
  }
18
27
  export interface Events {
@@ -4,10 +4,19 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
+ /** Progress mode: `determinate`, `indeterminate` or `progressive-indeterminate`. */
7
8
  mode?: CircularProgressMode;
9
+ /**
10
+ * Progress in percent, clamped to 0–100.
11
+ *
12
+ * Available when `mode!=indeterminate`.
13
+ */
8
14
  value?: number;
15
+ /** Ring stroke width in viewBox units. */
9
16
  strokeWidth?: number;
17
+ /** Side of the square viewBox the ring is drawn in. */
10
18
  viewBoxSize?: number;
19
+ /** Extra inset in viewBox units, shrinking the ring inside its box. */
11
20
  padding?: number;
12
21
  }
13
22
  export interface Events {
@@ -12,16 +12,7 @@
12
12
  zoomToFitArc?: boolean;
13
13
  hasReadout?: boolean;
14
14
  priority?: Priority;
15
- /** Half-extent of the watch arc in degrees. The arc spans `centre ± arcAngle`
16
- and values are placed at their true position within it. Default `45`
17
- reproduces the historical 90°-wide arc.
18
-
19
- Smaller values render a narrower arc. Combined with `zoomToFitArc`, the
20
- narrower arc is enlarged (its radius grows) on its own layer, while the
21
- vessel image and the rotating indicator line stay at their natural size and
22
- position on a separate central layer. The two layers are intentionally
23
- visually disconnected. */
24
- arcAngle?: number
15
+ arcAngle?: number
25
16
  }
26
17
  export interface Events {
27
18
 
@@ -7,15 +7,6 @@ export interface Props {
7
7
  zoomToFitArc?: boolean;
8
8
  hasReadout?: boolean;
9
9
  priority?: Priority;
10
- /** Half-extent of the watch arc in degrees. The arc spans `centre ± arcAngle`
11
- and values are placed at their true position within it. Default `45`
12
- reproduces the historical 90°-wide arc.
13
-
14
- Smaller values render a narrower arc. Combined with `zoomToFitArc`, the
15
- narrower arc is enlarged (its radius grows) on its own layer, while the
16
- vessel image and the rotating indicator line stay at their natural size and
17
- position on a separate central layer. The two layers are intentionally
18
- visually disconnected. */
19
10
  arcAngle?: number;
20
11
  }
21
12
  export interface Events {
@@ -40,16 +40,10 @@ import type {AlertType} from '@oicl/openbridge-webcomponents/dist/types.js';
40
40
  hasStatusLabel?: boolean;
41
41
  /** Enables the leading icon slot in the header. */
42
42
  hasLeadingIcon?: boolean;
43
- /** Controls border radius/edge styling for stacking multiple accordions.
44
- - `regular` (default): Standard border radius.
45
- - `top`: Flat bottom edge (for top of a stack).
46
- - `bottom`: Flat top edge (for bottom of a stack).
47
- - `center`: Flat top and bottom edges (for middle of a stack). */
48
- position?: Position;
49
- /** Layout variant of the accordion card.
50
- - `single-line` (default): Compact header with only title.
51
- - `large`: Header includes a description beneath the title. */
52
- size?: AccordionSize;
43
+ /** Border radius for stacking: `regular` (default) rounds every corner, `top` flattens the bottom edge, `bottom` flattens the top edge, and `center` flattens both for a card in the middle of a stack. */
44
+ position?: Position;
45
+ /** Layout variant: `single-line` (default) is a compact title-only header, `large` adds a description beneath the title. */
46
+ size?: AccordionSize;
53
47
  /**
54
48
  * Type of the alert frame overlay (used when `hasAlert` is true). See `obc-alert-frame` for available types.
55
49
  *
@@ -32,15 +32,9 @@ export interface Props {
32
32
  hasStatusLabel?: boolean;
33
33
  /** Enables the leading icon slot in the header. */
34
34
  hasLeadingIcon?: boolean;
35
- /** Controls border radius/edge styling for stacking multiple accordions.
36
- - `regular` (default): Standard border radius.
37
- - `top`: Flat bottom edge (for top of a stack).
38
- - `bottom`: Flat top edge (for bottom of a stack).
39
- - `center`: Flat top and bottom edges (for middle of a stack). */
35
+ /** Border radius for stacking: `regular` (default) rounds every corner, `top` flattens the bottom edge, `bottom` flattens the top edge, and `center` flattens both for a card in the middle of a stack. */
40
36
  position?: Position;
41
- /** Layout variant of the accordion card.
42
- - `single-line` (default): Compact header with only title.
43
- - `large`: Header includes a description beneath the title. */
37
+ /** Layout variant: `single-line` (default) is a compact title-only header, `large` adds a description beneath the title. */
44
38
  size?: AccordionSize;
45
39
  /**
46
40
  * Type of the alert frame overlay (used when `hasAlert` is true). See `obc-alert-frame` for available types.
@@ -10,12 +10,12 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** Visual style of the button.
14
-
15
- - `flat`: Minimal, low-emphasis appearance (default).
16
- - `normal`: Standard, highlighted when active (`isActive` must be true for effect).
17
- - `enhanced`: Most prominent, accent background/border when active (`isActive` must be true for effect). */
18
- buttonStyle?: AdviceButtonStyle;
13
+ /**
14
+ * Visual style: `flat` (default) is minimal and low-emphasis, `normal` is standard and highlighted while active, `enhanced` is the most prominent with an accent background and border while active.
15
+ *
16
+ * Available when `isActive==true`.
17
+ */
18
+ buttonStyle?: AdviceButtonStyle;
19
19
  /** Number of advice items or notifications to display in the badge. Only shown when `showCount` is true and style is `normal` or `enhanced`. */
20
20
  count?: number;
21
21
  /**
@@ -4,11 +4,11 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** Visual style of the button.
8
-
9
- - `flat`: Minimal, low-emphasis appearance (default).
10
- - `normal`: Standard, highlighted when active (`isActive` must be true for effect).
11
- - `enhanced`: Most prominent, accent background/border when active (`isActive` must be true for effect). */
7
+ /**
8
+ * Visual style: `flat` (default) is minimal and low-emphasis, `normal` is standard and highlighted while active, `enhanced` is the most prominent with an accent background and border while active.
9
+ *
10
+ * Available when `isActive==true`.
11
+ */
12
12
  buttonStyle?: AdviceButtonStyle;
13
13
  /** Number of advice items or notifications to display in the badge. Only shown when `showCount` is true and style is `normal` or `enhanced`. */
14
14
  count?: number;
@@ -10,16 +10,10 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** Defines the visual and behavioral variant of the advice message.
14
- - `regular`: Standard advice message with a single advice icon.
15
- - `application`: Application-type advice message with an additional icon.
16
- Default: `regular`. */
17
- type?: ObcFloatingItemType;
18
- /** Sets the layout direction of the advice message.
19
- - `horizontal`: Content and icons are arranged side-by-side.
20
- - `vertical`: Content and icons are stacked vertically.
21
- Default: `horizontal`. */
22
- direction?: ObcFloatingItemDirection;
13
+ /** Variant of the advice message: `regular` (default) shows a single advice icon, `application` adds a second application icon. */
14
+ type?: ObcFloatingItemType;
15
+ /** Layout direction: `horizontal` (default) puts content and icons side-by-side, `vertical` stacks them. */
16
+ direction?: ObcFloatingItemDirection;
23
17
  /** If true, displays a timestamp label (e.g., "09:12:46") in the advice message. Default: false. */
24
18
  hasTimestamp?: boolean;
25
19
  /** If true (and `hasTimestamp` is also true), displays a day label (e.g., "Yesterday") in addition to the timestamp. Default: false. */
@@ -28,11 +22,8 @@ direction?: ObcFloatingItemDirection;
28
22
  action?: boolean;
29
23
  /** If true, renders a secondary action button in the advice message. Note: The secondary action is only shown if the primary action (`action`) is also enabled. Default: false. */
30
24
  action2?: boolean;
31
- /** Sets the content line type for the advice message.
32
- - `singleLine`: Compact, one-line message.
33
- - `multiLine`: Allows for longer, multi-line advice text.
34
- Default: `singleLine`. */
35
- lineType?: ObcFloatingItemLineType
25
+ /** Content line type: `single-line` (default) is a compact one-line message, `multi-line` allows longer advice text 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 visual and behavioral variant of the advice message.
8
- - `regular`: Standard advice message with a single advice icon.
9
- - `application`: Application-type advice message with an additional icon.
10
- Default: `regular`. */
7
+ /** Variant of the advice message: `regular` (default) shows a single advice icon, `application` adds a second application icon. */
11
8
  type?: ObcFloatingItemType;
12
- /** Sets the layout direction of the advice message.
13
- - `horizontal`: Content and icons are arranged side-by-side.
14
- - `vertical`: Content and icons are stacked vertically.
15
- Default: `horizontal`. */
9
+ /** Layout direction: `horizontal` (default) puts content and icons 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 advice message. Default: false. */
18
12
  hasTimestamp?: boolean;
@@ -22,10 +16,7 @@ Default: `horizontal`. */
22
16
  action?: boolean;
23
17
  /** If true, renders a secondary action button in the advice message. Note: The secondary action is only shown if the primary action (`action`) is also enabled. Default: false. */
24
18
  action2?: boolean;
25
- /** Sets the content line type for the advice message.
26
- - `singleLine`: Compact, one-line message.
27
- - `multiLine`: Allows for longer, multi-line advice text.
28
- Default: `singleLine`. */
19
+ /** Content line type: `single-line` (default) is a compact one-line message, `multi-line` allows longer advice text to wrap. */
29
20
  lineType?: ObcFloatingItemLineType;
30
21
  }
31
22
  export interface Events {
@@ -40,20 +40,10 @@
40
40
  * Available when `type==WithButton`.
41
41
  */
42
42
  actionLabel?: string;
43
- /** Display type of the advice message.
44
- - `simple`: Standard message with optional title, description, and timestamp.
45
- - `with-button`: Includes a text action button.
46
- - `with-icon-button`: Includes an icon action button.
47
- - `inactive`: Shows the empty/inactive state.
48
-
49
- Default: `simple` */
50
- type?: ObcAdviceMessageItemType;
51
- /** Size variant of the advice message.
52
- - `regular`: Default compact layout.
53
- - `tall`: Larger, more spacious layout.
54
-
55
- Default: `regular` */
56
- size?: ObcAdviceMessageItemSize;
43
+ /** Display type: `simple` (default) is title, description and timestamp, `with-button` adds a text action button, `with-icon-button` an icon action button, and `inactive` shows the empty state. */
44
+ type?: ObcAdviceMessageItemType;
45
+ /** Size variant: `regular` (default) is the compact layout, `tall` is the more spacious one. */
46
+ size?: ObcAdviceMessageItemSize;
57
47
  /**
58
48
  * Whether to show the title. If false, the title is hidden even if set.
59
49
  *
@@ -34,19 +34,9 @@ export interface Props {
34
34
  * Available when `type==WithButton`.
35
35
  */
36
36
  actionLabel?: string;
37
- /** Display type of the advice message.
38
- - `simple`: Standard message with optional title, description, and timestamp.
39
- - `with-button`: Includes a text action button.
40
- - `with-icon-button`: Includes an icon action button.
41
- - `inactive`: Shows the empty/inactive state.
42
-
43
- Default: `simple` */
37
+ /** Display type: `simple` (default) is title, description and timestamp, `with-button` adds a text action button, `with-icon-button` an icon action button, and `inactive` shows the empty state. */
44
38
  type?: ObcAdviceMessageItemType;
45
- /** Size variant of the advice message.
46
- - `regular`: Default compact layout.
47
- - `tall`: Larger, more spacious layout.
48
-
49
- Default: `regular` */
39
+ /** Size variant: `regular` (default) is the compact layout, `tall` is the more spacious one. */
50
40
  size?: ObcAdviceMessageItemSize;
51
41
  /**
52
42
  * Whether to show the title. If false, the title is hidden even if set.
@@ -12,29 +12,14 @@ import type {AlertType, FlashingSpeed} from '@oicl/openbridge-webcomponents/dist
12
12
  export interface Props {
13
13
  class?: string;
14
14
  style?: string;
15
- /** Visual variant of the alert frame.
16
- - `regular`: Outlined frame only.
17
- - `small-side-flip`: Small right-side flap with status icon.
18
- - `large-side-flip`: Large vertical right-side flap with status icon and optional custom icon.
19
- - `bottom-flip`: Bottom flap with status icon, label, and timer.
20
-
21
- Default: `small-side-flip` */
22
- type?: ObcAlertFrameType;
23
- /** Border thickness of the alert frame.
24
- - `small`: Thin border (default).
25
- - `large`: Thick border for higher emphasis. */
26
- thickness?: ObcAlertFrameThickness;
27
- /** Status of the alert, controlling color scheme and icon.
28
- - `alarm`: Highest severity (default).
29
- - `warning`: Medium severity.
30
- - `caution`: Lower severity.
31
- - `level-critical`, `level-high`, `level-medium`, `level-low`, `level-diagnostic`: level severity levels, styled to match their legacy equivalents. */
32
- status?: AlertType;
33
- /** Acknowledgement lifecycle state, controlling the frame's blinking/animation.
34
- - `acked-active`: Active and acknowledged (default); no blinking.
35
- - `unacked-active`: Active and not yet acknowledged; blinks.
36
- - `unacked-rectified`: Condition cleared but not yet acknowledged. */
37
- mode?: ObcAlertFrameMode;
15
+ /** Visual variant: `regular` is the outlined frame alone, `small-side-flip` (default) adds a small right-side flap with the status icon, `large-side-flip` a large vertical flap with an optional custom icon, and `bottom-flip` and `top-flip` a flap below or above carrying the status icon, an optional custom icon, a label and a timer. */
16
+ type?: ObcAlertFrameType;
17
+ /** Border thickness: `small` (default) is the thin border, `large` the thick one for higher emphasis. */
18
+ thickness?: ObcAlertFrameThickness;
19
+ /** Alert status, which picks the colour scheme and the icon: `alarm` (default) is the highest severity, then `warning` and `caution`. The `level-critical`, `level-high`, `level-medium`, `level-low` and `level-diagnostic` severities are styled to match their legacy equivalents. */
20
+ status?: AlertType;
21
+ /** Acknowledgement state, which drives the frame's flashing: `acked-active` (default) is active and acknowledged and never flashes, `unacked-active` is active and unacknowledged and flashes, and `unacked-rectified` is a cleared condition that has not been acknowledged. */
22
+ mode?: ObcAlertFrameMode;
38
23
  /** Flash tempo: `default` resolves from the alert type and mode (critical/alarm/high fast, warning/medium slow, low very slow, every rectified alert very slow, caution and diagnostic fixed), `fast`, `slow`, `very-slow` force a tempo, `fixed` never flashes. Acknowledged frames are always steady. */
39
24
  flashingSpeed?: FlashingSpeed;
40
25
  /** `outline` (default) grows the outline by 2 px, 1 px each side, while on in one step; `outline-eased` grows it over a 50 ms transition, a design-evaluation option. */
@@ -5,28 +5,13 @@ import type { Snippet } from 'svelte';
5
5
  export interface Props {
6
6
  class?: string;
7
7
  style?: string;
8
- /** Visual variant of the alert frame.
9
- - `regular`: Outlined frame only.
10
- - `small-side-flip`: Small right-side flap with status icon.
11
- - `large-side-flip`: Large vertical right-side flap with status icon and optional custom icon.
12
- - `bottom-flip`: Bottom flap with status icon, label, and timer.
13
-
14
- Default: `small-side-flip` */
8
+ /** Visual variant: `regular` is the outlined frame alone, `small-side-flip` (default) adds a small right-side flap with the status icon, `large-side-flip` a large vertical flap with an optional custom icon, and `bottom-flip` and `top-flip` a flap below or above carrying the status icon, an optional custom icon, a label and a timer. */
15
9
  type?: ObcAlertFrameType;
16
- /** Border thickness of the alert frame.
17
- - `small`: Thin border (default).
18
- - `large`: Thick border for higher emphasis. */
10
+ /** Border thickness: `small` (default) is the thin border, `large` the thick one for higher emphasis. */
19
11
  thickness?: ObcAlertFrameThickness;
20
- /** Status of the alert, controlling color scheme and icon.
21
- - `alarm`: Highest severity (default).
22
- - `warning`: Medium severity.
23
- - `caution`: Lower severity.
24
- - `level-critical`, `level-high`, `level-medium`, `level-low`, `level-diagnostic`: level severity levels, styled to match their legacy equivalents. */
12
+ /** Alert status, which picks the colour scheme and the icon: `alarm` (default) is the highest severity, then `warning` and `caution`. The `level-critical`, `level-high`, `level-medium`, `level-low` and `level-diagnostic` severities are styled to match their legacy equivalents. */
25
13
  status?: AlertType;
26
- /** Acknowledgement lifecycle state, controlling the frame's blinking/animation.
27
- - `acked-active`: Active and acknowledged (default); no blinking.
28
- - `unacked-active`: Active and not yet acknowledged; blinks.
29
- - `unacked-rectified`: Condition cleared but not yet acknowledged. */
14
+ /** Acknowledgement state, which drives the frame's flashing: `acked-active` (default) is active and acknowledged and never flashes, `unacked-active` is active and unacknowledged and flashes, and `unacked-rectified` is a cleared condition that has not been acknowledged. */
30
15
  mode?: ObcAlertFrameMode;
31
16
  /** Flash tempo: `default` resolves from the alert type and mode (critical/alarm/high fast, warning/medium slow, low very slow, every rectified alert very slow, caution and diagnostic fixed), `fast`, `slow`, `very-slow` force a tempo, `fixed` never flashes. Acknowledged frames are always steady. */
32
17
  flashingSpeed?: FlashingSpeed;