@oicl/openbridge-webcomponents-full-bundle 2.0.0-next.117 → 2.0.0-next.118

package/src/ar/poi/poi-base.ts

@@ -47,6 +47,12 @@ const VALID_POI_STATES = new Set(Object.values(ObcPoiState));
  * layout-change dispatch, and visual-query logic so that each variant
  * only needs to override `renderContent()` and `getVisualNodes()`.
  *
+ * The `@fires` tag below documents the dispatch site, which lives here rather
+ * than in the variants. It is deliberately duplicated on each concrete
+ * subclass — that is where `custom-elements.json` and the framework wrappers
+ * pick the event up, since this class is not registered. Do not remove it from
+ * the subclasses. `@ignore` keeps this class out of the generated docs.
+ *
  * @fires {CustomEvent<void>} obc-poi-data-layout-change - Fired when layout-driving properties change. Bubbles and is composed.
  * @ignore
  */

package/src/ar/poi-button/poi-button.ts

@@ -116,8 +116,8 @@ export interface ObcPoiButtonDataItem {
  * - `relation`: Optional relation icon/content rendered when `hasRelation` is true in data mode.
  *
  * ## Events
- * This component does not emit custom events.
- * - Emits a standard `click` event (`onClick` handler in framework wrappers) when activated.
+ * This component emits no custom events. A standard `click` bubbles from the
+ * internal `<button>` (`onClick` in the framework wrappers).
  *
  * ## Best Practices
  * - Keep `value`, `state`, and `selected` synchronized to avoid conflicting visual states.

package/src/components/accordion-card/accordion-card.ts

@@ -210,7 +210,8 @@ export class ObcAccordionCard extends LitElement {
     this.expanded = !this.expanded;
 
     /**
-     * @fires {CustomEvent<{expanded: boolean, cardTitle: string}>} accordion-toggle - Fired when the accordion is expanded or collapsed.
+     * Fired when the accordion is expanded or collapsed.
+     * @fires accordion-toggle
      */
     this.dispatchEvent(
       new CustomEvent('accordion-toggle', {

package/src/components/advice-message-item/advice-message-item.ts

@@ -223,14 +223,16 @@ export class ObcAdviceMessageItem extends LitElement {
   }
 
   /**
-   * @fires {CustomEvent<void>} message-click - Fired when the main message area is clicked.
+   * Fired when the main message area is clicked.
+   * @fires message-click
    */
   private handleMessageClick() {
     this.dispatchEvent(new CustomEvent('message-click'));
   }
 
   /**
-   * @fires {CustomEvent<void>} action-click - Fired when the action button (text or icon) is clicked.
+   * Fired when the action button (text or icon) is clicked.
+   * @fires action-click
    */
   private handleActionClick() {
     this.dispatchEvent(new CustomEvent('action-click'));

package/src/components/app-menu/app-menu.ts

@@ -56,7 +56,7 @@ export class ObcAppMenu extends LitElement {
    * Handles input events from the search field and emits a `search` event with the current value.
    *
    * @param e - The input event from the search field.
-   * @fires {CustomEvent<string>} search - Fired when the search input value changes.
+   * @fires search
    */
   onSearchInput(e: Event) {
     this.dispatchEvent(

package/src/components/brilliance-menu/brilliance-menu.ts

@@ -212,7 +212,8 @@ export class ObcBrillianceMenu extends LitElement {
   }
 
   /**
-   * @fires palette-changed - Handles palette selection changes and emits `palette-changed`.
+   * Handles palette selection changes and emits `palette-changed`.
+   * @fires palette-changed
    * @param {CustomEvent} event
    */
   onPaletteChanged(event: CustomEvent) {
@@ -225,7 +226,8 @@ export class ObcBrillianceMenu extends LitElement {
   }
 
   /**
-   * @fires brightness-changed - Handles brightness slider changes and emits `brightness-changed`.
+   * Handles brightness slider changes and emits `brightness-changed`.
+   * @fires brightness-changed
    * @param {CustomEvent} event
    */
   handleBrightnessChanged(event: CustomEvent) {
@@ -258,7 +260,8 @@ export class ObcBrillianceMenu extends LitElement {
   }
 
   /**
-   * @fires link-palette-changed - Handles link palette changes and emits `link-palette-changed`.
+   * Handles link palette changes and emits `link-palette-changed`.
+   * @fires link-palette-changed
    * @param {CustomEvent} event
    */
   onLinkPaletteChanged(event: CustomEvent) {
@@ -270,7 +273,8 @@ export class ObcBrillianceMenu extends LitElement {
   }
 
   /**
-   * @fires link-brightness-changed - Handles link brightness changes and emits `link-brightness-changed`.
+   * Handles link brightness changes and emits `link-brightness-changed`.
+   * @fires link-brightness-changed
    * @param {CustomEvent} event
    */
   onLinkBrightnessChanged(event: CustomEvent) {

package/src/components/check-button/check-button.ts

@@ -197,7 +197,7 @@ export class ObcCheckButton extends LitElement {
      * Fired after the user toggles the check button.
      * The event detail includes the new checked state and the type of the button.
      *
-     * @fires {CustomEvent<{checked: boolean, type: string}>} check-button-click - Fired after the user toggles the control.
+     * @fires check-button-click
      */
     this.dispatchEvent(
       new CustomEvent('check-button-click', {

package/src/components/checkbox/checkbox.ts

@@ -96,8 +96,8 @@ export type ObcCheckboxChangeEvent = CustomEvent<{
  * ```
  *
  * @slot - No named slots.
- * @fires {ObcCheckboxChangeEvent} change - – Emitted when the status changes.
- * @fires {ObcCheckboxChangeEvent} disabled - – Emitted when the disabled state changes.
+ * @fires {ObcCheckboxChangeEvent} change - Emitted when the status changes.
+ * @fires {ObcCheckboxChangeEvent} disabled - Emitted when the disabled state changes.
  * @stable
  */
 @customElement('obc-checkbox')

package/src/components/command-menu/command-menu.ts

@@ -177,7 +177,7 @@ export class ObcCommandMenu extends LitElement {
   /**
    * Handles the toggle change event from the start-stop switch and emits a `change` event with the new command state.
    *
-   * @fires {CustomEvent<{inCommand: boolean}>} change - Fired when the command state is toggled.
+   * @fires change
    */
   private onChange(event: ObcStartStopSwitchChangeEvent) {
     // Stop the start-stop-switch's composed event from leaking through

package/src/components/dropdown-button/dropdown-button.ts

@@ -224,8 +224,8 @@ export class ObcDropdownButton extends LitElement {
   /**
    * Handles the dropdown-change and change event when a new option is selected. Updates the selected value and label, and dispatches a `dropdown-change` and 'change' event with the new selection.
    *
-   * @fires {ObcDropdownButtonChangeEvent} dropdown-change - Fired when the user selects a different option.
-   * @fires {ObcDropdownButtonChangeEvent} change - Fired when the user selects a different option.
+   * @fires dropdown-change
+   * @fires change
    */
   private changeHandler(event: Event) {
     const target = event.target as HTMLSelectElement;

package/src/components/menu-button/menu-button.ts

@@ -266,7 +266,8 @@ export class ObcMenuButton extends LitElement {
     if (e.newState === 'open') {
       void this.focusMenuAfterOpen();
       /**
-       * @event open - Fired when the menu is opened.
+       * Fired when the menu is opened.
+       * @event open
        * @type {CustomEvent<void>}
        */
       this.dispatchEvent(new CustomEvent('open'));
@@ -277,7 +278,8 @@ export class ObcMenuButton extends LitElement {
         this.triggerButton?.focus();
       }
       /**
-       * @event close - Fired when the menu is closed.
+       * Fired when the menu is closed.
+       * @event close
        * @type {CustomEvent<void>}
        */
       this.dispatchEvent(new CustomEvent('close'));
@@ -337,7 +339,8 @@ export class ObcMenuButton extends LitElement {
     this.selectedValues = e.detail.selectedValues;
 
     /**
-     * @event change - Fired when the menu selection changes.
+     * Fired when the menu selection changes.
+     * @event change
      * @type {CustomEvent<{selectedValues: string[], selectedOptions: Array<ContextMenuOption>}>}
      */
     this.dispatchEvent(new CustomEvent('change', {detail: e.detail}));
@@ -350,7 +353,8 @@ export class ObcMenuButton extends LitElement {
     e: CustomEvent<{value: string; option: ContextMenuOption}>
   ) {
     /**
-     * @event item-click - Fired when a menu item is clicked.
+     * Fired when a menu item is clicked.
+     * @event item-click
      * @type {CustomEvent<{value: string, option: ContextMenuOption}>}
      */
     this.dispatchEvent(new CustomEvent('item-click', {detail: e.detail}));

package/src/components/navigation-item/navigation-item.ts

@@ -98,7 +98,7 @@ enum NavigationItemRole {
  *
  * @slot icon - Leading icon slot (optional, shown if provided). Set `hasIcon` to `true` to show the icon.
  * @slot trailing-icon - Trailing icon slot (optional, shown if provided). Set `hasTrailingIcon` to `true` to show.
- * @fires {CustomEvent<void>} click - Fired when the navigation item is clicked.
+ * @fires click - Fired when the navigation item is clicked, either as a link or as a button.
  * @stable
  */
 
@@ -176,13 +176,6 @@ export class ObcNavigationItem extends LitElement {
   // In tree mode the row renders an `obc-tree-navigation-item` instead of an `<a>`.
   @query('obc-tree-navigation-item') private treeItemElement?: HTMLElement;
 
-  /**
-   * @fires {CustomEvent<void>} click - Fired when the navigation item is clicked (either as a link or button).
-   */
-  onClick() {
-    dispatchEvent(new CustomEvent('click'));
-  }
-
   private handleKeydown(event: KeyboardEvent) {
     const isMenuItem =
       this.getAttribute('role') === NavigationItemRole.MenuItem;
@@ -233,7 +226,6 @@ export class ObcNavigationItem extends LitElement {
           .href=${this.href}
           .terminalType=${this.terminalType}
           .alerts=${this.alerts}
-          @click=${this.onClick}
         >
           ${this.hasIcon
             ? html`<slot name="icon" slot="icon"></slot>`
@@ -256,7 +248,6 @@ export class ObcNavigationItem extends LitElement {
           [this.variant]: true,
         })}"
         href=${ifDefined(this.href)}
-        @click=${this.onClick}
         @keydown=${this.handleKeydown}
         tabindex=${ifDefined(this.getItemTabIndex())}
         role=${ifDefined(this.getItemRole())}

package/src/components/navigation-item-group/navigation-item-group.ts

@@ -146,7 +146,8 @@ export class ObcNavigationItemGroup extends LitElement {
   }
 
   /**
-   * @fires open - Opens the flyout panel and emits the `open` event.
+   * Opens the flyout panel and emits the `open` event.
+   * @fires open
    */
   open() {
     this.openContainer = true;

package/src/components/notification-button/notification-button.ts

@@ -207,7 +207,7 @@ export class ObcNotificationButton extends LitElement {
   /**
    * Handles click events on the button and dispatches the `obc-click` custom event.
    *
-   * @fires {CustomEvent<NotificationButtonClickEvent>} obc-click - Fired with the current count and new active state.
+   * @fires obc-click
    */
   private handleClick() {
     const event = new CustomEvent<NotificationButtonClickEvent>('obc-click', {

package/src/components/notification-message-item/notification-message-item.ts

@@ -230,14 +230,16 @@ export class ObcNotificationMessageItem extends LitElement {
   }
 
   /**
-   * @event message-click - Fired when the notification item is clicked (excluding the action area).
+   * Fired when the notification item is clicked (excluding the action area).
+   * @event message-click
    */
   private handleMessageClick() {
     this.dispatchEvent(new CustomEvent('message-click'));
   }
 
   /**
-   * @event action-click - Fired when the action button or icon is clicked.
+   * Fired when the action button or icon is clicked.
+   * @event action-click
    */
   private handleActionClick() {
     this.dispatchEvent(new CustomEvent('action-click'));

package/src/components/pivot-item/pivot-item.ts

@@ -121,7 +121,7 @@ export class ObcPivotItem extends LitElement {
   /**
    * Handles click events. Emits `selected` when the item is not disabled or already selected.
    *
-   * @fires {CustomEvent<{value: string}>} selected - When the item is clicked and becomes selected
+   * @fires selected
    */
   private onClick() {
     // Don't allow clicking if disabled OR already selected

package/src/components/slide-button/slide-button.ts

@@ -190,7 +190,8 @@ export class ObcSlideButton extends LitElement {
   private completeSlide() {
     /**
      * Emitted when the slide action is completed (handle dragged past the
-     * @fires {ObcSlideButtonSlideEvent} slide - threshold or activated via keyboard).
+     * threshold or activated via keyboard).
+     * @fires slide
      */
     this.dispatchEvent(new CustomEvent('slide', {detail: {completed: true}}));
 

package/src/components/slider/slider.ts

@@ -235,7 +235,7 @@ export class ObcSlider extends LitElement {
    * Fires the `value` event with the new value.
    *
    * @param value - The new value to set.
-   * @fires value - Fired when the value is changed
+   * @fires value
    */
   onInput(value: number) {
     this.value = value;
@@ -245,7 +245,7 @@ export class ObcSlider extends LitElement {
   /**
    * Fires the `change` event with the current value.
    *
-   * @fires change - Fired when user interaction completes; dispatched on release even if the value did not change
+   * @fires change
    */
   private fireChangeEvent() {
     this.dispatchEvent(

package/src/components/slider-double/slider-double.ts

@@ -269,7 +269,7 @@ export class ObcSliderDouble extends LitElement {
    * Handles input changes from the slider thumbs.
    * Updates the low and high values and emits the `value` event.
    *
-   * @fires {ObcSliderDoubleValueEvent} value - Fires when the value is changed
+   * @fires value
    */
   onInput() {
     let newLow = parseFloat(this.minInput.value);
@@ -292,7 +292,7 @@ export class ObcSliderDouble extends LitElement {
   /**
    * Fires the `change` event with the current low and high values.
    *
-   * @fires change - Fires when user interaction completes
+   * @fires change
    */
   private fireChangeEvent() {
     this.dispatchEvent(

package/src/components/stepper-box/stepper-box.ts

@@ -280,7 +280,8 @@ export class ObcStepperBox extends LitElement {
   }
 
   /**
-   * @fires down - Dispatches the `down` event when the decrement button is clicked.
+   * Dispatches the `down` event when the decrement button is clicked.
+   * @fires down
    */
   down() {
     if (this.downDisabled) {
@@ -300,7 +301,8 @@ export class ObcStepperBox extends LitElement {
   }
 
   /**
-   * @fires up - Dispatches the `up` event when the increment button is clicked.
+   * Dispatches the `up` event when the increment button is clicked.
+   * @fires up
    */
   up() {
     if (this.upDisabled) {

package/src/components/system-button/system-button.ts

@@ -197,7 +197,7 @@ export class ObcSystemButton extends LitElement {
     /**
      * Fired when the expanded variant is toggled open or closed.
      *
-     * @event menu-toggle - When the expanded variant is toggled open or closed
+     * @event menu-toggle
      * @type {CustomEvent<{open: boolean}>}
      */
     this.dispatchEvent(
@@ -212,7 +212,7 @@ export class ObcSystemButton extends LitElement {
    * Called by the System Menu component.
    *
    * @param newState Partial system state to merge with the current state.
-   * @fires {CustomEvent<{state: SystemState}>} system-state-change - When the system state is updated
+   * @fires system-state-change
    */
   public updateSystemState(newState: Partial<SystemState>) {
     this.systemState = {...this.systemState, ...newState};
@@ -238,7 +238,7 @@ export class ObcSystemButton extends LitElement {
     /**
      * Fired when the microphone action segment is activated.
      *
-     * @event microphone-panel-open - When the microphone action segment is activated
+     * @event microphone-panel-open
      * @type {CustomEvent<void>}
      */
     this.dispatchEvent(new CustomEvent('microphone-panel-open'));
@@ -250,7 +250,7 @@ export class ObcSystemButton extends LitElement {
     /**
      * Fired when the volume action segment is activated.
      *
-     * @event volume-panel-open - When the volume action segment is activated
+     * @event volume-panel-open
      * @type {CustomEvent<void>}
      */
     this.dispatchEvent(new CustomEvent('volume-panel-open'));
@@ -262,7 +262,7 @@ export class ObcSystemButton extends LitElement {
     /**
      * Fired when the system icons action segment is activated.
      *
-     * @event system-icons-panel-open - When the system icons action segment is activated
+     * @event system-icons-panel-open
      * @type {CustomEvent<void>}
      */
     this.dispatchEvent(new CustomEvent('system-icons-panel-open'));

package/src/components/tabbed-card/tabbed-card.ts

@@ -174,7 +174,8 @@ export class ObcTabbedCard extends LitElement {
   private setSelectedTab(index: number) {
     this.selectedTab = index;
     /**
-     * @fires {CustomEvent<{tab:number}>} tab-change - Fired when the selected tab changes.
+     * Fired when the selected tab changes.
+     * @fires tab-change
      */
     this.dispatchEvent(new CustomEvent('tab-change', {detail: {tab: index}}));
   }

package/src/components/toggle-button-option/toggle-button-option.ts

@@ -164,7 +164,8 @@ export class ObcToggleButtonOption extends LitElement {
   @property({type: Boolean, reflect: true}) large = false;
 
   /**
-   * @fires {CustomEvent<{value: string}>} selected - Fired when the option is clicked and not already selected.
+   * Fired when the option is clicked and not already selected.
+   * @fires selected
    */
   onClick(event: Event) {
     if (this.disabled) {

package/src/components/toggle-button-vertical-group/toggle-button-vertical-group.ts

@@ -234,7 +234,7 @@ export class ObcToggleButtonVerticalGroup extends LitElement {
        * The event detail contains the new value and the previous value:
        * `{ value: string, previousValue: string }`
        *
-       * @event value - Fired when the selected value changes.
+       * @event value
        */
       this.dispatchEvent(
         new CustomEvent('value', {
@@ -250,7 +250,7 @@ export class ObcToggleButtonVerticalGroup extends LitElement {
        * The event detail contains the new value:
        * `{ value: string }`
        *
-       * @event change - Fired when the selected value changes by user interaction.
+       * @event change
        */
       this.dispatchEvent(
         new CustomEvent('change', {

package/src/components/toggle-switch/toggle-switch.ts

@@ -157,7 +157,7 @@ export class ObcToggleSwitch extends LitElement {
    * Handles input events to change the toggle state.
    * Prevents changes if the toggle is disabled.
    * @param e {InputEvent}
-   * @fires input - Dispatched when the value of the input changes
+   * @fires input
    */
   private _tryChange(e: InputEvent) {
     if (this.disabled) {

package/src/components/top-bar/top-bar.ts

@@ -348,28 +348,32 @@ export class ObcTopBar extends LitElement {
 
   private dimmingButtonClicked() {
     /**
-     * @event dimming-button-clicked - Fired when the dimming (day/night) button is clicked.
+     * Fired when the dimming (day/night) button is clicked.
+     * @event dimming-button-clicked
      */
     this.dispatchEvent(new CustomEvent('dimming-button-clicked'));
   }
 
   private appsButtonClicked() {
     /**
-     * @event apps-button-clicked - Fired when the apps button is clicked.
+     * Fired when the apps button is clicked.
+     * @event apps-button-clicked
      */
     this.dispatchEvent(new CustomEvent('apps-button-clicked'));
   }
 
   private leftMoreButtonClicked() {
     /**
-     * @event left-more-button-clicked - Fired when the left more button is clicked.
+     * Fired when the left more button is clicked.
+     * @event left-more-button-clicked
      */
     this.dispatchEvent(new CustomEvent('left-more-button-clicked'));
   }
 
   private userButtonClicked() {
     /**
-     * @event user-button-clicked - Fired when the user/profile button is clicked.
+     * Fired when the user/profile button is clicked.
+     * @event user-button-clicked
      */
     this.dispatchEvent(new CustomEvent('user-button-clicked'));
   }

package/src/components/topbar-message-item/topbar-message-item.ts

@@ -192,7 +192,7 @@ export class ObcTopbarMessageItem extends LitElement {
     /**
      * Fired when the main message area is clicked.
      *
-     * @event message-click - Fired when the main message area is clicked.
+     * @event message-click
      */
     this.dispatchEvent(new CustomEvent('message-click'));
   }
@@ -201,7 +201,7 @@ export class ObcTopbarMessageItem extends LitElement {
     /**
      * Fired when the action button (text or icon) is clicked.
      *
-     * @event action-click - Fired when the action button (text or icon) is clicked.
+     * @event action-click
      */
     this.dispatchEvent(new CustomEvent('action-click'));
   }

package/src/integration-systems/integration-dropdown-button/integration-dropdown-button.ts

@@ -184,7 +184,7 @@ export class ObcIntegrationDropdownButton extends LitElement {
   /**
    * Handles the change event when a new option is selected. Updates the selected value and label, and dispatches a `change` event with the new selection.
    *
-   * @fires {ObcIntegrationDropdownButtonChangeEvent} change - Fired when the user selects a different option.
+   * @fires change
    */
   private changeHandler(event: Event) {
     const target = event.target as HTMLSelectElement;