js/webawesome
1
0
Fork 0
mirror of https://github.com/shoelace-style/webawesome.git synced 2026-01-12 20:19:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

update jsdoc

Browse Source
This commit is contained in:
Cory LaViska
2025-06-06 12:12:28 -04:00
parent cce451c084
commit 4f44369735
2 changed files with 38 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
packages/webawesome/src/components/dropdown-item/dropdown-item.ts
View File

@@ -7,15 +7,28 @@ import WebAwesomeElement from '../../internal/webawesome-element.js';
import styles from './dropdown-item.css';
/**
* @summary Short summary of the component's intended use.
* @summary Represents an individual item within a dropdown menu, supporting standard items, checkboxes, and submenus.
* @documentation https://backers.webawesome.com/docs/components/dropdown-item
* @status experimental
* @since 3.0
*
* @dependency wa-example
* @dependency wa-icon
*
* @slot - TODO - description here
* @event blur - Emitted when the dropdown item loses focus.
* @event focus - Emitted when the dropdown item gains focus.
* @event submenu-opening - Emitted when the item is about to open its submenu.
*
* @slot - The dropdown item's label.
* @slot icon - An optional icon to display before the label.
* @slot details - Additional content or details to display after the label.
* @slot submenu - Submenu items, typically <wa-dropdown-item> elements, to create a nested menu.
*
* @csspart checkmark - The checkmark icon (a <wa-icon> element) when the item is a checkbox.
* @csspart icon - The container for the icon slot.
* @csspart label - The container for the label slot.
* @csspart details - The container for the details slot.
* @csspart submenu-icon - The submenu indicator icon (a <wa-icon> element).
* @csspart submenu - The submenu container.
*/
@customElement('wa-dropdown-item')
export default class WaDropdownItem extends WebAwesomeElement {

25
packages/webawesome/src/components/dropdown/dropdown.ts
View File

@@ -19,16 +19,35 @@ import styles from './dropdown.css';
const openDropdowns = new Set<WaDropdown>();
/**
* @summary TODO - short summary of the component's intended use.
* @summary Dropdowns display a list of options that can be triggered by a button or other element. They support
* keyboard navigation, submenus, and various customization options.
* @documentation https://backers.webawesome.com/docs/components/dropdown
* @status stable
* @since 2.0
*
* @dependency wa-dropdown-item
*
* @slot - TODO - description here
* @event wa-show - Emitted when the dropdown is about to show.
* @event wa-after-show - Emitted after the dropdown has been shown.
* @event wa-hide - Emitted when the dropdown is about to hide.
* @event wa-after-hide - Emitted after the dropdown has been hidden.
* @event wa-select - Emitted when an item in the dropdown is selected.
*
* @csspart base - The component's base wrapper.
* @slot - The dropdown's items, typically <wa-dropdown-item> elements.
* @slot trigger - The element that triggers the dropdown, such as a <wa-button> or <button>.
*
* @csspart base - The component's host element.
* @csspart menu - The dropdown menu container.
*
* @cssproperty --show-duration - The duration of the show animation.
* @cssproperty --hide-duration - The duration of the hide animation.
* @cssproperty --menu-background-color - The background color of the dropdown menu.
* @cssproperty --menu-border-color - The border color of the dropdown menu.
* @cssproperty --menu-border-width - The border width of the dropdown menu.
* @cssproperty --menu-border-radius - The border radius of the dropdown menu.
* @cssproperty --menu-box-shadow - The box shadow of the dropdown menu.
* @cssproperty --menu-text-color - The text color of the dropdown menu items.
* @cssproperty --menu-padding - The padding of the dropdown menu.
*/
@customElement('wa-dropdown')
export default class WaDropdown extends WebAwesomeElement {