2023-01-13 20:43:55 +00:00
|
|
|
import '../icon/icon';
|
2021-09-29 12:40:26 +00:00
|
|
|
import { classMap } from 'lit/directives/class-map.js';
|
2023-01-13 20:43:55 +00:00
|
|
|
import { customElement, property, query } from 'lit/decorators.js';
|
2022-04-14 22:01:25 +00:00
|
|
|
import { getTextContent } from '../../internal/slot';
|
2023-01-13 20:43:55 +00:00
|
|
|
import { html } from 'lit';
|
2022-03-24 12:01:09 +00:00
|
|
|
import { watch } from '../../internal/watch';
|
2023-01-13 20:43:55 +00:00
|
|
|
import ShoelaceElement from '../../internal/shoelace-element';
|
2021-07-10 00:45:44 +00:00
|
|
|
import styles from './menu-item.styles';
|
2022-07-19 12:27:39 +00:00
|
|
|
import type { CSSResultGroup } from 'lit';
|
2021-07-12 14:36:06 +00:00
|
|
|
|
2020-07-15 21:30:37 +00:00
|
|
|
/**
|
2022-10-21 13:56:35 +00:00
|
|
|
* @summary Menu items provide options for the user to pick from in a menu.
|
2023-01-12 15:26:25 +00:00
|
|
|
* @documentation https://shoelace.style/components/menu-item
|
2020-07-15 21:30:37 +00:00
|
|
|
* @status stable
|
2023-01-12 15:26:25 +00:00
|
|
|
* @since 2.0
|
2020-07-15 21:30:37 +00:00
|
|
|
*
|
2021-02-26 14:09:13 +00:00
|
|
|
* @dependency sl-icon
|
|
|
|
*
|
2021-06-25 20:25:46 +00:00
|
|
|
* @slot - The menu item's label.
|
|
|
|
* @slot prefix - Used to prepend an icon or similar element to the menu item.
|
|
|
|
* @slot suffix - Used to append an icon or similar element to the menu item.
|
2020-07-15 21:30:37 +00:00
|
|
|
*
|
2022-12-06 16:18:14 +00:00
|
|
|
* @csspart base - The component's base wrapper.
|
2022-11-10 17:27:03 +00:00
|
|
|
* @csspart checked-icon - The checked icon, which is only visible when the menu item is checked.
|
2021-06-25 20:25:46 +00:00
|
|
|
* @csspart prefix - The prefix container.
|
|
|
|
* @csspart label - The menu item label.
|
|
|
|
* @csspart suffix - The suffix container.
|
2020-07-15 21:30:37 +00:00
|
|
|
*/
|
2021-03-18 13:04:23 +00:00
|
|
|
@customElement('sl-menu-item')
|
2022-08-17 15:37:37 +00:00
|
|
|
export default class SlMenuItem extends ShoelaceElement {
|
2022-07-19 12:27:39 +00:00
|
|
|
static styles: CSSResultGroup = styles;
|
2020-07-15 21:30:37 +00:00
|
|
|
|
2022-04-14 22:01:25 +00:00
|
|
|
private cachedTextLabel: string;
|
|
|
|
|
|
|
|
@query('slot:not([name])') defaultSlot: HTMLSlotElement;
|
2021-03-06 17:01:39 +00:00
|
|
|
@query('.menu-item') menuItem: HTMLElement;
|
|
|
|
|
2023-01-05 19:50:19 +00:00
|
|
|
/** The type of menu item to render. To use `checked`, this value must be set to `checkbox`. */
|
|
|
|
@property() type: 'normal' | 'checkbox' = 'normal';
|
|
|
|
|
2021-02-26 14:09:13 +00:00
|
|
|
/** Draws the item in a checked state. */
|
2021-07-01 00:04:46 +00:00
|
|
|
@property({ type: Boolean, reflect: true }) checked = false;
|
2020-07-15 21:30:37 +00:00
|
|
|
|
2020-12-30 18:32:42 +00:00
|
|
|
/** A unique value to store in the menu item. This can be used as a way to identify menu items when selected. */
|
2021-07-01 00:04:46 +00:00
|
|
|
@property() value = '';
|
2020-07-15 21:30:37 +00:00
|
|
|
|
2022-12-17 16:27:30 +00:00
|
|
|
/** Draws the menu item in a disabled state, preventing selection. */
|
2021-07-01 00:04:46 +00:00
|
|
|
@property({ type: Boolean, reflect: true }) disabled = false;
|
2020-08-08 19:45:32 +00:00
|
|
|
|
2023-01-03 20:04:07 +00:00
|
|
|
private handleDefaultSlotChange() {
|
|
|
|
const textLabel = this.getTextLabel();
|
|
|
|
|
|
|
|
// Ignore the first time the label is set
|
|
|
|
if (typeof this.cachedTextLabel === 'undefined') {
|
|
|
|
this.cachedTextLabel = textLabel;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
// When the label changes, emit a slotchange event so parent controls see it
|
|
|
|
if (textLabel !== this.cachedTextLabel) {
|
|
|
|
this.cachedTextLabel = textLabel;
|
|
|
|
this.emit('slotchange', { bubbles: true, composed: false, cancelable: false });
|
|
|
|
}
|
2022-04-14 22:01:25 +00:00
|
|
|
}
|
|
|
|
|
2021-07-08 21:23:47 +00:00
|
|
|
@watch('checked')
|
|
|
|
handleCheckedChange() {
|
2023-01-05 20:13:21 +00:00
|
|
|
// For proper accessibility, users have to use type="checkbox" to use the checked attribute
|
2023-01-05 19:50:19 +00:00
|
|
|
if (this.checked && this.type !== 'checkbox') {
|
|
|
|
this.checked = false;
|
|
|
|
console.error('The checked attribute can only be used on menu items with type="checkbox"', this);
|
2023-01-05 20:13:21 +00:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Only checkbox types can receive the aria-checked attribute
|
|
|
|
if (this.type === 'checkbox') {
|
|
|
|
this.setAttribute('aria-checked', this.checked ? 'true' : 'false');
|
|
|
|
} else {
|
|
|
|
this.removeAttribute('aria-checked');
|
2023-01-05 19:50:19 +00:00
|
|
|
}
|
2020-10-22 17:41:09 +00:00
|
|
|
}
|
|
|
|
|
2021-07-08 21:23:47 +00:00
|
|
|
@watch('disabled')
|
|
|
|
handleDisabledChange() {
|
2022-01-16 05:47:14 +00:00
|
|
|
this.setAttribute('aria-disabled', this.disabled ? 'true' : 'false');
|
2020-10-22 17:41:09 +00:00
|
|
|
}
|
2020-08-08 19:45:32 +00:00
|
|
|
|
2023-01-05 19:50:19 +00:00
|
|
|
@watch('type')
|
|
|
|
handleTypeChange() {
|
2023-01-05 20:13:21 +00:00
|
|
|
if (this.type === 'checkbox') {
|
|
|
|
this.setAttribute('role', 'menuitemcheckbox');
|
|
|
|
this.setAttribute('aria-checked', this.checked ? 'true' : 'false');
|
|
|
|
} else {
|
|
|
|
this.setAttribute('role', 'menuitem');
|
|
|
|
this.removeAttribute('aria-checked');
|
|
|
|
}
|
2023-01-05 19:50:19 +00:00
|
|
|
}
|
|
|
|
|
2023-01-03 20:04:07 +00:00
|
|
|
/** Returns a text label based on the contents of the menu item's default slot. */
|
|
|
|
getTextLabel() {
|
|
|
|
return getTextContent(this.defaultSlot);
|
2022-04-14 22:01:25 +00:00
|
|
|
}
|
|
|
|
|
2020-07-15 21:30:37 +00:00
|
|
|
render() {
|
2021-02-26 14:09:13 +00:00
|
|
|
return html`
|
2020-07-15 21:30:37 +00:00
|
|
|
<div
|
|
|
|
part="base"
|
2021-02-26 14:09:13 +00:00
|
|
|
class=${classMap({
|
2020-07-15 21:30:37 +00:00
|
|
|
'menu-item': true,
|
|
|
|
'menu-item--checked': this.checked,
|
2022-03-03 22:15:58 +00:00
|
|
|
'menu-item--disabled': this.disabled,
|
2022-03-04 15:08:59 +00:00
|
|
|
'menu-item--has-submenu': false // reserved for future use
|
2021-02-26 14:09:13 +00:00
|
|
|
})}
|
2020-07-15 21:30:37 +00:00
|
|
|
>
|
2022-06-21 13:37:16 +00:00
|
|
|
<span part="checked-icon" class="menu-item__check">
|
2022-11-10 17:27:03 +00:00
|
|
|
<sl-icon name="check" library="system" aria-hidden="true"></sl-icon>
|
2022-03-03 22:15:58 +00:00
|
|
|
</span>
|
2020-07-15 21:30:37 +00:00
|
|
|
|
2022-12-02 22:03:59 +00:00
|
|
|
<slot name="prefix" part="prefix" class="menu-item__prefix"></slot>
|
2020-07-15 21:30:37 +00:00
|
|
|
|
2022-12-02 22:03:59 +00:00
|
|
|
<slot part="label" class="menu-item__label" @slotchange=${this.handleDefaultSlotChange}></slot>
|
2020-07-15 21:30:37 +00:00
|
|
|
|
2022-12-02 22:03:59 +00:00
|
|
|
<slot name="suffix" part="suffix" class="menu-item__suffix"></slot>
|
2022-03-03 22:15:58 +00:00
|
|
|
|
|
|
|
<span class="menu-item__chevron">
|
2022-05-27 11:43:42 +00:00
|
|
|
<sl-icon name="chevron-right" library="system" aria-hidden="true"></sl-icon>
|
2022-03-03 22:15:58 +00:00
|
|
|
</span>
|
2020-07-15 21:30:37 +00:00
|
|
|
</div>
|
2021-02-26 14:09:13 +00:00
|
|
|
`;
|
2020-07-15 21:30:37 +00:00
|
|
|
}
|
|
|
|
}
|
2021-03-12 14:07:38 +00:00
|
|
|
|
2021-03-12 14:09:08 +00:00
|
|
|
declare global {
|
|
|
|
interface HTMLElementTagNameMap {
|
|
|
|
'sl-menu-item': SlMenuItem;
|
|
|
|
}
|
|
|
|
}
|