Skip to content

docs: add missing @fires annotations for message-input and context-menu #11303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sissbruecker merged 1 commit into from
Mar 11, 2026
Merged

docs: add missing @fires annotations for message-input and context-menu #11303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/context-menu/src/vaadin-context-menu.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,8 @@ export interface ContextMenuEventMap<TItem extends ContextMenuItem = ContextMenu
* @fires {CustomEvent} opened-changed - Fired when the `opened` property changes.
* @fires {CustomEvent} item-selected - Fired when an item is selected when the context menu is populated using the `items` API.
* @fires {CustomEvent} closed - Fired when the context menu is closed.
* @fires {CustomEvent} close-all-menus - Fired when all menus should close, e.g., after pressing Tab or on submenu close.
* @fires {CustomEvent} items-outside-click - Fired when a click happens outside any open sub-menus.
*/
declare class ContextMenu<TItem extends ContextMenuItem = ContextMenuItem> extends HTMLElement {
/**
Expand Down
2 changes: 2 additions & 0 deletions packages/context-menu/src/vaadin-context-menu.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,8 @@ import { ContextMenuMixin } from './vaadin-context-menu-mixin.js';
* @fires {CustomEvent} opened-changed - Fired when the `opened` property changes.
* @fires {CustomEvent} item-selected - Fired when an item is selected when the context menu is populated using the `items` API.
* @fires {CustomEvent} closed - Fired when the context menu is closed.
* @fires {CustomEvent} close-all-menus - Fired when all menus should close, e.g., after pressing Tab or on submenu close.
* @fires {CustomEvent} items-outside-click - Fired when a click happens outside any open sub-menus.
*
* @customElement vaadin-context-menu
* @extends HTMLElement
Expand Down
2 changes: 2 additions & 0 deletions packages/message-input/src/vaadin-message-input.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ export type MessageInputEventMap = HTMLElementEventMap & MessageInputCustomEvent
* - `<vaadin-text-area>`
*
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
*
* @fires {CustomEvent} submit - Fired when a new message is submitted, either by clicking the "send" button, or pressing the Enter key.
*/
declare class MessageInput extends MessageInputMixin(ThemableMixin(ElementMixin(HTMLElement))) {
addEventListener<K extends keyof MessageInputEventMap>(
Expand Down
2 changes: 2 additions & 0 deletions packages/message-input/src/vaadin-message-input.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ import { MessageInputMixin } from './vaadin-message-input-mixin.js';
*
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
*
* @fires {CustomEvent} submit - Fired when a new message is submitted, either by clicking the "send" button, or pressing the Enter key.
*
* @customElement vaadin-message-input
* @extends HTMLElement
* @mixes MessageInputMixin
Expand Down