Skip to content

Commit

Permalink
docs: add missing docs for expanded item state attribute (#7728) (#7732)
Browse files Browse the repository at this point in the history
Co-authored-by: Serhii Kulykov <iamkulykov@gmail.com>
  • Loading branch information
vaadin-bot and web-padawan authored Aug 30, 2024
1 parent 2372f6d commit 0d62eaa
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 10 deletions.
7 changes: 7 additions & 0 deletions packages/context-menu/src/vaadin-context-menu.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,13 @@ export interface ContextMenuEventMap extends HTMLElementEventMap, ContextMenuCus
* - `<vaadin-context-menu-item>` - has the same API as [`<vaadin-item>`](#/elements/vaadin-item).
* - `<vaadin-context-menu-list-box>` - has the same API as [`<vaadin-list-box>`](#/elements/vaadin-list-box).
*
* The `<vaadin-context-menu-item>` sub-menu elements have the following additional state attributes
* on top of the built-in `<vaadin-item>` state attributes:
*
* Attribute | Description
* ---------- |-------------
* `expanded` | Expanded parent item.
*
* Note: the `theme` attribute value set on `<vaadin-context-menu>` is
* propagated to the internal components listed above.
*
Expand Down
7 changes: 7 additions & 0 deletions packages/context-menu/src/vaadin-context-menu.js
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,13 @@ import { ContextMenuMixin } from './vaadin-context-menu-mixin.js';
* - `<vaadin-context-menu-item>` - has the same API as [`<vaadin-item>`](#/elements/vaadin-item).
* - `<vaadin-context-menu-list-box>` - has the same API as [`<vaadin-list-box>`](#/elements/vaadin-list-box).
*
* The `<vaadin-context-menu-item>` sub-menu elements have the following additional state attributes
* on top of the built-in `<vaadin-item>` state attributes:
*
* Attribute | Description
* ---------- |-------------
* `expanded` | Expanded parent item.
*
* Note: the `theme` attribute value set on `<vaadin-context-menu>` is
* propagated to the internal components listed above.
*
Expand Down
10 changes: 0 additions & 10 deletions packages/context-menu/src/vaadin-contextmenu-items-mixin.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,16 +55,6 @@ export const ItemsMixin = (superClass) =>
* ```
*
* @type {!Array<!ContextMenuItem> | undefined}
*
*
* ### Styling
*
* The `<vaadin-context-menu-item>` sub-menu elements have the following additional state attributes on top of
* the built-in `<vaadin-item>` state attributes (see `<vaadin-item>` documentation for full listing).
*
* Part name | Attribute | Description
* ----------------|----------------|----------------
* `:host` | expanded | Expanded parent item
*/
items: {
type: Array,
Expand Down
10 changes: 10 additions & 0 deletions packages/menu-bar/src/vaadin-menu-bar.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,16 @@ export interface MenuBarEventMap extends HTMLElementEventMap, MenuBarCustomEvent
* - `<vaadin-menu-bar-list-box>` - has the same API as [`<vaadin-list-box>`](#/elements/vaadin-list-box).
* - `<vaadin-menu-bar-overlay>` - has the same API as [`<vaadin-overlay>`](#/elements/vaadin-overlay).
*
* The `<vaadin-menu-bar-item>` sub-menu elements have the following additional state attributes
* on top of the built-in `<vaadin-item>` state attributes:
*
* Attribute | Description
* ---------- |-------------
* `expanded` | Expanded parent item.
*
* Note: the `theme` attribute value set on `<vaadin-menu-bar>` is
* propagated to the internal components listed above.
*
* @fires {CustomEvent} item-selected - Fired when a submenu item or menu bar button without children is clicked.
*/
declare class MenuBar extends MenuBarMixin(DisabledMixin(ElementMixin(ThemableMixin(HTMLElement)))) {
Expand Down
10 changes: 10 additions & 0 deletions packages/menu-bar/src/vaadin-menu-bar.js
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,16 @@ import { MenuBarMixin } from './vaadin-menu-bar-mixin.js';
* - `<vaadin-menu-bar-list-box>` - has the same API as [`<vaadin-list-box>`](#/elements/vaadin-list-box).
* - `<vaadin-menu-bar-overlay>` - has the same API as [`<vaadin-overlay>`](#/elements/vaadin-overlay).
*
* The `<vaadin-menu-bar-item>` sub-menu elements have the following additional state attributes
* on top of the built-in `<vaadin-item>` state attributes:
*
* Attribute | Description
* ---------- |-------------
* `expanded` | Expanded parent item.
*
* Note: the `theme` attribute value set on `<vaadin-menu-bar>` is
* propagated to the internal components listed above.
*
* @fires {CustomEvent<boolean>} item-selected - Fired when a submenu item or menu bar button without children is clicked.
*
* @customElement
Expand Down

0 comments on commit 0d62eaa

Please sign in to comment.