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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (170) hide show
  1. package/README.md +1 -1
  2. package/dist/automation/analog-valve/ObcAnalogValve.svelte +4 -4
  3. package/dist/automation/automation-button/ObcAbstractAutomationButton.svelte +4 -4
  4. package/dist/automation/automation-button/ObcAbstractAutomationButtonMotorized.svelte +4 -4
  5. package/dist/automation/automation-button/ObcAbstractAutomationButtonSquared.svelte +4 -4
  6. package/dist/automation/automation-tank/ObcAutomationTank.svelte +10 -65
  7. package/dist/automation/automation-tank/ObcAutomationTank.svelte.d.ts +5 -60
  8. package/dist/automation/bipolar-transistor/ObcBipolarTransistor.svelte +4 -4
  9. package/dist/automation/capacitor/ObcCapacitor.svelte +4 -4
  10. package/dist/automation/converter/ObcConverter.svelte +4 -4
  11. package/dist/automation/damper/ObcDamper.svelte +4 -4
  12. package/dist/automation/digital-valve/ObcDigitalValve.svelte +4 -4
  13. package/dist/automation/diodes/ObcDiodes.svelte +4 -4
  14. package/dist/automation/fan/ObcFan.svelte +4 -4
  15. package/dist/automation/filter/ObcFilter.svelte +4 -4
  16. package/dist/automation/ground/ObcGround.svelte +4 -4
  17. package/dist/automation/logic/ObcLogic.svelte +4 -4
  18. package/dist/automation/mosfet/ObcMosfet.svelte +4 -4
  19. package/dist/automation/motor/ObcMotor.svelte +4 -4
  20. package/dist/automation/pump/ObcPump.svelte +4 -4
  21. package/dist/automation/resistor/ObcResistor.svelte +4 -4
  22. package/dist/automation/router/ObcRouter.svelte +4 -4
  23. package/dist/automation/source/ObcSource.svelte +4 -4
  24. package/dist/automation/switch/ObcSwitch.svelte +4 -4
  25. package/dist/automation/transformer/ObcTransformer.svelte +4 -4
  26. package/dist/bars-graphs/area-graph/ObcAreaGraph.svelte +4 -21
  27. package/dist/bars-graphs/area-graph/ObcAreaGraph.svelte.d.ts +2 -19
  28. package/dist/bars-graphs/line-graph/ObcLineGraph.svelte +2 -16
  29. package/dist/bars-graphs/line-graph/ObcLineGraph.svelte.d.ts +1 -15
  30. package/dist/building-blocks/chart-line/ObcChartLineBase.svelte +2 -16
  31. package/dist/building-blocks/chart-line/ObcChartLineBase.svelte.d.ts +1 -15
  32. package/dist/building-blocks/circular-progress/ObcCircularProgress.svelte +9 -0
  33. package/dist/building-blocks/circular-progress/ObcCircularProgress.svelte.d.ts +9 -0
  34. package/dist/building-blocks/single-axis-inclinometer/SingleAxisInclinometer.svelte +1 -10
  35. package/dist/building-blocks/single-axis-inclinometer/SingleAxisInclinometer.svelte.d.ts +0 -9
  36. package/dist/components/accordion-card/ObcAccordionCard.svelte +4 -10
  37. package/dist/components/accordion-card/ObcAccordionCard.svelte.d.ts +2 -8
  38. package/dist/components/advice-button/ObcAdviceButton.svelte +6 -6
  39. package/dist/components/advice-button/ObcAdviceButton.svelte.d.ts +5 -5
  40. package/dist/components/advice-floating-item/ObcAdviceFloatingItem.svelte +6 -15
  41. package/dist/components/advice-floating-item/ObcAdviceFloatingItem.svelte.d.ts +3 -12
  42. package/dist/components/advice-message-item/ObcAdviceMessageItem.svelte +4 -14
  43. package/dist/components/advice-message-item/ObcAdviceMessageItem.svelte.d.ts +2 -12
  44. package/dist/components/alert-frame/ObcAlertFrame.svelte +8 -23
  45. package/dist/components/alert-frame/ObcAlertFrame.svelte.d.ts +4 -19
  46. package/dist/components/alert-menu/ObcAlertMenu.svelte +8 -20
  47. package/dist/components/alert-menu/ObcAlertMenu.svelte.d.ts +4 -16
  48. package/dist/components/alert-menu-item/ObcAlertMenuItem.svelte +4 -4
  49. package/dist/components/alert-menu-item/ObcAlertMenuItem.svelte.d.ts +2 -2
  50. package/dist/components/app-button/ObcAppButton.svelte +6 -2
  51. package/dist/components/app-button/ObcAppButton.svelte.d.ts +5 -1
  52. package/dist/components/badge/ObcBadge.svelte +16 -28
  53. package/dist/components/badge/ObcBadge.svelte.d.ts +10 -22
  54. package/dist/components/breadcrumb/ObcBreadcrumb.svelte +2 -6
  55. package/dist/components/breadcrumb/ObcBreadcrumb.svelte.d.ts +1 -5
  56. package/dist/components/button/ObcButton.svelte +4 -11
  57. package/dist/components/button/ObcButton.svelte.d.ts +2 -9
  58. package/dist/components/card/ObcCard.svelte +14 -12
  59. package/dist/components/card/ObcCard.svelte.d.ts +11 -9
  60. package/dist/components/check-button/ObcCheckButton.svelte +4 -8
  61. package/dist/components/check-button/ObcCheckButton.svelte.d.ts +2 -6
  62. package/dist/components/checkbox/ObcCheckbox.svelte +6 -13
  63. package/dist/components/checkbox/ObcCheckbox.svelte.d.ts +3 -10
  64. package/dist/components/command-button/ObcCommandButton.svelte +2 -7
  65. package/dist/components/command-button/ObcCommandButton.svelte.d.ts +1 -6
  66. package/dist/components/context-menu-input/ObcContextMenuInput.svelte +24 -42
  67. package/dist/components/context-menu-input/ObcContextMenuInput.svelte.d.ts +16 -34
  68. package/dist/components/date-item/ObcDateItem.svelte +2 -4
  69. package/dist/components/date-item/ObcDateItem.svelte.d.ts +1 -3
  70. package/dist/components/dropdown-button/ObcDropdownButton.svelte +4 -13
  71. package/dist/components/dropdown-button/ObcDropdownButton.svelte.d.ts +2 -11
  72. package/dist/components/elevated-card/ObcElevatedCard.svelte +6 -19
  73. package/dist/components/elevated-card/ObcElevatedCard.svelte.d.ts +3 -16
  74. package/dist/components/elevated-card-radio-group/ObcElevatedCardRadioGroup.svelte +4 -8
  75. package/dist/components/elevated-card-radio-group/ObcElevatedCardRadioGroup.svelte.d.ts +2 -6
  76. package/dist/components/event-list/ObcEventList.svelte +2 -2
  77. package/dist/components/event-list/ObcEventList.svelte.d.ts +1 -1
  78. package/dist/components/floating-item/ObcFloatingItem.svelte +6 -18
  79. package/dist/components/floating-item/ObcFloatingItem.svelte.d.ts +3 -15
  80. package/dist/components/icon-button/ObcIconButton.svelte +2 -5
  81. package/dist/components/icon-button/ObcIconButton.svelte.d.ts +1 -4
  82. package/dist/components/icon-check-button/ObcIconCheckButton.svelte +16 -24
  83. package/dist/components/icon-check-button/ObcIconCheckButton.svelte.d.ts +10 -18
  84. package/dist/components/menu-button/ObcMenuButton.svelte +4 -17
  85. package/dist/components/menu-button/ObcMenuButton.svelte.d.ts +2 -15
  86. package/dist/components/navigation-item/ObcNavigationItem.svelte +2 -2
  87. package/dist/components/navigation-item/ObcNavigationItem.svelte.d.ts +1 -1
  88. package/dist/components/navigation-item-group/ObcNavigationItemGroup.svelte +2 -2
  89. package/dist/components/navigation-item-group/ObcNavigationItemGroup.svelte.d.ts +1 -1
  90. package/dist/components/navigation-menu/ObcNavigationMenu.svelte +2 -8
  91. package/dist/components/navigation-menu/ObcNavigationMenu.svelte.d.ts +1 -7
  92. package/dist/components/notification-badge-button/ObcNotificationBadgeButton.svelte +2 -2
  93. package/dist/components/notification-badge-button/ObcNotificationBadgeButton.svelte.d.ts +2 -2
  94. package/dist/components/notification-button/ObcNotificationButton.svelte +22 -35
  95. package/dist/components/notification-button/ObcNotificationButton.svelte.d.ts +17 -30
  96. package/dist/components/notification-floating-item/ObcNotificationFloatingItem.svelte +6 -15
  97. package/dist/components/notification-floating-item/ObcNotificationFloatingItem.svelte.d.ts +3 -12
  98. package/dist/components/notification-message-item/ObcNotificationMessageItem.svelte +4 -10
  99. package/dist/components/notification-message-item/ObcNotificationMessageItem.svelte.d.ts +2 -8
  100. package/dist/components/pagination/ObcPagination.svelte +8 -26
  101. package/dist/components/pagination/ObcPagination.svelte.d.ts +4 -22
  102. package/dist/components/pivot-item/ObcPivotItem.svelte +14 -29
  103. package/dist/components/pivot-item/ObcPivotItem.svelte.d.ts +7 -22
  104. package/dist/components/progress-bar/ObcProgressBar.svelte +6 -5
  105. package/dist/components/progress-bar/ObcProgressBar.svelte.d.ts +5 -4
  106. package/dist/components/rich-button/ObcRichButton.svelte +2 -4
  107. package/dist/components/rich-button/ObcRichButton.svelte.d.ts +1 -3
  108. package/dist/components/slider/ObcSlider.svelte +32 -46
  109. package/dist/components/slider/ObcSlider.svelte.d.ts +22 -36
  110. package/dist/components/slider-double/ObcSliderDouble.svelte +7 -21
  111. package/dist/components/slider-double/ObcSliderDouble.svelte.d.ts +4 -18
  112. package/dist/components/start-stop-switch/ObcStartStopSwitch.svelte +18 -48
  113. package/dist/components/start-stop-switch/ObcStartStopSwitch.svelte.d.ts +11 -41
  114. package/dist/components/stepper-box/ObcStepperBox.svelte +2 -7
  115. package/dist/components/stepper-box/ObcStepperBox.svelte.d.ts +1 -6
  116. package/dist/components/system-button/ObcSystemButton.svelte +4 -14
  117. package/dist/components/system-button/ObcSystemButton.svelte.d.ts +2 -12
  118. package/dist/components/tab-item/ObcTabItem.svelte +30 -66
  119. package/dist/components/tab-item/ObcTabItem.svelte.d.ts +17 -53
  120. package/dist/components/tab-row/ObcTabRow.svelte +12 -36
  121. package/dist/components/tab-row/ObcTabRow.svelte.d.ts +6 -30
  122. package/dist/components/toggle-button-group/ObcToggleButtonGroup.svelte +18 -54
  123. package/dist/components/toggle-button-group/ObcToggleButtonGroup.svelte.d.ts +9 -45
  124. package/dist/components/toggle-button-vertical-group/ObcToggleButtonVerticalGroup.svelte +10 -26
  125. package/dist/components/toggle-button-vertical-group/ObcToggleButtonVerticalGroup.svelte.d.ts +5 -21
  126. package/dist/components/toggle-button-vertical-option/ObcToggleButtonVerticalOption.svelte +2 -4
  127. package/dist/components/toggle-button-vertical-option/ObcToggleButtonVerticalOption.svelte.d.ts +1 -3
  128. package/dist/components/toggletip/ObcToggletip.svelte +2 -10
  129. package/dist/components/toggletip/ObcToggletip.svelte.d.ts +1 -9
  130. package/dist/components/tooltip/ObcTooltip.svelte +16 -28
  131. package/dist/components/tooltip/ObcTooltip.svelte.d.ts +12 -24
  132. package/dist/components/top-bar/ObcTopBar.svelte +84 -48
  133. package/dist/components/top-bar/ObcTopBar.svelte.d.ts +45 -9
  134. package/dist/components/topbar-message-item/ObcTopbarMessageItem.svelte +4 -16
  135. package/dist/components/topbar-message-item/ObcTopbarMessageItem.svelte.d.ts +2 -14
  136. package/dist/components/tree-navigation-group/ObcTreeNavigationGroup.svelte +2 -2
  137. package/dist/components/tree-navigation-group/ObcTreeNavigationGroup.svelte.d.ts +1 -1
  138. package/dist/components/tree-navigation-item/ObcTreeNavigationItem.svelte +2 -2
  139. package/dist/components/tree-navigation-item/ObcTreeNavigationItem.svelte.d.ts +1 -1
  140. package/dist/components/user-button/ObcUserButton.svelte +6 -13
  141. package/dist/components/user-button/ObcUserButton.svelte.d.ts +3 -10
  142. package/dist/components/vendor-button/ObcVendorButton.svelte +4 -8
  143. package/dist/components/vendor-button/ObcVendorButton.svelte.d.ts +2 -6
  144. package/dist/integration-systems/integration-dropdown-button/ObcIntegrationDropdownButton.svelte +2 -8
  145. package/dist/integration-systems/integration-dropdown-button/ObcIntegrationDropdownButton.svelte.d.ts +1 -7
  146. package/dist/navigation-instruments/compass/ObcCompass.svelte +6 -8
  147. package/dist/navigation-instruments/compass/ObcCompass.svelte.d.ts +5 -7
  148. package/dist/navigation-instruments/compass-indicator/ObcCompassIndicator.svelte +2 -7
  149. package/dist/navigation-instruments/compass-indicator/ObcCompassIndicator.svelte.d.ts +1 -6
  150. package/dist/navigation-instruments/compass-sector/ObcCompassSector.svelte +6 -7
  151. package/dist/navigation-instruments/compass-sector/ObcCompassSector.svelte.d.ts +5 -6
  152. package/dist/navigation-instruments/gauge-radial/ObcGaugeRadial.svelte +12 -23
  153. package/dist/navigation-instruments/gauge-radial/ObcGaugeRadial.svelte.d.ts +5 -16
  154. package/dist/navigation-instruments/gauge-trend/ObcGaugeTrend.svelte +28 -51
  155. package/dist/navigation-instruments/gauge-trend/ObcGaugeTrend.svelte.d.ts +22 -45
  156. package/dist/navigation-instruments/pitch/ObcPitch.svelte +2 -10
  157. package/dist/navigation-instruments/pitch/ObcPitch.svelte.d.ts +1 -9
  158. package/dist/navigation-instruments/pitch-roll/ObcPitchRoll.svelte +4 -4
  159. package/dist/navigation-instruments/pitch-roll/ObcPitchRoll.svelte.d.ts +2 -2
  160. package/dist/navigation-instruments/roll/ObcRoll.svelte +2 -10
  161. package/dist/navigation-instruments/roll/ObcRoll.svelte.d.ts +1 -9
  162. package/dist/navigation-instruments/rot-indicator/ObcRotIndicator.svelte +2 -6
  163. package/dist/navigation-instruments/rot-indicator/ObcRotIndicator.svelte.d.ts +1 -5
  164. package/dist/navigation-instruments/rot-sector/ObcRotSector.svelte +16 -20
  165. package/dist/navigation-instruments/rot-sector/ObcRotSector.svelte.d.ts +4 -8
  166. package/dist/navigation-instruments/speed-gauge/ObcSpeedGauge.svelte +14 -20
  167. package/dist/navigation-instruments/speed-gauge/ObcSpeedGauge.svelte.d.ts +3 -9
  168. package/dist/navigation-instruments/wind-indicator/ObcWindIndicator.svelte +6 -22
  169. package/dist/navigation-instruments/wind-indicator/ObcWindIndicator.svelte.d.ts +3 -19
  170. package/package.json +2 -2
@@ -4,31 +4,13 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** The variant type of context menu to display.
8
-
9
- - `'regular'`: Single-select navigation menu.
10
- - `'checkboxes'`: Multi-select with checkboxes.
11
- - `'nested-checkboxes'`: Multi-select with nested/hierarchical checkboxes.
12
- - `'flyout'`: Menu with expandable/cascading groups.
13
- - `'multi'`: Multi-column menu.
14
- - `'multi-with-subtitles'`: Multi-column menu with group subtitles.
15
-
16
- Defaults to `'regular'`. */
7
+ /** 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. */
17
8
  type?: ContextMenuType;
18
- /** Array of menu options to display.
19
-
20
- Each option should have a unique `value`, a `label`, and can optionally include:
21
- - `icon`: TemplateResult for a leading icon (e.g., `<obi-placeholder slot="icon"></obi-placeholder>`)
22
- - `level`: For nested checkboxes, indicates nesting depth.
23
- - `children`: For flyout/nested menus, an array of child options. */
9
+ /** 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. */
24
10
  options?: ContextMenuOption[];
25
- /** Array of currently selected option values.
26
-
27
- For multi-select variants, can contain multiple values. For single-select, contains at most one value. */
11
+ /** Array of currently selected option values. For multi-select variants, can contain multiple values. For single-select, contains at most one value. */
28
12
  selectedValues?: string[];
29
- /** Whether to show a title bar with close button at the top of the menu.
30
-
31
- If true, displays the `title` property and a close icon button. */
13
+ /** 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. */
32
14
  hasTitleBar?: boolean;
33
15
  /**
34
16
  * Title text displayed in the title bar (if `hasTitleBar` is true).
@@ -36,21 +18,21 @@ If true, displays the `title` property and a close icon button. */
36
18
  * Available when `hasTitleBar==true`.
37
19
  */
38
20
  title?: string;
39
- /** Array of column groups for the `multi-with-subtitles` layout.
40
-
41
- Each group defines a `title`, `columns` (number of columns in the group), and `options` (array of options for that group). */
21
+ /**
22
+ * 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).
23
+ *
24
+ * Available when `type==MultiWithSubtitles`.
25
+ */
42
26
  columnGroups?: ColumnGroup[];
43
- /** Number of items per column in multi-column layouts.
44
-
45
- Used in `multi` and `multi-with-subtitles` variants to control column splitting. */
27
+ /**
28
+ * Number of items per column in multi-column layouts. Used in `multi` and `multi-with-subtitles` variants to control column splitting.
29
+ *
30
+ * Available when `type in [Multi, MultiWithSubtitles]`.
31
+ */
46
32
  itemsPerColumn?: number;
47
- /** Whether multiple selections are allowed.
48
-
49
- If not set, defaults to true for checkbox/multi variants, false for regular/flyout. */
33
+ /** Whether multiple selections are allowed. If not set, defaults to true for checkbox/multi variants, false for regular/flyout. */
50
34
  multiSelect?: boolean | undefined;
51
- /** If true, restricts selection to one option per group or column (used in flyout and multi-column).
52
-
53
- When enabled, only one option can be selected in each group or column. */
35
+ /** 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. */
54
36
  selectPerGroup?: boolean | undefined;
55
37
  }
56
38
  export interface Events {
@@ -11,10 +11,8 @@ import type {DateItemSize} from '@oicl/openbridge-webcomponents/dist/components/
11
11
  export interface Props {
12
12
  class?: string;
13
13
  style?: string;
14
- /** The size of the date item, controlling its layout and whether event details are shown.
15
- - `small`: Compact, shows only the date and event dots.
16
- - `large`: Expands to show event titles and descriptions for up to two events. */
17
- size?: DateItemSize;
14
+ /** Size of the date item: `small` (default) shows only the date and the event dots, `large` shows titles and descriptions for as many events as its height fits and aggregates the rest into a count. */
15
+ size?: DateItemSize;
18
16
  /** Whether the date item is disabled. When true, the button is visually muted and not interactive. */
19
17
  disabled?: boolean;
20
18
  /** Array of events to display on this date. In small size, shows an event dot indicator. In large size, displays event details using obc-event-item components. */
@@ -5,9 +5,7 @@ import type { Snippet } from 'svelte';
5
5
  export interface Props {
6
6
  class?: string;
7
7
  style?: string;
8
- /** The size of the date item, controlling its layout and whether event details are shown.
9
- - `small`: Compact, shows only the date and event dots.
10
- - `large`: Expands to show event titles and descriptions for up to two events. */
8
+ /** Size of the date item: `small` (default) shows only the date and the event dots, `large` shows titles and descriptions for as many events as its height fits and aggregates the rest into a count. */
11
9
  size?: DateItemSize;
12
10
  /** Whether the date item is disabled. When true, the button is visually muted and not interactive. */
13
11
  disabled?: boolean;
@@ -10,14 +10,8 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** List of selectable options. Each option is an object with a `value` (string), `label` (string), and optional `level` (number) for indentation/grouping.
14
-
15
- Example:
16
- [
17
- { value: 'volvo', label: 'Volvo' },
18
- { value: 'xc90', label: 'XC 90', level: 2 }
19
- ] */
20
- options?: DropdownButtonOption[];
13
+ /** Selectable options, each with a `value`, a `label` and an optional `level` that indents it under the preceding option — `{value: 'xc90', label: 'XC 90', level: 2}` renders as a child row. */
14
+ options?: DropdownButtonOption[];
21
15
  /** The value of the currently selected option. If not set, defaults to the first option in the list unless `allowEmptySelection` is true. */
22
16
  value?: string | undefined;
23
17
  disabled?: boolean;
@@ -27,11 +21,8 @@ options?: DropdownButtonOption[];
27
21
  allowEmptySelection?: boolean;
28
22
  /** Text shown when nothing is selected and `allowEmptySelection` is true. Default is an empty string. */
29
23
  placeholder?: string;
30
- /** Controls the button's display type.
31
- - `label`: Text label only (default)
32
- - `icon`: Icon only, no label
33
- - `label-icon`: Icon before the label */
34
- type?: DropdownButtonType;
24
+ /** Display type: `label` (default) is text only, `icon` is the icon alone, `label-icon` puts the icon before the label. */
25
+ type?: DropdownButtonType;
35
26
  /** If true, the dropdown menu opens above the button. */
36
27
  openTop?: boolean;
37
28
  /** If true, the select is integration style. Default is false, only for integration bar. */
@@ -4,13 +4,7 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** List of selectable options. Each option is an object with a `value` (string), `label` (string), and optional `level` (number) for indentation/grouping.
8
-
9
- Example:
10
- [
11
- { value: 'volvo', label: 'Volvo' },
12
- { value: 'xc90', label: 'XC 90', level: 2 }
13
- ] */
7
+ /** Selectable options, each with a `value`, a `label` and an optional `level` that indents it under the preceding option — `{value: 'xc90', label: 'XC 90', level: 2}` renders as a child row. */
14
8
  options?: DropdownButtonOption[];
15
9
  /** The value of the currently selected option. If not set, defaults to the first option in the list unless `allowEmptySelection` is true. */
16
10
  value?: string | undefined;
@@ -21,10 +15,7 @@ Example:
21
15
  allowEmptySelection?: boolean;
22
16
  /** Text shown when nothing is selected and `allowEmptySelection` is true. Default is an empty string. */
23
17
  placeholder?: string;
24
- /** Controls the button's display type.
25
- - `label`: Text label only (default)
26
- - `icon`: Icon only, no label
27
- - `label-icon`: Icon before the label */
18
+ /** Display type: `label` (default) is text only, `icon` is the icon alone, `label-icon` puts the icon before the label. */
28
19
  type?: DropdownButtonType;
29
20
  /** If true, the dropdown menu opens above the button. */
30
21
  openTop?: boolean;
@@ -10,25 +10,12 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** Controls the card's visual grouping and border radius.
14
- - `regular` (default): Standard card, not visually grouped.
15
- - `top`: Card is visually grouped at the top of a section or stack.
16
- - `bottom`: Card is visually grouped at the bottom of a section or stack.
17
- - `center`: Card is visually grouped in the middle of a section or stack. */
18
- position?: ObcElevatedCardPosition;
19
- /** Controls the card's content layout:
20
- - `single-line`: Label only, compact.
21
- - `double-line`: Label + single-line description.
22
- - `multi-line`: Label + multi-line description.
23
- Default is `single-line`. */
24
- size?: ObcElevatedCardSize;
25
- /** Overrides the HTML tag used to render the card.
26
- - `button`: Renders as a <button> (default for clickable cards).
27
- - `a`: Renders as an <a> anchor (when `href` is set).
28
- - `article`: Renders as an <article> (for non-interactive or action cards).
29
- - `div`: Renders as a <div> (generic container).
30
- If not set, the tag is determined automatically based on `href` and `isClickable`. */
31
- overrideTag?: ObcElevatedCardTag | undefined;
13
+ /** Visual grouping and border radius: `regular` (default) is an ungrouped card, while `top`, `center` and `bottom` shape it for the first, an inner and the last card of a stack. */
14
+ position?: ObcElevatedCardPosition;
15
+ /** Content layout: `single-line` (default) is the label alone, `double-line` adds a one-line description, `multi-line` a wrapping one. */
16
+ size?: ObcElevatedCardSize;
17
+ /** Forces the card's host tag to `button`, `a`, `article` or `div`. Left unset, the tag follows `href` and `isClickable`: an anchor when `href` is set, a button when clickable, an article otherwise. */
18
+ overrideTag?: ObcElevatedCardTag | undefined;
32
19
  /** If false, the card is rendered as a static (non-clickable) element and uses `<article>` as its tag unless `overrideTag` is set. Useful for informational or status cards that should not be interactive. */
33
20
  isClickable?: boolean;
34
21
  /** Applies an informational style to the card. When true, the card uses the "info" visual style. */
@@ -4,24 +4,11 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** Controls the card's visual grouping and border radius.
8
- - `regular` (default): Standard card, not visually grouped.
9
- - `top`: Card is visually grouped at the top of a section or stack.
10
- - `bottom`: Card is visually grouped at the bottom of a section or stack.
11
- - `center`: Card is visually grouped in the middle of a section or stack. */
7
+ /** Visual grouping and border radius: `regular` (default) is an ungrouped card, while `top`, `center` and `bottom` shape it for the first, an inner and the last card of a stack. */
12
8
  position?: ObcElevatedCardPosition;
13
- /** Controls the card's content layout:
14
- - `single-line`: Label only, compact.
15
- - `double-line`: Label + single-line description.
16
- - `multi-line`: Label + multi-line description.
17
- Default is `single-line`. */
9
+ /** Content layout: `single-line` (default) is the label alone, `double-line` adds a one-line description, `multi-line` a wrapping one. */
18
10
  size?: ObcElevatedCardSize;
19
- /** Overrides the HTML tag used to render the card.
20
- - `button`: Renders as a <button> (default for clickable cards).
21
- - `a`: Renders as an <a> anchor (when `href` is set).
22
- - `article`: Renders as an <article> (for non-interactive or action cards).
23
- - `div`: Renders as a <div> (generic container).
24
- If not set, the tag is determined automatically based on `href` and `isClickable`. */
11
+ /** Forces the card's host tag to `button`, `a`, `article` or `div`. Left unset, the tag follows `href` and `isClickable`: an anchor when `href` is set, a button when clickable, an article otherwise. */
25
12
  overrideTag?: ObcElevatedCardTag | undefined;
26
13
  /** If false, the card is rendered as a static (non-clickable) element and uses `<article>` as its tag unless `overrideTag` is set. Useful for informational or status cards that should not be interactive. */
27
14
  isClickable?: boolean;
@@ -9,14 +9,10 @@
9
9
  export interface Props {
10
10
  class?: string;
11
11
  style?: string;
12
- /** Array of options to display as card radios. Each option should be an object with a `label` (displayed text) and a `value` (submitted value).
13
-
14
- Example: `[{label: 'Option 1', value: '1'}, {label: 'Option 2', value: '2'}]` */
15
- options?: ElevatedCardRadioGroupOption[];
16
- /** Shared name for all radio inputs in the group. Ensures native radio group behavior and correct form submission.
17
-
18
- Default: `'default'` */
19
- name?: string;
12
+ /** Array of options to display as card radios. Each option should be an object with a `label` (displayed text) and a `value` (submitted value). Example: `[{label: 'Option 1', value: '1'}, {label: 'Option 2', value: '2'}]` */
13
+ options?: ElevatedCardRadioGroupOption[];
14
+ /** Shared name for all radio inputs in the group. Ensures native radio group behavior and correct form submission. */
15
+ name?: string;
20
16
  /** The currently selected value. Setting this will pre-select the corresponding card radio. */
21
17
  value?: string;
22
18
  /** Disables all options in the group when true. */
@@ -4,13 +4,9 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** Array of options to display as card radios. Each option should be an object with a `label` (displayed text) and a `value` (submitted value).
8
-
9
- Example: `[{label: 'Option 1', value: '1'}, {label: 'Option 2', value: '2'}]` */
7
+ /** Array of options to display as card radios. Each option should be an object with a `label` (displayed text) and a `value` (submitted value). Example: `[{label: 'Option 1', value: '1'}, {label: 'Option 2', value: '2'}]` */
10
8
  options?: ElevatedCardRadioGroupOption[];
11
- /** Shared name for all radio inputs in the group. Ensures native radio group behavior and correct form submission.
12
-
13
- Default: `'default'` */
9
+ /** Shared name for all radio inputs in the group. Ensures native radio group behavior and correct form submission. */
14
10
  name?: string;
15
11
  /** The currently selected value. Setting this will pre-select the corresponding card radio. */
16
12
  value?: string;
@@ -15,8 +15,8 @@
15
15
  date?: number | Date;
16
16
  /** Array of events to display in the list. */
17
17
  events?: DateItemEvent[];
18
- /** Locale for date formatting. Uses browser default if not specified. */
19
- locale?: string | undefined
18
+ /** Locale for date formatting, such as `en-US`, `nb-NO` or `de-DE`. Uses the browser default when unset. */
19
+ locale?: string | undefined
20
20
  }
21
21
  export interface Events {
22
22
 
@@ -10,7 +10,7 @@ export interface Props {
10
10
  date?: number | Date;
11
11
  /** Array of events to display in the list. */
12
12
  events?: DateItemEvent[];
13
- /** Locale for date formatting. Uses browser default if not specified. */
13
+ /** Locale for date formatting, such as `en-US`, `nb-NO` or `de-DE`. Uses the browser default when unset. */
14
14
  locale?: string | undefined;
15
15
  }
16
16
  export interface Events {
@@ -10,18 +10,10 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** Visual style of the message.
14
- - `regular` (default): Standard notification with a single icon.
15
- - `application`: Enhanced style with primary and secondary icons.
16
-
17
- Use `application` when you want to visually distinguish system-level or application-specific messages. */
18
- type?: ObcFloatingItemType;
19
- /** Layout direction of the component.
20
- - `horizontal` (default): Icon/content/actions arranged side-by-side.
21
- - `vertical`: Icon/content stacked, actions below.
22
-
23
- Choose `vertical` for narrow containers or when space is limited. */
24
- direction?: ObcFloatingItemDirection;
13
+ /** Visual style: `regular` (default) is a standard notification with a single icon, `application` carries a primary and a secondary icon — use it to set system-level or application-specific messages apart. */
14
+ type?: ObcFloatingItemType;
15
+ /** Layout direction: `horizontal` (default) puts icon, content and actions side-by-side, `vertical` stacks icon and content with the actions below — the better fit for a narrow container. */
16
+ direction?: ObcFloatingItemDirection;
25
17
  /** Shows a timestamp (slot `time`) when `true`. Enable to display a time label next to the title. */
26
18
  hasTimestamp?: boolean;
27
19
  /**
@@ -38,12 +30,8 @@ direction?: ObcFloatingItemDirection;
38
30
  * Available when `action==true`.
39
31
  */
40
32
  action2?: boolean;
41
- /** Line wrapping style for the message content.
42
- - `single-line` (default): Truncates to one line.
43
- - `multi-line`: Allows up to 8 lines of content.
44
-
45
- Use `multi-line` for longer messages or detailed descriptions. */
46
- lineType?: ObcFloatingItemLineType
33
+ /** Line wrapping for the message content: `single-line` (default) truncates to one line, `multi-line` allows up to eight. */
34
+ lineType?: ObcFloatingItemLineType
47
35
  }
48
36
  export interface Events {
49
37
  onActionClick?: (event: CustomEvent<void>) => void;
@@ -4,17 +4,9 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** Visual style of the message.
8
- - `regular` (default): Standard notification with a single icon.
9
- - `application`: Enhanced style with primary and secondary icons.
10
-
11
- Use `application` when you want to visually distinguish system-level or application-specific messages. */
7
+ /** Visual style: `regular` (default) is a standard notification with a single icon, `application` carries a primary and a secondary icon — use it to set system-level or application-specific messages apart. */
12
8
  type?: ObcFloatingItemType;
13
- /** Layout direction of the component.
14
- - `horizontal` (default): Icon/content/actions arranged side-by-side.
15
- - `vertical`: Icon/content stacked, actions below.
16
-
17
- Choose `vertical` for narrow containers or when space is limited. */
9
+ /** Layout direction: `horizontal` (default) puts icon, content and actions side-by-side, `vertical` stacks icon and content with the actions below — the better fit for a narrow container. */
18
10
  direction?: ObcFloatingItemDirection;
19
11
  /** Shows a timestamp (slot `time`) when `true`. Enable to display a time label next to the title. */
20
12
  hasTimestamp?: boolean;
@@ -32,11 +24,7 @@ Choose `vertical` for narrow containers or when space is limited. */
32
24
  * Available when `action==true`.
33
25
  */
34
26
  action2?: boolean;
35
- /** Line wrapping style for the message content.
36
- - `single-line` (default): Truncates to one line.
37
- - `multi-line`: Allows up to 8 lines of content.
38
-
39
- Use `multi-line` for longer messages or detailed descriptions. */
27
+ /** Line wrapping for the message content: `single-line` (default) truncates to one line, `multi-line` allows up to eight. */
40
28
  lineType?: ObcFloatingItemLineType;
41
29
  }
42
30
  export interface Events {
@@ -10,11 +10,8 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** Visual style of the button.
14
- - `normal`: Standard appearance (default).
15
- - `raised`: Elevated with shadow.
16
- - `flat`: Minimal, backgroundless style. */
17
- variant?: IconButtonVariant;
13
+ /** Visual style: `normal` (default) is the standard appearance, `raised` adds a shadow, `flat` drops the background. */
14
+ variant?: IconButtonVariant;
18
15
  /** Whether the button is in an activated (selected/toggled) state. Visually highlights the button to indicate selection. */
19
16
  activated?: boolean;
20
17
  /** If true, aligns the button to the left edge and removes left border radius. Useful for grouping or edge-aligned layouts. */
@@ -4,10 +4,7 @@ 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
- - `normal`: Standard appearance (default).
9
- - `raised`: Elevated with shadow.
10
- - `flat`: Minimal, backgroundless style. */
7
+ /** Visual style: `normal` (default) is the standard appearance, `raised` adds a shadow, `flat` drops the background. */
11
8
  variant?: IconButtonVariant;
12
9
  /** Whether the button is in an activated (selected/toggled) state. Visually highlights the button to indicate selection. */
13
10
  activated?: boolean;
@@ -10,30 +10,22 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** Whether the button is currently checked (selected).
14
-
15
- When true, the button displays its checked styling. Toggling this property updates the visual state. */
16
- checked?: boolean;
17
- /** If true, prevents interaction and shows disabled styling.
18
-
19
- When disabled, the button cannot be toggled and appears dimmed. */
20
- disabled?: boolean;
21
- /** If true, displays the label text below the icon.
22
-
23
- When false, only the icon is shown (icon-only mode). */
24
- hasLabel?: boolean;
25
- /** Text to display below the icon (when `hasLabel` is true).
26
-
27
- Used to describe the toggle action or state for clarity and accessibility. */
28
- label?: string;
29
- /** If true, adds alert styling to the button.
30
-
31
- Use to visually indicate an alert, warning, or attention-required state. */
32
- hasAlert?: boolean;
33
- /** If true, the button is controlled externally.
34
-
35
- Use to control the button state from outside the component. */
36
- externalControl?: boolean
13
+ /** Whether the button is currently checked (selected). When true, the button displays its checked styling. Toggling this property updates the visual state. */
14
+ checked?: boolean;
15
+ /** If true, prevents interaction and shows disabled styling. When disabled, the button cannot be toggled and appears dimmed. */
16
+ disabled?: boolean;
17
+ /** If true, displays the label text below the icon. When false, only the icon is shown (icon-only mode). */
18
+ hasLabel?: boolean;
19
+ /**
20
+ * Text to display below the icon (when `hasLabel` is true). Used to describe the toggle action or state for clarity and accessibility.
21
+ *
22
+ * Available when `hasLabel==true`.
23
+ */
24
+ label?: string;
25
+ /** If true, adds alert styling to the button. Use to visually indicate an alert, warning, or attention-required state. */
26
+ hasAlert?: boolean;
27
+ /** If true, the button is controlled externally. Use to control the button state from outside the component. */
28
+ externalControl?: boolean
37
29
  }
38
30
  export interface Events {
39
31
  onIconCheckButtonClick?: (event: CustomEvent<{checked: boolean}>) => void
@@ -3,29 +3,21 @@ import type { Snippet } from 'svelte';
3
3
  export interface Props {
4
4
  class?: string;
5
5
  style?: string;
6
- /** Whether the button is currently checked (selected).
7
-
8
- When true, the button displays its checked styling. Toggling this property updates the visual state. */
6
+ /** Whether the button is currently checked (selected). When true, the button displays its checked styling. Toggling this property updates the visual state. */
9
7
  checked?: boolean;
10
- /** If true, prevents interaction and shows disabled styling.
11
-
12
- When disabled, the button cannot be toggled and appears dimmed. */
8
+ /** If true, prevents interaction and shows disabled styling. When disabled, the button cannot be toggled and appears dimmed. */
13
9
  disabled?: boolean;
14
- /** If true, displays the label text below the icon.
15
-
16
- When false, only the icon is shown (icon-only mode). */
10
+ /** If true, displays the label text below the icon. When false, only the icon is shown (icon-only mode). */
17
11
  hasLabel?: boolean;
18
- /** Text to display below the icon (when `hasLabel` is true).
19
-
20
- Used to describe the toggle action or state for clarity and accessibility. */
12
+ /**
13
+ * Text to display below the icon (when `hasLabel` is true). Used to describe the toggle action or state for clarity and accessibility.
14
+ *
15
+ * Available when `hasLabel==true`.
16
+ */
21
17
  label?: string;
22
- /** If true, adds alert styling to the button.
23
-
24
- Use to visually indicate an alert, warning, or attention-required state. */
18
+ /** If true, adds alert styling to the button. Use to visually indicate an alert, warning, or attention-required state. */
25
19
  hasAlert?: boolean;
26
- /** If true, the button is controlled externally.
27
-
28
- Use to control the button state from outside the component. */
20
+ /** If true, the button is controlled externally. Use to control the button state from outside the component. */
29
21
  externalControl?: boolean;
30
22
  }
31
23
  export interface Events {
@@ -14,29 +14,16 @@ import type {ContextMenuOption, ContextMenuType, ColumnGroup} from '@oicl/openbr
14
14
  style?: string;
15
15
  /** The label displayed on the button. If empty, the button can be rendered as icon-only. */
16
16
  label?: string;
17
- /** Array of menu options with value, label, and optional level, icon, and children.
18
- Each option can include:
19
- - `value`: Unique string identifier.
20
- - `label`: Display text.
21
- - `icon`: Optional icon (e.g., `<obi-placeholder></obi-placeholder>`).
22
- - `children`: Optional array of child options (for nested/flyout menus).
23
- - `level`: Optional nesting level (for hierarchical menus). */
24
- options?: ContextMenuOption[];
17
+ /** Menu options, each with a unique `value` and a `label`, and optionally an `icon` template, `children` for a nested or flyout menu, and a `level` giving the nesting depth in a hierarchical menu. */
18
+ options?: ContextMenuOption[];
25
19
  /** Array of currently selected option values. Used to control which options are checked/selected in the menu. */
26
20
  selectedValues?: string[];
27
21
  /** Whether the button should fill the full width of its container. If true, the button stretches to 100% width. */
28
22
  fullWidth?: boolean;
29
23
  /** Whether the button should show an icon slot. If true, the `icon` slot is rendered at the start of the button. */
30
24
  hasIcon?: boolean;
31
- /** The variant type of context menu to display.
32
- Determines menu layout and selection behavior.
33
- - `Regular`: Standard single-select.
34
- - `Checkboxes`: Multi-select with checkboxes.
35
- - `NestedCheckboxes`: Hierarchical multi-select.
36
- - `Flyout`: Multi-level flyout menu.
37
- - `Multi`: Multi-column menu.
38
- - `MultiWithSubtitles`: Multi-column with group subtitles. */
39
- menuType?: ContextMenuType;
25
+ /** Context menu variant, which sets the layout and the selection behaviour: `regular` (default) is single-select, `checkboxes` and `nested-checkboxes` are flat and hierarchical multi-select, `flyout` is a multi-level flyout, and `multi` and `multi-with-subtitles` lay the menu out in columns. */
26
+ menuType?: ContextMenuType;
40
27
  /** Whether multiple selections are allowed. Overrides the default selection mode for the chosen variant. If not explicitly set, defaults based on `menuType`. */
41
28
  multiSelect?: boolean | undefined;
42
29
  /** Allows single selection per group (flyout/multi-column only). When true, only one item per group/column can be selected. */
@@ -7,13 +7,7 @@ export interface Props {
7
7
  style?: string;
8
8
  /** The label displayed on the button. If empty, the button can be rendered as icon-only. */
9
9
  label?: string;
10
- /** Array of menu options with value, label, and optional level, icon, and children.
11
- Each option can include:
12
- - `value`: Unique string identifier.
13
- - `label`: Display text.
14
- - `icon`: Optional icon (e.g., `<obi-placeholder></obi-placeholder>`).
15
- - `children`: Optional array of child options (for nested/flyout menus).
16
- - `level`: Optional nesting level (for hierarchical menus). */
10
+ /** Menu options, each with a unique `value` and a `label`, and optionally an `icon` template, `children` for a nested or flyout menu, and a `level` giving the nesting depth in a hierarchical menu. */
17
11
  options?: ContextMenuOption[];
18
12
  /** Array of currently selected option values. Used to control which options are checked/selected in the menu. */
19
13
  selectedValues?: string[];
@@ -21,14 +15,7 @@ Each option can include:
21
15
  fullWidth?: boolean;
22
16
  /** Whether the button should show an icon slot. If true, the `icon` slot is rendered at the start of the button. */
23
17
  hasIcon?: boolean;
24
- /** The variant type of context menu to display.
25
- Determines menu layout and selection behavior.
26
- - `Regular`: Standard single-select.
27
- - `Checkboxes`: Multi-select with checkboxes.
28
- - `NestedCheckboxes`: Hierarchical multi-select.
29
- - `Flyout`: Multi-level flyout menu.
30
- - `Multi`: Multi-column menu.
31
- - `MultiWithSubtitles`: Multi-column with group subtitles. */
18
+ /** Context menu variant, which sets the layout and the selection behaviour: `regular` (default) is single-select, `checkboxes` and `nested-checkboxes` are flat and hierarchical multi-select, `flyout` is a multi-level flyout, and `multi` and `multi-with-subtitles` lay the menu out in columns. */
32
19
  menuType?: ContextMenuType;
33
20
  /** Whether multiple selections are allowed. Overrides the default selection mode for the chosen variant. If not explicitly set, defaults based on `menuType`. */
34
21
  multiSelect?: boolean | undefined;
@@ -42,8 +42,8 @@ import type {TreeBranchType, TreeNavigationItemAlerts} from '@oicl/openbridge-we
42
42
  treeBranches?: TreeBranchType[];
43
43
  /** Terminal type for the row in the Tree variant — one of `regular` (default), `aggregated-header`, or `group-header`. Has no effect in the flat variants. */
44
44
  terminalType?: string;
45
- /** [object Object],[object Object],[object Object] */
46
- alerts?: TreeNavigationItemAlerts | undefined
45
+ /** Per-severity alert counts shown as trailing badges, in the Tree variant only. Forwarded to the underlying `obc-tree-navigation-item`. */
46
+ alerts?: TreeNavigationItemAlerts | undefined
47
47
  }
48
48
  export interface Events {
49
49
  onClick?: (event: CustomEvent<unknown>) => void
@@ -35,7 +35,7 @@ export interface Props {
35
35
  treeBranches?: TreeBranchType[];
36
36
  /** Terminal type for the row in the Tree variant — one of `regular` (default), `aggregated-header`, or `group-header`. Has no effect in the flat variants. */
37
37
  terminalType?: string;
38
- /** [object Object],[object Object],[object Object] */
38
+ /** Per-severity alert counts shown as trailing badges, in the Tree variant only. Forwarded to the underlying `obc-tree-navigation-item`. */
39
39
  alerts?: TreeNavigationItemAlerts | undefined;
40
40
  }
41
41
  export interface Events {
@@ -29,8 +29,8 @@ import type {TreeBranchType, TreeNavigationItemAlerts} from '@oicl/openbridge-we
29
29
  treeBranches?: TreeBranchType[];
30
30
  /** Terminal type for the group header in the Tree variant — one of `regular` (default), `aggregated-header`, or `group-header`. No effect in flat variants. */
31
31
  terminalType?: string;
32
- /** [object Object],[object Object],[object Object] */
33
- alerts?: TreeNavigationItemAlerts | undefined;
32
+ /** Per-severity alert counts shown as trailing badges on the group header, in the Tree variant only and only while the group is collapsed — an expanded group shows its rows' own badges instead. A header usually sets `combine` so it totals the rows beneath it. */
33
+ alerts?: TreeNavigationItemAlerts | undefined;
34
34
  /** Whether the group starts expanded. Useful for trees that open by default. */
35
35
  defaultOpen?: boolean
36
36
  }
@@ -22,7 +22,7 @@ export interface Props {
22
22
  treeBranches?: TreeBranchType[];
23
23
  /** Terminal type for the group header in the Tree variant — one of `regular` (default), `aggregated-header`, or `group-header`. No effect in flat variants. */
24
24
  terminalType?: string;
25
- /** [object Object],[object Object],[object Object] */
25
+ /** Per-severity alert counts shown as trailing badges on the group header, in the Tree variant only and only while the group is collapsed — an expanded group shows its rows' own badges instead. A header usually sets `combine` so it totals the rows beneath it. */
26
26
  alerts?: TreeNavigationItemAlerts | undefined;
27
27
  /** Whether the group starts expanded. Useful for trees that open by default. */
28
28
  defaultOpen?: boolean;
@@ -10,14 +10,8 @@
10
10
  export interface Props {
11
11
  class?: string;
12
12
  style?: string;
13
- /** Controls the visual style and layout of the navigation menu.
14
-
15
- - `full`: Standard menu with icons and labels (default).
16
- - `icon-only`: Compact, icon-only menu (use only when no flyouts/groups are present).
17
- - `icon-only-large`: Icon-only menu supporting flyouts/groups.
18
- - `compact`: Minimal, space-saving menu.
19
- - `tree`: Hierarchical tree — groups expand inline and rows are indented by depth. */
20
- variant?: ObcNavigationMenuVariant;
13
+ /** Visual style and layout: `full` (default) shows icons and labels, `icon-only` is the compact icon-only menu and takes no flyouts or groups, `icon-only-large` is the icon-only menu that does, `compact` is the space-saving menu, and `tree` expands groups inline and indents rows by depth. */
14
+ variant?: ObcNavigationMenuVariant;
21
15
  /**
22
16
  * Visual variant of the flyout. One of `Full` (default) or `Compact`.
23
17
  *
@@ -4,13 +4,7 @@ import type { Snippet } from 'svelte';
4
4
  export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
- /** Controls the visual style and layout of the navigation menu.
8
-
9
- - `full`: Standard menu with icons and labels (default).
10
- - `icon-only`: Compact, icon-only menu (use only when no flyouts/groups are present).
11
- - `icon-only-large`: Icon-only menu supporting flyouts/groups.
12
- - `compact`: Minimal, space-saving menu.
13
- - `tree`: Hierarchical tree — groups expand inline and rows are indented by depth. */
7
+ /** Visual style and layout: `full` (default) shows icons and labels, `icon-only` is the compact icon-only menu and takes no flyouts or groups, `icon-only-large` is the icon-only menu that does, `compact` is the space-saving menu, and `tree` expands groups inline and indents rows by depth. */
14
8
  variant?: ObcNavigationMenuVariant;
15
9
  /**
16
10
  * Visual variant of the flyout. One of `Full` (default) or `Compact`.