shoelace/src/components/button-group/button-group.ts

98 wiersze
3.3 KiB
TypeScript
Czysty Zwykły widok Historia

2022-08-02 17:03:47 +00:00
import { customElement, property, query, state } from 'lit/decorators.js';
2023-01-13 20:43:55 +00:00
import { html } from 'lit';
2022-08-17 15:37:37 +00:00
import ShoelaceElement from '../../internal/shoelace-element';
2021-07-10 00:45:44 +00:00
import styles from './button-group.styles';
import type { CSSResultGroup } from 'lit';
2020-08-06 13:07:24 +00:00
/**
Enrich components `@summary` with description from docs (#962) * keep header styles with repositioned description text * `animated-image` move description to component * code style * `avatar` add summary from docs * `badge` add summary from docs * `breadcrumb` add summary from docs * `button` add summary from docs * lead sentence is now part of the header * `button-group` add summary from docs * `card` add summary from docs * `checkbox` add summary from docs * `color-picker` add summary from docs * `details` add summary from docs * `dialog` add summary from docs * `divider` add summary from docs * `drawer` add summary from docs * `dropdown` add summary from docs * `format-bytes` add summary from docs * `format-date` add summary from docs * `format-number` add summary from docs * `icon` add summary from docs * `icon-button` add summary from docs * `image-comparer` add summary from docs * `include` add summary from docs * `input` add summary from docs * `menu` add summary from docs * `menu-item` add summary from docs * `menu-label` add summary from docs * `popup` add summary from docs * `progressbar` add summary from docs * `progress-ring` add summary from docs * `radio` add summary from docs * `radio-button` add summary from docs * `range` add summary from docs * `rating` add summary from docs * `relative-time` add summary from docs * `select` add summary from docs * `skeleton` add summary from docs * `spinner` add summary from docs * `split-panel` add summary from docs * `switch` add summary from docs * `tab-group` add summary from docs * `tag` add summary from docs * `textarea` add summary from docs * `tooltip` add summary from docs * `visually-hidden` add summary from docs * `animation` add summary from docs * `breadcrumb-item` add summary from docs * `mutation-observer` add summary from docs * `radio-group` add summary from docs * `resize-observer` add summary from docs * `tab` add summary from docs * `tab-panel` add summary from docs * `tree` add summary from docs * `tree-item` add summary from docs * remove `title` for further usage of `Sl` classnames in docs * revert: use markdown parser for component summary
2022-10-21 13:56:35 +00:00
* @summary Button groups can be used to group related buttons into sections.
2023-01-12 15:26:25 +00:00
* @documentation https://shoelace.style/components/button-group
2020-08-06 13:07:24 +00:00
* @status stable
2023-01-12 15:26:25 +00:00
* @since 2.0
2020-08-06 13:07:24 +00:00
*
2021-06-25 20:25:46 +00:00
* @slot - One or more `<sl-button>` elements to display in the button group.
2020-08-06 13:07:24 +00:00
*
2022-12-06 16:18:14 +00:00
* @csspart base - The component's base wrapper.
2020-08-06 13:07:24 +00:00
*/
2021-03-18 13:04:23 +00:00
@customElement('sl-button-group')
2022-08-17 15:37:37 +00:00
export default class SlButtonGroup extends ShoelaceElement {
static styles: CSSResultGroup = styles;
2020-08-06 13:07:24 +00:00
@query('slot') defaultSlot: HTMLSlotElement;
2022-08-02 17:03:47 +00:00
@state() disableRole = false;
2022-12-06 16:18:14 +00:00
/**
* A label to use for the button group. This won't be displayed on the screen, but it will be announced by assistive
* devices when interacting with the control and is strongly recommended.
*/
2021-07-01 00:04:46 +00:00
@property() label = '';
2020-08-06 13:07:24 +00:00
2023-01-03 20:04:07 +00:00
private handleFocus(event: CustomEvent) {
const button = findButton(event.target as HTMLElement);
button?.classList.add('sl-button-group__button--focus');
2020-08-06 13:07:24 +00:00
}
2023-01-03 20:04:07 +00:00
private handleBlur(event: CustomEvent) {
const button = findButton(event.target as HTMLElement);
button?.classList.remove('sl-button-group__button--focus');
}
2023-01-03 20:04:07 +00:00
private handleMouseOver(event: CustomEvent) {
const button = findButton(event.target as HTMLElement);
button?.classList.add('sl-button-group__button--hover');
}
2023-01-03 20:04:07 +00:00
private handleMouseOut(event: CustomEvent) {
const button = findButton(event.target as HTMLElement);
button?.classList.remove('sl-button-group__button--hover');
}
2023-01-03 20:04:07 +00:00
private handleSlotChange() {
const slottedElements = [...this.defaultSlot.assignedElements({ flatten: true })] as HTMLElement[];
slottedElements.forEach(el => {
const index = slottedElements.indexOf(el);
const button = findButton(el);
if (button !== null) {
button.classList.add('sl-button-group__button');
button.classList.toggle('sl-button-group__button--first', index === 0);
button.classList.toggle('sl-button-group__button--inner', index > 0 && index < slottedElements.length - 1);
button.classList.toggle('sl-button-group__button--last', index === slottedElements.length - 1);
2022-07-06 13:48:30 +00:00
button.classList.toggle('sl-button-group__button--radio', button.tagName.toLowerCase() === 'sl-radio-button');
}
});
2020-08-06 13:07:24 +00:00
}
render() {
2022-12-02 22:03:59 +00:00
// eslint-disable-next-line lit-a11y/mouse-events-have-key-events
2021-02-26 14:09:13 +00:00
return html`
2022-12-02 22:03:59 +00:00
<slot
2021-02-26 14:09:13 +00:00
part="base"
class="button-group"
2022-08-02 17:03:47 +00:00
role="${this.disableRole ? 'presentation' : 'group'}"
2021-02-26 14:09:13 +00:00
aria-label=${this.label}
2021-03-06 17:01:39 +00:00
@focusout=${this.handleBlur}
@focusin=${this.handleFocus}
@mouseover=${this.handleMouseOver}
@mouseout=${this.handleMouseOut}
2022-12-02 22:03:59 +00:00
@slotchange=${this.handleSlotChange}
></slot>
2021-02-26 14:09:13 +00:00
`;
2020-08-06 13:07:24 +00:00
}
}
function findButton(el: HTMLElement) {
const selector = 'sl-button, sl-radio-button';
// The button could be the target element or a child of it (e.g. a dropdown or tooltip anchor)
return el.closest(selector) ?? el.querySelector(selector);
}
2021-03-12 14:09:08 +00:00
declare global {
interface HTMLElementTagNameMap {
'sl-button-group': SlButtonGroup;
}
}