@oicl/openbridge-webcomponents 2.0.0-next.63 → 2.0.0-next.65
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.
- package/bundle/openbridge-webcomponents.bundle.js +392 -381
- package/bundle/openbridge-webcomponents.bundle.js.map +1 -1
- package/custom-elements.json +57 -199
- package/dist/alert-severity.d.ts.map +1 -1
- package/dist/alert-severity.js +37 -35
- package/dist/alert-severity.js.map +1 -1
- package/dist/ar/building-blocks/poi-header/poi-header.css.js +15 -15
- package/dist/ar/building-blocks/poi-header/poi-header.d.ts +6 -6
- package/dist/ar/building-blocks/poi-header/poi-header.d.ts.map +1 -1
- package/dist/ar/building-blocks/poi-header/poi-header.js +5 -5
- package/dist/ar/building-blocks/poi-header/poi-header.js.map +1 -1
- package/dist/ar/poi-button/poi-button.css.js +31 -30
- package/dist/ar/poi-button/poi-button.css.js.map +1 -1
- package/dist/ar/poi-button/poi-button.d.ts +6 -6
- package/dist/ar/poi-button/poi-button.d.ts.map +1 -1
- package/dist/ar/poi-button/poi-button.js +15 -15
- package/dist/ar/poi-button/poi-button.js.map +1 -1
- package/dist/ar/types.d.ts +5 -5
- package/dist/ar/types.d.ts.map +1 -1
- package/dist/ar/types.js +5 -5
- package/dist/ar/types.js.map +1 -1
- package/dist/automation/automation-badge/automation-badge.d.ts +7 -7
- package/dist/automation/automation-badge/automation-badge.d.ts.map +1 -1
- package/dist/automation/automation-badge/automation-badge.js +29 -29
- package/dist/automation/automation-badge/automation-badge.js.map +1 -1
- package/dist/automation/automation-button/abstract-automation-button.d.ts +5 -5
- package/dist/automation/automation-button/abstract-automation-button.d.ts.map +1 -1
- package/dist/automation/automation-button/abstract-automation-button.js +15 -15
- package/dist/automation/automation-button/abstract-automation-button.js.map +1 -1
- package/dist/automation/automation-tank/automation-tank.js +10 -10
- package/dist/automation/automation-tank/automation-tank.js.map +1 -1
- package/dist/components/accordion-card/accordion-card.css.js +5 -5
- package/dist/components/alert-button/alert-button.css.js +128 -128
- package/dist/components/alert-frame/alert-frame.css.js +6 -6
- package/dist/components/alert-frame/alert-frame.d.ts +4 -4
- package/dist/components/alert-frame/alert-frame.js.map +1 -1
- package/dist/components/alert-icon/alert-icon.js +4 -4
- package/dist/components/alert-icon/alert-icon.js.map +1 -1
- package/dist/components/badge/badge.css.js +10 -10
- package/dist/components/badge/badge.d.ts +13 -13
- package/dist/components/badge/badge.d.ts.map +1 -1
- package/dist/components/badge/badge.js +10 -10
- package/dist/components/badge/badge.js.map +1 -1
- package/dist/components/navigation-item/navigation-item.d.ts +7 -7
- package/dist/components/navigation-item/navigation-item.d.ts.map +1 -1
- package/dist/components/navigation-item/navigation-item.js +3 -15
- package/dist/components/navigation-item/navigation-item.js.map +1 -1
- package/dist/components/navigation-item-group/navigation-item-group.d.ts +8 -7
- package/dist/components/navigation-item-group/navigation-item-group.d.ts.map +1 -1
- package/dist/components/navigation-item-group/navigation-item-group.js +3 -15
- package/dist/components/navigation-item-group/navigation-item-group.js.map +1 -1
- package/dist/components/navigation-menu/navigation-menu.d.ts +2 -2
- package/dist/components/navigation-menu/navigation-menu.js.map +1 -1
- package/dist/components/tree-navigation-group/tree-navigation-group.d.ts +10 -10
- package/dist/components/tree-navigation-group/tree-navigation-group.d.ts.map +1 -1
- package/dist/components/tree-navigation-group/tree-navigation-group.js +3 -15
- package/dist/components/tree-navigation-group/tree-navigation-group.js.map +1 -1
- package/dist/components/tree-navigation-item/tree-navigation-item.css.js +13 -0
- package/dist/components/tree-navigation-item/tree-navigation-item.css.js.map +1 -1
- package/dist/components/tree-navigation-item/tree-navigation-item.d.ts +59 -8
- package/dist/components/tree-navigation-item/tree-navigation-item.d.ts.map +1 -1
- package/dist/components/tree-navigation-item/tree-navigation-item.js +46 -17
- package/dist/components/tree-navigation-item/tree-navigation-item.js.map +1 -1
- package/dist/manual-icon/icon-alerts-critical-twotone.d.ts +1 -1
- package/dist/manual-icon/icon-alerts-critical-twotone.js.map +1 -1
- package/dist/manual-icon/icon-alerts-diagnostic-twotone.d.ts +1 -1
- package/dist/manual-icon/icon-alerts-diagnostic-twotone.js.map +1 -1
- package/dist/types.d.ts +5 -5
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +11 -11
- package/dist/types.js.map +1 -1
- package/package.json +1 -1
package/custom-elements.json
CHANGED
|
@@ -193,7 +193,7 @@
|
|
|
193
193
|
"declarations": [
|
|
194
194
|
{
|
|
195
195
|
"kind": "class",
|
|
196
|
-
"description": "`<obc-poi-header>` - Compact header chip for marker identifiers, labels, and optional indicator content.\n\n## Overview\nUse this component to display compact marker metadata above or near a marker button.\nKeywords/synonyms: chip, pill, badge, header chip, identifier badge.\n\n## Features/Variants\n- `type` (default `id`):\n - `id`: shows identifier content only.\n - `data`: shows identifier plus secondary label.\n- `state` (default `enabled`): `enabled`, `selected`, `caution`, `warning`, `alarm`, `
|
|
196
|
+
"description": "`<obc-poi-header>` - Compact header chip for marker identifiers, labels, and optional indicator content.\n\n## Overview\nUse this component to display compact marker metadata above or near a marker button.\nKeywords/synonyms: chip, pill, badge, header chip, identifier badge.\n\n## Features/Variants\n- `type` (default `id`):\n - `id`: shows identifier content only.\n - `data`: shows identifier plus secondary label.\n- `state` (default `enabled`): `enabled`, `selected`, `caution`, `warning`, `alarm`, `level-critical`, `level-high`, `level-medium`, `level-low`, `level-diagnostic`.\n- `content` (default `\"1\"`): primary identifier text.\n- `label` (default `\"Data\"`): secondary text used by `type=\"data\"`.\n- `hasIndicator` (default `false`): appends indicator area.\n- `indicator` slot fallback: renders built-in bar indicator markup when slot content is empty.\n- `size` (default `regular`): currently only `regular`.\n\n## Usage Guidelines\n- Use `type=\"id\"` for compact identifier-only labels.\n- Use `type=\"data\"` when both an ID and short label are required.\n- Keep `content` and `label` brief to prevent overflow.\n\n## Slots/Content\n- `indicator`: Optional indicator icon/content; built-in indicator is used as fallback.\n\n## Events\nThis component does not emit custom events.\n\n## Best Practices\n- Keep indicator usage consistent across similar marker states.\n- Prefer enum values for `type`, `state`, and `size`.\n\n## Example\n```html\n<obc-poi-header type=\"data\" state=\"selected\" content=\"3\" label=\"SOG\" has-indicator>\n <obi-placeholder slot=\"indicator\"></obi-placeholder>\n</obc-poi-header>\n```",
|
|
197
197
|
"name": "ObcPoiHeader",
|
|
198
198
|
"slots": [
|
|
199
199
|
{
|
|
@@ -3249,7 +3249,7 @@
|
|
|
3249
3249
|
"declarations": [
|
|
3250
3250
|
{
|
|
3251
3251
|
"kind": "class",
|
|
3252
|
-
"description": "`<obc-poi-button>` - Marker button component that renders an icon target with optional header and data rows.\n\n## Overview\nUse this component when you need a button-style marker that can show stateful framing and optional metric rows.\nKeywords/synonyms: marker button, target button, icon target, POI button.\n\n## Features/Variants\n- `type` (default `button`): `button` or `enhanced` size.\n- `layout` (default `anchored`): `anchored` or `inline`.\n- `value` (default `unchecked`): `unchecked`, `checked`, `activated`, `overlapped`.\n- `overlapOpaque` (default `false`): controls overlapped opacity mode (`false` = translucent, `true` = opaque).\n- `state` (default `enabled`): `enabled`, `caution`, `warning`, `alarm`, `
|
|
3252
|
+
"description": "`<obc-poi-button>` - Marker button component that renders an icon target with optional header and data rows.\n\n## Overview\nUse this component when you need a button-style marker that can show stateful framing and optional metric rows.\nKeywords/synonyms: marker button, target button, icon target, POI button.\n\n## Features/Variants\n- `type` (default `button`): `button` or `enhanced` size.\n- `layout` (default `anchored`): `anchored` or `inline`.\n- `value` (default `unchecked`): `unchecked`, `checked`, `activated`, `overlapped`.\n- `overlapOpaque` (default `false`): controls overlapped opacity mode (`false` = translucent, `true` = opaque).\n- `state` (default `enabled`): `enabled`, `caution`, `warning`, `alarm`, `level-critical`, `level-high`, `level-medium`, `level-low`, `level-diagnostic`.\n- `selected` (default `false`): shows selection frame in anchored layout.\n- `relativeDirection` (default `0`): rotates default-slot icon content in degrees.\n- `data` (default `[]`): when non-empty, renders value/label/unit rows.\n- `hasHeader` + `header` slot: renders a header area and syncs slotted `obc-poi-header` state.\n- `hasRelation` (default `false`): enables optional relation content in data mode.\n- `inExpandedGroup` (default `false`): applies `expanded` CSS class.\n- TODO(designer): Confirm intended UX semantics for `inExpandedGroup` beyond styling.\n\n## Usage Guidelines\n- Use `layout=\"anchored\"` for standalone marker buttons.\n- Use `layout=\"inline\"` when this component is embedded in a larger marker composition.\n- Provide `data` for metric display variants.\n- Enable `hasRelation` only when relation slot content is provided.\n\n## Slots/Content\n- Default slot: Icon/content rendered inside `obc-poi-object`.\n- `header`: Optional header content rendered above the marker body.\n- `relation`: Optional relation icon/content rendered when `hasRelation` is true in data mode.\n\n## Events\nThis component does not emit custom events.\nNative `click` is available from the internal `<button>`.\n\n## Best Practices\n- Keep `value`, `state`, and `selected` synchronized to avoid conflicting visual states.\n- Prefer enum values for `type`, `layout`, `state`, and `value`.\n\n## Example\n```html\n<obc-poi-button type=\"button\" layout=\"anchored\" value=\"checked\" selected>\n <obi-placeholder></obi-placeholder>\n <obc-poi-header slot=\"header\" content=\"1\"></obc-poi-header>\n</obc-poi-button>\n```",
|
|
3253
3253
|
"name": "ObcPoiButton",
|
|
3254
3254
|
"slots": [
|
|
3255
3255
|
{
|
|
@@ -12692,7 +12692,7 @@
|
|
|
12692
12692
|
},
|
|
12693
12693
|
{
|
|
12694
12694
|
"kind": "method",
|
|
12695
|
-
"name": "
|
|
12695
|
+
"name": "renderLevelCriticalIcon",
|
|
12696
12696
|
"privacy": "private",
|
|
12697
12697
|
"parameters": [
|
|
12698
12698
|
{
|
|
@@ -12705,7 +12705,7 @@
|
|
|
12705
12705
|
},
|
|
12706
12706
|
{
|
|
12707
12707
|
"kind": "method",
|
|
12708
|
-
"name": "
|
|
12708
|
+
"name": "renderLevelDiagnosticIcon",
|
|
12709
12709
|
"privacy": "private"
|
|
12710
12710
|
},
|
|
12711
12711
|
{
|
|
@@ -39306,7 +39306,7 @@
|
|
|
39306
39306
|
"declarations": [
|
|
39307
39307
|
{
|
|
39308
39308
|
"kind": "class",
|
|
39309
|
-
"description": "`<obc-alert-frame>` – A bordered frame component for visually emphasizing alert or status messages.\n\nThe alert frame provides a prominent outline and optional \"flap\" with status icon to draw attention to critical information or UI regions. It supports multiple visual variants and thicknesses, and can be configured to indicate different alert statuses (alarm, warning, caution). The component is designed to wrap content and visually distinguish it from the surrounding UI.\n\n### Features\n- **Variants (type):**\n - `regular`: Standard outlined frame with no flap or icon.\n - `small-side-flip`: Adds a small side flap with a status icon at the top right.\n - `large-side-flip`: Adds a larger, vertical side flap with a status icon and optional custom icon.\n - `bottom-flip`: Adds a bottom flap with a status icon, label, and timer slots.\n- **Thickness options:** Choose between `small` (thin border) and `large` (thick border) for visual emphasis.\n- **Status indication:** Displays different color schemes and icons for the legacy statuses (`alarm`, `warning`, `caution`) and the
|
|
39309
|
+
"description": "`<obc-alert-frame>` – A bordered frame component for visually emphasizing alert or status messages.\n\nThe alert frame provides a prominent outline and optional \"flap\" with status icon to draw attention to critical information or UI regions. It supports multiple visual variants and thicknesses, and can be configured to indicate different alert statuses (alarm, warning, caution). The component is designed to wrap content and visually distinguish it from the surrounding UI.\n\n### Features\n- **Variants (type):**\n - `regular`: Standard outlined frame with no flap or icon.\n - `small-side-flip`: Adds a small side flap with a status icon at the top right.\n - `large-side-flip`: Adds a larger, vertical side flap with a status icon and optional custom icon.\n - `bottom-flip`: Adds a bottom flap with a status icon, label, and timer slots.\n- **Thickness options:** Choose between `small` (thin border) and `large` (thick border) for visual emphasis.\n- **Status indication:** Displays different color schemes and icons for the legacy statuses (`alarm`, `warning`, `caution`) and the level statuses (`level-critical`, `level-high`, `level-medium`, `level-low`, `level-diagnostic`).\n- **Acknowledgement mode:** The `mode` property reflects the alert lifecycle state — `acked-active` (default), `unacked-active`, and `unacked-rectified` — driving the blinking/animation treatment of the frame.\n- **Content wrapping:** When `wrapContent` is true, the frame wraps and sizes itself to its slotted content rather than overlaying a fixed region.\n- **Customizable corners:** Each corner can be set to a sharp (non-rounded) edge for integration with other UI elements.\n- **Slot-based content:** Supports custom icons, labels, and timers in flap variants via named slots.\n\n### Usage Guidelines\nUse `obc-alert-frame` to highlight important content, such as alerts, warnings, or status panels. The flap variants are ideal for drawing extra attention to urgent or time-sensitive information, while the regular type provides a subtle but clear border. Choose the status to match the severity of the message (alarm, warning, caution). Adjust thickness for visual hierarchy—use large for high-priority alerts and small for less critical notices.\n\n**TODO(designer):** Provide guidance on when to use each flap type (small-side-flip, large-side-flip, bottom-flip) and recommended scenarios for sharp edge usage.\n\n### Features/Variants\n- **Type (Visual Variant):**\n - `regular`: Simple outlined frame, no flap or icon.\n - `small-side-flip`: Small right-side flap with status icon.\n - `large-side-flip`: Large vertical right-side flap with status icon and optional custom icon.\n - `bottom-flip`: Bottom flap with status icon, label, and timer.\n- **Thickness:** `small` (default) or `large` for border width.\n- **Status:** `alarm`, `warning`, `caution`, or the level severities (`level-critical`, `level-high`, `level-medium`, `level-low`, `level-diagnostic`)—affects color and icon.\n- **Mode:** `acked-active` (default), `unacked-active`, or `unacked-rectified`—affects blinking/animation.\n- **Corner Customization:** Each corner can be made sharp (not rounded) via boolean properties.\n\n### Slots and Content Structure\n\n| Slot Name | Renders When... | Purpose |\n|-----------|-----------------|---------|\n| (default) | Always | Main content inside the alert frame. |\n| icon | `large-side-flip` or `bottom-flip` | Custom icon displayed in the flap (in addition to status icon). |\n| label | `bottom-flip` only | Label text shown in the bottom flap. |\n| timer | `bottom-flip` only | Timer or time label in the bottom flap. |\n\n### Properties and Attributes\n- `type`: Selects the visual variant/flap style. Default is `small-side-flip`.\n- `thickness`: Controls border thickness (`small` or `large`). Default is `small`.\n- `status`: Sets the alert status and color/icon (`alarm`, `warning`, `caution`, or the `level-*` severities). Default is `alarm`.\n- `mode`: Acknowledgement lifecycle state (`acked-active`, `unacked-active`, `unacked-rectified`) controlling blinking/animation. Default is `acked-active`.\n- `wrapContent`: When true, the frame wraps and sizes to its slotted content instead of overlaying a fixed region. Default is `false`.\n- `sharpEdgeTopLeft`, `sharpEdgeTopRight`, `sharpEdgeBottomLeft`, `sharpEdgeBottomRight`: Boolean flags to make each corner sharp instead of rounded.\n\n### Best Practices and Constraints\n- Use the status property to match the severity of the alert.\n- Only use the bottom-flip variant when both label and timer are relevant.\n- For visual consistency, align sharp edge settings with adjacent UI elements.\n- The default slot is for the main content; use named slots for icons, labels, and timers as needed.\n\n### Example:\n```\n<obc-alert-frame\n type=\"bottom-flip\"\n thickness=\"large\"\n status=\"warning\"\n sharpEdgeTopLeft\n>\n <obi-placeholder slot=\"icon\"></obi-placeholder>\n <div slot=\"label\">Low Battery</div>\n <div slot=\"timer\">00:15</div>\n <div>Critical system message goes here.</div>\n</obc-alert-frame>\n```",
|
|
39310
39310
|
"name": "ObcAlertFrame",
|
|
39311
39311
|
"slots": [
|
|
39312
39312
|
{
|
|
@@ -39351,7 +39351,7 @@
|
|
|
39351
39351
|
"type": {
|
|
39352
39352
|
"text": "AlertType"
|
|
39353
39353
|
},
|
|
39354
|
-
"description": "Status of the alert, controlling color scheme and icon.\n- `alarm`: Highest severity (default).\n- `warning`: Medium severity.\n- `caution`: Lower severity.\n- `
|
|
39354
|
+
"description": "Status of the alert, controlling color scheme and icon.\n- `alarm`: Highest severity (default).\n- `warning`: Medium severity.\n- `caution`: Lower severity.\n- `level-critical`, `level-high`, `level-medium`, `level-low`, `level-diagnostic`: level severity levels, styled to match their legacy equivalents.",
|
|
39355
39355
|
"attribute": "status"
|
|
39356
39356
|
},
|
|
39357
39357
|
{
|
|
@@ -39477,7 +39477,7 @@
|
|
|
39477
39477
|
"type": {
|
|
39478
39478
|
"text": "AlertType"
|
|
39479
39479
|
},
|
|
39480
|
-
"description": "Status of the alert, controlling color scheme and icon.\n- `alarm`: Highest severity (default).\n- `warning`: Medium severity.\n- `caution`: Lower severity.\n- `
|
|
39480
|
+
"description": "Status of the alert, controlling color scheme and icon.\n- `alarm`: Highest severity (default).\n- `warning`: Medium severity.\n- `caution`: Lower severity.\n- `level-critical`, `level-high`, `level-medium`, `level-low`, `level-diagnostic`: level severity levels, styled to match their legacy equivalents.",
|
|
39481
39481
|
"fieldName": "status"
|
|
39482
39482
|
},
|
|
39483
39483
|
{
|
|
@@ -41497,7 +41497,7 @@
|
|
|
41497
41497
|
"declarations": [
|
|
41498
41498
|
{
|
|
41499
41499
|
"kind": "class",
|
|
41500
|
-
"description": "`<obc-badge>` – A compact visual indicator for status, alerts, or notifications, optionally displaying a number and/or icon.\n\nBadges are used to draw attention to status changes, counts, or important information in a concise format. They can represent alert states (such as alarm, warning, or running), notification counts, or other contextual statuses. The badge adapts its appearance based on type, size, and variant, and can display an icon, a number, or both.\n\n---\n\n### Features\n- **Type options:** Supports multiple visual types:\n - `regular`: Default neutral badge.\n - `alarm`: Highlights critical or urgent states.\n - `warning`: Indicates caution or warning.\n - `caution`: Used for less severe caution.\n - `
|
|
41500
|
+
"description": "`<obc-badge>` – A compact visual indicator for status, alerts, or notifications, optionally displaying a number and/or icon.\n\nBadges are used to draw attention to status changes, counts, or important information in a concise format. They can represent alert states (such as alarm, warning, or running), notification counts, or other contextual statuses. The badge adapts its appearance based on type, size, and variant, and can display an icon, a number, or both.\n\n---\n\n### Features\n- **Type options:** Supports multiple visual types:\n - `regular`: Default neutral badge.\n - `alarm`: Highlights critical or urgent states.\n - `warning`: Indicates caution or warning.\n - `caution`: Used for less severe caution.\n - `level-critical`, `level-high`, `level-medium`, `level-low`, `level-diagnostic`: level severity levels, styled to match their legacy equivalents (critical, alarm, warning, caution, notification).\n - `running`: Represents active or running states.\n - `notification`: For general notifications.\n - `enhance`: For secondary notifications or emphasis.\n - `automation`: For automation-related status.\n - `outline`: Outline-only style (flat variant only).\n - `empty`: Minimal badge with no icon or number.\n- **Size options:** `regular` (default) and `large` for increased visibility.\n- **Variants:**\n - `default`: Filled background and border.\n - `flat`: Minimal background, outline, and lighter appearance.\n- **Icon support:** Can display a contextual icon (built-in for alarm, warning, caution, running; custom via slot for others).\n- **Number display:** Optionally shows a number (e.g., count of notifications).\n- **Hide number:** Can suppress the number for a purely symbolic badge.\n- **Custom icon slot:** For types without a built-in icon, developers can provide a custom icon using the `badge-icon` slot.\n- **Responsive layout:** Adjusts size and spacing based on the `size` property.\n\n---\n\n### Usage Guidelines\n- Use `obc-badge` to highlight status, counts, or alerts in a compact form, such as notification indicators, unread message counts, or system status.\n- Choose the `type` that matches the semantic meaning (e.g., `alarm` for critical, `warning` for caution, `running` for active).\n- Use the `number` property to show counts; set `showNumber` to false for symbolic-only badges.\n- Use the `flat` variant for less prominent or secondary contexts.\n- For custom icons, provide an icon element in the `badge-icon` slot.\n- Avoid using badges for persistent or detailed information; they are intended for brief, glanceable status.\n- **TODO(designer):** Confirm recommended use cases for `enhance`, `automation`, and `outline` types, and clarify when to use `empty` type versus hiding the badge entirely.\n\n---\n\n### Slots\n\n| Slot Name | Renders When... | Purpose |\n|---------------|-------------------------------|-----------------------------------------------------|\n| `badge-icon` | `showIcon` is true and `type` is not one of `alarm`, `warning`, `caution`, `running` | Custom icon for the badge (e.g., `<obi-placeholder>`). |\n\n---\n\n### Properties and Attributes\n- `number` (number): The numeric value to display in the badge. Defaults to 0.\n- `showNumber` (boolean): If true, the number is shown. Set to `false` for symbolic or icon-only badges.\n- `type` (string): Visual style of the badge. See **Type options** above for possible values. Defaults to `regular`.\n- `size` (string): Badge size, either `regular` (default) or `large`.\n- `variant` (string): Visual variant, either `default` (filled) or `flat` (minimal). Defaults to `default`.\n- `showIcon` (boolean): If true, displays an icon appropriate to the badge type. For custom types, supply an icon in the `badge-icon` slot.\n\n---\n\n### Best Practices and Constraints\n- Use badge types consistently to communicate status meaningfully.\n- For accessibility, ensure the badge's meaning is also conveyed via text or ARIA attributes if used as a status indicator.\n- Avoid overloading the badge with large numbers or excessive detail; keep content concise.\n- The `empty` type is intended for minimal presence—use when a placeholder badge is needed without icon or number.\n- For custom icons, use OpenBridge icon elements such as `<obi-placeholder>` in the `badge-icon` slot.\n- The badge does not emit any custom events.\n\n---\n\n### Example\n\n```html\n<obc-badge type=\"alarm\" number=\"3\" showIcon>\n <!-- For custom types, provide an icon: -->\n <obi-placeholder slot=\"badge-icon\"></obi-placeholder>\n</obc-badge>\n```\n\nIn this example, the badge displays an alarm icon and the number 3.",
|
|
41501
41501
|
"name": "ObcBadge",
|
|
41502
41502
|
"slots": [
|
|
41503
41503
|
{
|
|
@@ -41531,7 +41531,7 @@
|
|
|
41531
41531
|
"type": {
|
|
41532
41532
|
"text": "string"
|
|
41533
41533
|
},
|
|
41534
|
-
"description": "Visual style/type of the badge.\n\nPossible values: `regular`, `alarm`, `warning`, `caution`, `
|
|
41534
|
+
"description": "Visual style/type of the badge.\n\nPossible values: `regular`, `alarm`, `warning`, `caution`, `level-critical`, `level-high`, `level-medium`, `level-low`, `level-diagnostic`, `running`, `notification`, `enhance`, `automation`, `outline`, `empty`.\n\nDefaults to `regular`.",
|
|
41535
41535
|
"attribute": "type"
|
|
41536
41536
|
},
|
|
41537
41537
|
{
|
|
@@ -41559,7 +41559,7 @@
|
|
|
41559
41559
|
"text": "boolean"
|
|
41560
41560
|
},
|
|
41561
41561
|
"default": "false",
|
|
41562
|
-
"description": "Whether to show an icon in the badge.\n\nFor built-in types (`alarm`, `warning`, `caution`, the `
|
|
41562
|
+
"description": "Whether to show an icon in the badge.\n\nFor built-in types (`alarm`, `warning`, `caution`, the `level-*` severities, and `running`), a contextual icon is shown automatically.\nFor other types, provide a custom icon in the `badge-icon` slot.",
|
|
41563
41563
|
"attribute": "showIcon"
|
|
41564
41564
|
},
|
|
41565
41565
|
{
|
|
@@ -41592,7 +41592,7 @@
|
|
|
41592
41592
|
"type": {
|
|
41593
41593
|
"text": "string"
|
|
41594
41594
|
},
|
|
41595
|
-
"description": "Visual style/type of the badge.\n\nPossible values: `regular`, `alarm`, `warning`, `caution`, `
|
|
41595
|
+
"description": "Visual style/type of the badge.\n\nPossible values: `regular`, `alarm`, `warning`, `caution`, `level-critical`, `level-high`, `level-medium`, `level-low`, `level-diagnostic`, `running`, `notification`, `enhance`, `automation`, `outline`, `empty`.\n\nDefaults to `regular`.",
|
|
41596
41596
|
"fieldName": "type"
|
|
41597
41597
|
},
|
|
41598
41598
|
{
|
|
@@ -41617,7 +41617,7 @@
|
|
|
41617
41617
|
"text": "boolean"
|
|
41618
41618
|
},
|
|
41619
41619
|
"default": "false",
|
|
41620
|
-
"description": "Whether to show an icon in the badge.\n\nFor built-in types (`alarm`, `warning`, `caution`, the `
|
|
41620
|
+
"description": "Whether to show an icon in the badge.\n\nFor built-in types (`alarm`, `warning`, `caution`, the `level-*` severities, and `running`), a contextual icon is shown automatically.\nFor other types, provide a custom icon in the `badge-icon` slot.",
|
|
41621
41621
|
"fieldName": "showIcon"
|
|
41622
41622
|
}
|
|
41623
41623
|
],
|
|
@@ -50582,32 +50582,12 @@
|
|
|
50582
50582
|
},
|
|
50583
50583
|
{
|
|
50584
50584
|
"kind": "field",
|
|
50585
|
-
"name": "
|
|
50586
|
-
"type": {
|
|
50587
|
-
"text": "boolean"
|
|
50588
|
-
},
|
|
50589
|
-
"default": "false",
|
|
50590
|
-
"description": "Whether a trailing alert counter badge is shown on the header (Tree variant only).",
|
|
50591
|
-
"attribute": "hasAlertBadge"
|
|
50592
|
-
},
|
|
50593
|
-
{
|
|
50594
|
-
"kind": "field",
|
|
50595
|
-
"name": "alertCount",
|
|
50596
|
-
"type": {
|
|
50597
|
-
"text": "number"
|
|
50598
|
-
},
|
|
50599
|
-
"default": "0",
|
|
50600
|
-
"description": "The number shown in the header's alert badge when `hasAlertBadge` is true (Tree variant only).",
|
|
50601
|
-
"attribute": "alertCount"
|
|
50602
|
-
},
|
|
50603
|
-
{
|
|
50604
|
-
"kind": "field",
|
|
50605
|
-
"name": "alertType",
|
|
50585
|
+
"name": "alerts",
|
|
50606
50586
|
"type": {
|
|
50607
|
-
"text": "
|
|
50587
|
+
"text": "TreeNavigationItemAlerts | undefined"
|
|
50608
50588
|
},
|
|
50609
|
-
"description": "
|
|
50610
|
-
"attribute": "
|
|
50589
|
+
"description": "Per-severity alert counts shown as trailing badge(s) on the group header\n(Tree variant only). Forwarded to the underlying `obc-tree-navigation-item`;\ntypically `{aggregate: true, ...}` so the header totals the rows beneath it.\nSee TreeNavigationItemAlerts.",
|
|
50590
|
+
"attribute": "alerts"
|
|
50611
50591
|
},
|
|
50612
50592
|
{
|
|
50613
50593
|
"kind": "field",
|
|
@@ -50768,30 +50748,12 @@
|
|
|
50768
50748
|
"fieldName": "terminalType"
|
|
50769
50749
|
},
|
|
50770
50750
|
{
|
|
50771
|
-
"name": "
|
|
50772
|
-
"type": {
|
|
50773
|
-
"text": "boolean"
|
|
50774
|
-
},
|
|
50775
|
-
"default": "false",
|
|
50776
|
-
"description": "Whether a trailing alert counter badge is shown on the header (Tree variant only).",
|
|
50777
|
-
"fieldName": "hasAlertBadge"
|
|
50778
|
-
},
|
|
50779
|
-
{
|
|
50780
|
-
"name": "alertCount",
|
|
50781
|
-
"type": {
|
|
50782
|
-
"text": "number"
|
|
50783
|
-
},
|
|
50784
|
-
"default": "0",
|
|
50785
|
-
"description": "The number shown in the header's alert badge when `hasAlertBadge` is true (Tree variant only).",
|
|
50786
|
-
"fieldName": "alertCount"
|
|
50787
|
-
},
|
|
50788
|
-
{
|
|
50789
|
-
"name": "alertType",
|
|
50751
|
+
"name": "alerts",
|
|
50790
50752
|
"type": {
|
|
50791
|
-
"text": "
|
|
50753
|
+
"text": "TreeNavigationItemAlerts | undefined"
|
|
50792
50754
|
},
|
|
50793
|
-
"description": "
|
|
50794
|
-
"fieldName": "
|
|
50755
|
+
"description": "Per-severity alert counts shown as trailing badge(s) on the group header\n(Tree variant only). Forwarded to the underlying `obc-tree-navigation-item`;\ntypically `{aggregate: true, ...}` so the header totals the rows beneath it.\nSee TreeNavigationItemAlerts.",
|
|
50756
|
+
"fieldName": "alerts"
|
|
50795
50757
|
},
|
|
50796
50758
|
{
|
|
50797
50759
|
"name": "defaultOpen",
|
|
@@ -50955,32 +50917,12 @@
|
|
|
50955
50917
|
},
|
|
50956
50918
|
{
|
|
50957
50919
|
"kind": "field",
|
|
50958
|
-
"name": "
|
|
50959
|
-
"type": {
|
|
50960
|
-
"text": "boolean"
|
|
50961
|
-
},
|
|
50962
|
-
"default": "false",
|
|
50963
|
-
"description": "Whether a trailing alert counter badge is shown (Tree variant only).",
|
|
50964
|
-
"attribute": "hasAlertBadge"
|
|
50965
|
-
},
|
|
50966
|
-
{
|
|
50967
|
-
"kind": "field",
|
|
50968
|
-
"name": "alertCount",
|
|
50969
|
-
"type": {
|
|
50970
|
-
"text": "number"
|
|
50971
|
-
},
|
|
50972
|
-
"default": "0",
|
|
50973
|
-
"description": "The number shown in the alert badge when `hasAlertBadge` is true (Tree variant only).",
|
|
50974
|
-
"attribute": "alertCount"
|
|
50975
|
-
},
|
|
50976
|
-
{
|
|
50977
|
-
"kind": "field",
|
|
50978
|
-
"name": "alertType",
|
|
50920
|
+
"name": "alerts",
|
|
50979
50921
|
"type": {
|
|
50980
|
-
"text": "
|
|
50922
|
+
"text": "TreeNavigationItemAlerts | undefined"
|
|
50981
50923
|
},
|
|
50982
|
-
"description": "
|
|
50983
|
-
"attribute": "
|
|
50924
|
+
"description": "Per-severity alert counts shown as trailing badge(s) (Tree variant only).\nForwarded to the underlying `obc-tree-navigation-item`. See\nTreeNavigationItemAlerts.",
|
|
50925
|
+
"attribute": "alerts"
|
|
50984
50926
|
},
|
|
50985
50927
|
{
|
|
50986
50928
|
"kind": "field",
|
|
@@ -51156,30 +51098,12 @@
|
|
|
51156
51098
|
"fieldName": "terminalType"
|
|
51157
51099
|
},
|
|
51158
51100
|
{
|
|
51159
|
-
"name": "
|
|
51160
|
-
"type": {
|
|
51161
|
-
"text": "boolean"
|
|
51162
|
-
},
|
|
51163
|
-
"default": "false",
|
|
51164
|
-
"description": "Whether a trailing alert counter badge is shown (Tree variant only).",
|
|
51165
|
-
"fieldName": "hasAlertBadge"
|
|
51166
|
-
},
|
|
51167
|
-
{
|
|
51168
|
-
"name": "alertCount",
|
|
51169
|
-
"type": {
|
|
51170
|
-
"text": "number"
|
|
51171
|
-
},
|
|
51172
|
-
"default": "0",
|
|
51173
|
-
"description": "The number shown in the alert badge when `hasAlertBadge` is true (Tree variant only).",
|
|
51174
|
-
"fieldName": "alertCount"
|
|
51175
|
-
},
|
|
51176
|
-
{
|
|
51177
|
-
"name": "alertType",
|
|
51101
|
+
"name": "alerts",
|
|
51178
51102
|
"type": {
|
|
51179
|
-
"text": "
|
|
51103
|
+
"text": "TreeNavigationItemAlerts | undefined"
|
|
51180
51104
|
},
|
|
51181
|
-
"description": "
|
|
51182
|
-
"fieldName": "
|
|
51105
|
+
"description": "Per-severity alert counts shown as trailing badge(s) (Tree variant only).\nForwarded to the underlying `obc-tree-navigation-item`. See\nTreeNavigationItemAlerts.",
|
|
51106
|
+
"fieldName": "alerts"
|
|
51183
51107
|
}
|
|
51184
51108
|
],
|
|
51185
51109
|
"superclass": {
|
|
@@ -51215,7 +51139,7 @@
|
|
|
51215
51139
|
"declarations": [
|
|
51216
51140
|
{
|
|
51217
51141
|
"kind": "class",
|
|
51218
|
-
"description": "`<obc-navigation-menu>` – A flexible, slot-based navigation menu component for organizing primary and secondary navigation items.\n\nThis component provides a vertical navigation structure supporting groups, flyouts, and footer sections. It adapts to various layouts and device sizes via its `variant` and `smallScreen` properties. Items and groups are provided via slots, allowing for icons, labels, and nested navigation hierarchies.\n\nAppears as a sidebar or persistent navigation panel, supporting both icon-only and full-label modes. Designed for use as the main navigation in applications, dashboards, or any interface requiring structured navigation.\n\n## Features\n\n- **Variants:**\n - **Full:** Displays both icons and labels for all navigation items (default).\n - **IconOnly:** Shows only icons for a compact appearance. *Should only be used when no navigation items have sub-items or flyouts.*\n - **IconOnlyLarge:** Icon-only mode that supports flyouts/submenus. Use when navigation contains groups or nested items.\n - **Compact:** Reduces padding and overall width for a space-saving layout.\n - **Tree:** Renders the same `obc-navigation-item` / `obc-navigation-item-group`\n markup as a hierarchical tree. Groups expand inline (instead of as flyouts),\n rows are indented by depth, multiple branches can stay open at once, and the\n tree-row presentation (alert
|
|
51142
|
+
"description": "`<obc-navigation-menu>` – A flexible, slot-based navigation menu component for organizing primary and secondary navigation items.\n\nThis component provides a vertical navigation structure supporting groups, flyouts, and footer sections. It adapts to various layouts and device sizes via its `variant` and `smallScreen` properties. Items and groups are provided via slots, allowing for icons, labels, and nested navigation hierarchies.\n\nAppears as a sidebar or persistent navigation panel, supporting both icon-only and full-label modes. Designed for use as the main navigation in applications, dashboards, or any interface requiring structured navigation.\n\n## Features\n\n- **Variants:**\n - **Full:** Displays both icons and labels for all navigation items (default).\n - **IconOnly:** Shows only icons for a compact appearance. *Should only be used when no navigation items have sub-items or flyouts.*\n - **IconOnlyLarge:** Icon-only mode that supports flyouts/submenus. Use when navigation contains groups or nested items.\n - **Compact:** Reduces padding and overall width for a space-saving layout.\n - **Tree:** Renders the same `obc-navigation-item` / `obc-navigation-item-group`\n markup as a hierarchical tree. Groups expand inline (instead of as flyouts),\n rows are indented by depth, multiple branches can stay open at once, and the\n tree-row presentation (alert badges, terminal marker) is available via the\n items' `alerts`/`terminalType` properties.\n- **Responsive Layout:**\n - `smallScreen` property adapts the footer and logo layout for smaller viewports.\n- **Slot-based Content:**\n - `main` slot for primary navigation items and groups.\n - `footer` slot for secondary actions or links.\n - `logo` slot for branding or logo placement (position adapts based on variant and screen size).\n- **Nested Navigation:**\n - Supports nested groups and flyouts via `<obc-navigation-item-group>`.\n- **Automatic Variant Propagation:**\n - Child items and groups automatically receive the correct variant for consistent appearance.\n- **Dynamic Content Handling:**\n - Reacts to dynamic addition/removal of items and groups, updating layout and variants as needed.\n- **Interaction:**\n - Clicking a navigation item closes all open groups/flyouts for streamlined navigation.\n\n## Usage Guidelines\n\nUse `<obc-navigation-menu>` as the main navigation container in your application layout. Place navigation items and groups in the `main` slot for primary navigation, and use the `footer` slot for secondary actions (such as settings or help). The `logo` slot is intended for branding and is positioned according to the selected variant and screen size.\n\n- Use the `Full` variant for standard navigation with both icons and labels.\n- Use `IconOnly` only when there are no nested groups or flyouts; otherwise, use `IconOnlyLarge` for icon-only navigation with flyout support.\n- The `Compact` variant is suitable for layouts with limited space or when a minimal navigation appearance is desired.\n- Use the `Tree` variant for hierarchical navigation (file trees, nested\n sections). The existing item/group markup is reused unchanged — only the\n `variant` changes. Footer and logo slots remain flat. Mark a group with\n `defaultOpen` to have it start expanded.\n- Set `smallScreen` to `true` to optimize the layout for smaller devices or responsive breakpoints.\n\n**TODO(designer):** Provide additional guidance on when to use each variant and recommended slot content for best usability.\n\n## Slots\n\n| Slot Name | Renders When... | Purpose |\n|-----------|----------------|---------|\n| main | Always | Primary navigation items and groups. |\n| footer | Always | Secondary navigation items (e.g., settings, help). |\n| logo | Always | Branding/logo area (position varies by variant and screen size). |\n\nPlace `<obc-navigation-item>`, `<obc-navigation-item-group>`, or other suitable elements in these slots. For icons, use `<obi-placeholder>`, `<obi-applications>`, or other OpenBridge icon components in the `icon` slot of each navigation item.\n\n## Properties\n\n- `variant` (`ObcNavigationMenuVariant`): Controls the visual style and layout of the menu. Default is `Full`.\n- `smallScreen` (`boolean`): When `true`, adapts the layout for small screens (e.g., moves logo into the footer area).\n\n## Best Practices and Constraints\n\n- Only use the `IconOnly` variant when there are no navigation items with sub-items or flyouts. Use `IconOnlyLarge` if your navigation includes groups or nested items.\n- Place only navigation-related components in the `main` and `footer` slots for clarity and accessibility.\n- For best accessibility, ensure each navigation item has a clear label and, if using icons, a suitable `aria-label` or accessible name.\n- Avoid placing interactive elements other than navigation items/groups in the `main` or `footer` slots.\n\n## Example\n\n```html\n<obc-navigation-menu variant=\"full\">\n <obc-navigation-item-group slot=\"main\" label=\"Apps\">\n <obi-applications slot=\"icon\"></obi-applications>\n <obc-navigation-item label=\"Sub item 1\" hasIcon href=\"#\">\n <obi-placeholder slot=\"icon\"></obi-placeholder>\n </obc-navigation-item>\n </obc-navigation-item-group>\n <obc-navigation-item slot=\"footer\" label=\"Settings\" hasIcon href=\"#\">\n <obi-settings-iec slot=\"icon\"></obi-settings-iec>\n </obc-navigation-item>\n <obc-vendor-button imageSrc=\"/companylogo-day.png\" alt=\"logo\" slot=\"logo\"></obc-vendor-button>\n</obc-navigation-menu>\n```\n\nIn this example, the menu displays a group with sub-items in the main navigation, several footer actions, and a logo.",
|
|
51219
51143
|
"name": "ObcNavigationMenu",
|
|
51220
51144
|
"slots": [
|
|
51221
51145
|
{
|
|
@@ -66742,7 +66666,7 @@
|
|
|
66742
66666
|
"declarations": [
|
|
66743
66667
|
{
|
|
66744
66668
|
"kind": "class",
|
|
66745
|
-
"description": "`<obc-tree-navigation-group>` – An expandable parent row in a tree-navigation\nstructure: a header row with an expand/collapse chevron, plus a slot for the\nchild rows it discloses.\n\nA group renders an `<obc-tree-navigation-item>` header (carrying its own label,\nicon, terminal type, and alert
|
|
66669
|
+
"description": "`<obc-tree-navigation-group>` – An expandable parent row in a tree-navigation\nstructure: a header row with an expand/collapse chevron, plus a slot for the\nchild rows it discloses.\n\nA group renders an `<obc-tree-navigation-item>` header (carrying its own label,\nicon, terminal type, and alert badges) followed by its slotted children. When\nplaced inside `<obc-tree-navigation>`, the container computes and assigns the\n`branches` guide lines for every row automatically from each row's position —\na group does not need its depth configured by hand.\n\nThe group manages only its own open/closed state and forwards header presentation\nto its internal header item. It does not draw guide lines itself; that is the\ncontainer's responsibility (see `<obc-tree-navigation>`).\n\n## Features\n- **Disclosure:** A chevron in the header toggles the slotted children. The open\n state is held in `expanded` and reflected so the container and CSS can react.\n- **Header presentation:** `label`, the `icon` slot, `terminalType`, and the\n `alerts` count map are forwarded to the header row.\n- **Selection:** `checked` marks the group's header as the current item.\n- **Automatic guides:** Inside `<obc-tree-navigation>`, the header's `branches`\n are assigned by the container; nested groups continue the guide columns down.\n\n## Usage Guidelines\n- Nest `<obc-tree-navigation-item>` (leaves) and further `<obc-tree-navigation-group>`\n elements as children to build the hierarchy.\n- Always place groups and items inside an `<obc-tree-navigation>` container so the\n guide lines are computed; using a group standalone draws a header with no guides.\n- Provide a header icon via the `icon` slot (forwarded to the header row).\n\n## Slots\n\n| Slot Name | Renders When... | Purpose |\n|-----------|--------------------------|--------------------------------------------------------------|\n| icon | `hasIcon` is true | Leading icon for the group header row. |\n| (default) | Always | Child rows (`obc-tree-navigation-item` / `-group`). |",
|
|
66746
66670
|
"name": "ObcTreeNavigationGroup",
|
|
66747
66671
|
"slots": [
|
|
66748
66672
|
{
|
|
@@ -66828,32 +66752,12 @@
|
|
|
66828
66752
|
},
|
|
66829
66753
|
{
|
|
66830
66754
|
"kind": "field",
|
|
66831
|
-
"name": "
|
|
66832
|
-
"type": {
|
|
66833
|
-
"text": "boolean"
|
|
66834
|
-
},
|
|
66835
|
-
"default": "false",
|
|
66836
|
-
"description": "Whether a trailing alert counter badge is shown on the header row.",
|
|
66837
|
-
"attribute": "hasAlertBadge"
|
|
66838
|
-
},
|
|
66839
|
-
{
|
|
66840
|
-
"kind": "field",
|
|
66841
|
-
"name": "alertCount",
|
|
66842
|
-
"type": {
|
|
66843
|
-
"text": "number"
|
|
66844
|
-
},
|
|
66845
|
-
"default": "0",
|
|
66846
|
-
"description": "The number shown in the header's alert badge when `hasAlertBadge` is true.",
|
|
66847
|
-
"attribute": "alertCount"
|
|
66848
|
-
},
|
|
66849
|
-
{
|
|
66850
|
-
"kind": "field",
|
|
66851
|
-
"name": "alertType",
|
|
66755
|
+
"name": "alerts",
|
|
66852
66756
|
"type": {
|
|
66853
|
-
"text": "
|
|
66757
|
+
"text": "TreeNavigationItemAlerts | undefined"
|
|
66854
66758
|
},
|
|
66855
|
-
"description": "
|
|
66856
|
-
"attribute": "
|
|
66759
|
+
"description": "Per-severity alert counts shown as trailing badge(s) on the header row.\nForwarded verbatim to the header `<obc-tree-navigation-item>` — typically a\ngroup sets `{aggregate: true, ...}` so its header shows one badge totalling\nthe alerts of the rows beneath it. See TreeNavigationItemAlerts.",
|
|
66760
|
+
"attribute": "alerts"
|
|
66857
66761
|
},
|
|
66858
66762
|
{
|
|
66859
66763
|
"kind": "field",
|
|
@@ -66974,30 +66878,12 @@
|
|
|
66974
66878
|
"fieldName": "terminalType"
|
|
66975
66879
|
},
|
|
66976
66880
|
{
|
|
66977
|
-
"name": "
|
|
66978
|
-
"type": {
|
|
66979
|
-
"text": "boolean"
|
|
66980
|
-
},
|
|
66981
|
-
"default": "false",
|
|
66982
|
-
"description": "Whether a trailing alert counter badge is shown on the header row.",
|
|
66983
|
-
"fieldName": "hasAlertBadge"
|
|
66984
|
-
},
|
|
66985
|
-
{
|
|
66986
|
-
"name": "alertCount",
|
|
66881
|
+
"name": "alerts",
|
|
66987
66882
|
"type": {
|
|
66988
|
-
"text": "
|
|
66883
|
+
"text": "TreeNavigationItemAlerts | undefined"
|
|
66989
66884
|
},
|
|
66990
|
-
"
|
|
66991
|
-
"
|
|
66992
|
-
"fieldName": "alertCount"
|
|
66993
|
-
},
|
|
66994
|
-
{
|
|
66995
|
-
"name": "alertType",
|
|
66996
|
-
"type": {
|
|
66997
|
-
"text": "string"
|
|
66998
|
-
},
|
|
66999
|
-
"description": "The severity/type of the header's alert badge. One of the `obc-badge` types (default `alarm`).",
|
|
67000
|
-
"fieldName": "alertType"
|
|
66885
|
+
"description": "Per-severity alert counts shown as trailing badge(s) on the header row.\nForwarded verbatim to the header `<obc-tree-navigation-item>` — typically a\ngroup sets `{aggregate: true, ...}` so its header shows one badge totalling\nthe alerts of the rows beneath it. See TreeNavigationItemAlerts.",
|
|
66886
|
+
"fieldName": "alerts"
|
|
67001
66887
|
},
|
|
67002
66888
|
{
|
|
67003
66889
|
"name": "href",
|
|
@@ -67041,7 +66927,7 @@
|
|
|
67041
66927
|
"declarations": [
|
|
67042
66928
|
{
|
|
67043
66929
|
"kind": "class",
|
|
67044
|
-
"description": "`<obc-tree-navigation-item>` – A single row in a tree- or file-explorer-style\nnavigation list, with indentation guide lines, an optional expand/collapse\nchevron, a leading icon, a label, and an optional alert badge.\n\nEach row represents one node in a hierarchy. Depth is expressed through the\n`branches` array: one entry per ancestor level, each describing the guide line\nto draw for that level. The expand chevron lets a node disclose its children,\nemitting `expand-toggle` so a parent can manage the open/closed state.\n\n## Features\n- **Indentation guides:** Render one 32px guide column per `branches` entry —\n pass-through vertical lines for ancestors that continue, and an elbow\n (`intersection`) connecting the row to its parent.\n- **Expand/collapse:** Set `expandable` to show a chevron that rotates when\n `expanded`. The chevron is a visual indicator only — activating the row\n fires `expand-toggle` with the next state; manage `expanded` in response.\n When `expanded`, a vertical guide descends from the chevron to connect to\n the revealed child rows below.\n- **Terminal type:** `terminalType` adds an alert-header marker in the terminal\n (`aggregatedHeader` or `groupHeader`), indicating the node heads a set of\n aggregated or grouped alerts.\n- **Leading icon:** Provide an icon via the `icon` slot (shown when\n `hasLeadingIcon`).\n- **Alert
|
|
66930
|
+
"description": "`<obc-tree-navigation-item>` – A single row in a tree- or file-explorer-style\nnavigation list, with indentation guide lines, an optional expand/collapse\nchevron, a leading icon, a label, and an optional alert badge.\n\nEach row represents one node in a hierarchy. Depth is expressed through the\n`branches` array: one entry per ancestor level, each describing the guide line\nto draw for that level. The expand chevron lets a node disclose its children,\nemitting `expand-toggle` so a parent can manage the open/closed state.\n\n## Features\n- **Indentation guides:** Render one 32px guide column per `branches` entry —\n pass-through vertical lines for ancestors that continue, and an elbow\n (`intersection`) connecting the row to its parent.\n- **Expand/collapse:** Set `expandable` to show a chevron that rotates when\n `expanded`. The chevron is a visual indicator only — activating the row\n fires `expand-toggle` with the next state; manage `expanded` in response.\n When `expanded`, a vertical guide descends from the chevron to connect to\n the revealed child rows below.\n- **Terminal type:** `terminalType` adds an alert-header marker in the terminal\n (`aggregatedHeader` or `groupHeader`), indicating the node heads a set of\n aggregated or grouped alerts.\n- **Leading icon:** Provide an icon via the `icon` slot (shown when\n `hasLeadingIcon`).\n- **Alert badges:** Trailing counter badges driven by the `alerts` object — a\n per-severity count map with one field per level severity (critical, high,\n medium, low, diagnostic). By default each non-zero count renders its own\n badge, ordered most to least severe by `ALERT_SEVERITY_PRIORITY`; set\n `alerts.aggregate` to instead show a single badge with the combined total,\n styled as the highest category present.\n- **Checked state:** `checked` highlights the current selection using the\n amplified elevation style. A checked row is the current item and is not\n re-selectable — it shows no hover/pressed feedback and fires no `click` or\n navigation. An expandable checked row still toggles (fires `expand-toggle`),\n so a group that is the current selection can be opened and closed. It stays\n keyboard-focusable.\n- **Link or button:** Set `href` to render the row as a link; otherwise it acts\n as a button.\n\n## Usage Guidelines\n- Use for hierarchical navigation such as file trees, layer panels, or nested\n menus. For flat navigation lists, use `obc-navigation-item` instead.\n- Build `branches` from the row's ancestry: `intersection` for the level that\n owns this row, `straight` for ancestors with siblings still to come, and\n `blank` for ancestors whose subtrees have ended. When placed inside\n `obc-tree-navigation`, the container computes `branches` automatically.\n- Keep one row `checked` at a time within a tree to mark the current location.\n- Leaf nodes should leave `expandable` as `false` so no chevron is shown.\n\n## Slots\n\n| Slot Name | Renders When... | Purpose |\n|----------------|---------------------------------|-------------------------------------------------------------------------|\n| icon | `hasLeadingIcon` is true | Leading icon for the row, e.g. `<obi-placeholder slot=\"icon\">`. |",
|
|
67045
66931
|
"name": "ObcTreeNavigationItem",
|
|
67046
66932
|
"slots": [
|
|
67047
66933
|
{
|
|
@@ -67142,32 +67028,12 @@
|
|
|
67142
67028
|
},
|
|
67143
67029
|
{
|
|
67144
67030
|
"kind": "field",
|
|
67145
|
-
"name": "
|
|
67146
|
-
"type": {
|
|
67147
|
-
"text": "boolean"
|
|
67148
|
-
},
|
|
67149
|
-
"default": "false",
|
|
67150
|
-
"description": "Whether a trailing alert counter badge is shown.",
|
|
67151
|
-
"attribute": "hasAlertBadge"
|
|
67152
|
-
},
|
|
67153
|
-
{
|
|
67154
|
-
"kind": "field",
|
|
67155
|
-
"name": "alertCount",
|
|
67031
|
+
"name": "alerts",
|
|
67156
67032
|
"type": {
|
|
67157
|
-
"text": "
|
|
67033
|
+
"text": "TreeNavigationItemAlerts | undefined"
|
|
67158
67034
|
},
|
|
67159
|
-
"
|
|
67160
|
-
"
|
|
67161
|
-
"attribute": "alertCount"
|
|
67162
|
-
},
|
|
67163
|
-
{
|
|
67164
|
-
"kind": "field",
|
|
67165
|
-
"name": "alertType",
|
|
67166
|
-
"type": {
|
|
67167
|
-
"text": "string"
|
|
67168
|
-
},
|
|
67169
|
-
"description": "The severity/type of the alert badge. One of the `obc-badge` types (default `alarm`).",
|
|
67170
|
-
"attribute": "alertType"
|
|
67035
|
+
"description": "Per-severity alert counts for the row's trailing badge(s). Omit (or leave\nevery count at 0) for a row with no alerts. See TreeNavigationItemAlerts.\n\n- When `aggregate` is true, a single badge is shown: its number is the sum\n of all counts and its severity is the highest category present\n (critical → alarm → warning → caution).\n- Otherwise one badge is shown per count greater than 0, ordered most to\n least severe and spaced by the alert-counter spacing token.",
|
|
67036
|
+
"attribute": "alerts"
|
|
67171
67037
|
},
|
|
67172
67038
|
{
|
|
67173
67039
|
"kind": "field",
|
|
@@ -67206,6 +67072,16 @@
|
|
|
67206
67072
|
],
|
|
67207
67073
|
"description": "Focuses the row's interactive wrapper (the host itself is not focusable)."
|
|
67208
67074
|
},
|
|
67075
|
+
{
|
|
67076
|
+
"kind": "field",
|
|
67077
|
+
"name": "alertBadges",
|
|
67078
|
+
"type": {
|
|
67079
|
+
"text": "{type: AlertType; count: number}[]"
|
|
67080
|
+
},
|
|
67081
|
+
"privacy": "private",
|
|
67082
|
+
"description": "The badge(s) to render from `alerts`, as `{type, count}` pairs already in\nseverity order, ranked by `ALERT_SEVERITY_PRIORITY`.\n\n- No `alerts`, or every count 0 → no badges.\n- `aggregate` → a single pair: the summed count typed as the highest\n category that has any alerts.\n- Otherwise → one pair per count greater than 0.",
|
|
67083
|
+
"readonly": true
|
|
67084
|
+
},
|
|
67209
67085
|
{
|
|
67210
67086
|
"kind": "field",
|
|
67211
67087
|
"name": "isRoot",
|
|
@@ -67343,30 +67219,12 @@
|
|
|
67343
67219
|
"fieldName": "terminalType"
|
|
67344
67220
|
},
|
|
67345
67221
|
{
|
|
67346
|
-
"name": "
|
|
67347
|
-
"type": {
|
|
67348
|
-
"text": "boolean"
|
|
67349
|
-
},
|
|
67350
|
-
"default": "false",
|
|
67351
|
-
"description": "Whether a trailing alert counter badge is shown.",
|
|
67352
|
-
"fieldName": "hasAlertBadge"
|
|
67353
|
-
},
|
|
67354
|
-
{
|
|
67355
|
-
"name": "alertCount",
|
|
67356
|
-
"type": {
|
|
67357
|
-
"text": "number"
|
|
67358
|
-
},
|
|
67359
|
-
"default": "0",
|
|
67360
|
-
"description": "The number shown in the alert badge when `hasAlertBadge` is true.",
|
|
67361
|
-
"fieldName": "alertCount"
|
|
67362
|
-
},
|
|
67363
|
-
{
|
|
67364
|
-
"name": "alertType",
|
|
67222
|
+
"name": "alerts",
|
|
67365
67223
|
"type": {
|
|
67366
|
-
"text": "
|
|
67224
|
+
"text": "TreeNavigationItemAlerts | undefined"
|
|
67367
67225
|
},
|
|
67368
|
-
"description": "
|
|
67369
|
-
"fieldName": "
|
|
67226
|
+
"description": "Per-severity alert counts for the row's trailing badge(s). Omit (or leave\nevery count at 0) for a row with no alerts. See TreeNavigationItemAlerts.\n\n- When `aggregate` is true, a single badge is shown: its number is the sum\n of all counts and its severity is the highest category present\n (critical → alarm → warning → caution).\n- Otherwise one badge is shown per count greater than 0, ordered most to\n least severe and spaced by the alert-counter spacing token.",
|
|
67227
|
+
"fieldName": "alerts"
|
|
67370
67228
|
},
|
|
67371
67229
|
{
|
|
67372
67230
|
"name": "href",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alert-severity.d.ts","sourceRoot":"","sources":["../src/alert-severity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,OAAO,EAAC,SAAS,EAAE,uBAAuB,EAAC,MAAM,YAAY,CAAC;AAE9D,OAAO,EAAC,uBAAuB,EAAC,CAAC;AAEjC,oBAAY,mBAAmB;IAC7B,KAAK,oBAAoB;IACzB,OAAO,sBAAsB;IAC7B,OAAO,sBAAsB;IAC7B,QAAQ,uBAAuB;IAC/B,UAAU,yBAAyB;CACpC;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAShE;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CASzD;AAED,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAEhE;AAED,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,SAAS,GAAG,gBAAgB,CAqCrE;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,SAAS,GAAG,mBAAmB,CAiB3E;AAED,oBAAY,qBAAqB;IAC/B,KAAK,6BAA6B;IAClC,OAAO,+BAA+B;IACtC,OAAO,+BAA+B;IACtC,QAAQ,gCAAgC;IACxC,UAAU,kCAAkC;CAC7C;AAED,wBAAgB,wBAAwB,CACtC,IAAI,EAAE,SAAS,GACd,qBAAqB,CAiBvB;AAED,oBAAY,cAAc;IACxB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,GAAG,QAAQ;CACZ;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,SAAS,GAAG,cAAc,CAejE;AAED,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,CAYrE;AAED,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAElE;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,
|
|
1
|
+
{"version":3,"file":"alert-severity.d.ts","sourceRoot":"","sources":["../src/alert-severity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,OAAO,EAAC,SAAS,EAAE,uBAAuB,EAAC,MAAM,YAAY,CAAC;AAE9D,OAAO,EAAC,uBAAuB,EAAC,CAAC;AAEjC,oBAAY,mBAAmB;IAC7B,KAAK,oBAAoB;IACzB,OAAO,sBAAsB;IAC7B,OAAO,sBAAsB;IAC7B,QAAQ,uBAAuB;IAC/B,UAAU,yBAAyB;CACpC;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAShE;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CASzD;AAED,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAEhE;AAED,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,SAAS,GAAG,gBAAgB,CAqCrE;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,SAAS,GAAG,mBAAmB,CAiB3E;AAED,oBAAY,qBAAqB;IAC/B,KAAK,6BAA6B;IAClC,OAAO,+BAA+B;IACtC,OAAO,+BAA+B;IACtC,QAAQ,gCAAgC;IACxC,UAAU,kCAAkC;CAC7C;AAED,wBAAgB,wBAAwB,CACtC,IAAI,EAAE,SAAS,GACd,qBAAqB,CAiBvB;AAED,oBAAY,cAAc;IACxB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,GAAG,QAAQ;CACZ;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,SAAS,GAAG,cAAc,CAejE;AAED,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,CAYrE;AAED,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAElE;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAM3D"}
|