shoelace/src/components/radio/radio.ts

135 wiersze
3.9 KiB
TypeScript
Czysty Zwykły widok Historia

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, state } from 'lit/decorators.js';
import { html } from 'lit';
2022-03-24 12:11:49 +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 './radio.styles';
import type { CSSResultGroup } from 'lit';
2020-07-15 21:30:37 +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 Radios allow the user to select a single option from a group.
2023-01-12 15:26:25 +00:00
* @documentation https://shoelace.style/components/radio
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
*
2022-11-10 17:27:03 +00:00
* @dependency sl-icon
*
2021-06-25 20:25:46 +00:00
* @slot - The radio's label.
2020-07-15 21:30:37 +00:00
*
2021-06-25 20:25:46 +00:00
* @event sl-blur - Emitted when the control loses focus.
* @event sl-focus - Emitted when the control gains focus.
*
2022-12-06 16:18:14 +00:00
* @csspart base - The component's base wrapper.
* @csspart control - The circular container that wraps the radio's checked state.
* @csspart control--checked - The radio control when the radio is checked.
* @csspart checked-icon - The checked icon, an `<sl-icon>` element.
* @csspart label - The container that wraps the radio's label.
2020-07-15 21:30:37 +00:00
*/
2021-03-18 13:04:23 +00:00
@customElement('sl-radio')
2022-08-17 15:37:37 +00:00
export default class SlRadio extends ShoelaceElement {
static styles: CSSResultGroup = styles;
2021-03-06 17:01:39 +00:00
@state() checked = false;
2022-03-24 12:11:49 +00:00
@state() protected hasFocus = false;
2022-12-06 16:18:14 +00:00
/** The radio's value. When selected, the radio group will receive this value. */
2022-03-24 12:11:49 +00:00
@property() value: string;
2022-12-13 14:28:12 +00:00
/** The radio's size. */
@property({ reflect: true }) size: 'small' | 'medium' | 'large' = 'medium';
2022-03-24 12:11:49 +00:00
/** Disables the radio. */
@property({ type: Boolean, reflect: true }) disabled = false;
2023-01-03 18:36:12 +00:00
connectedCallback() {
2022-03-24 12:11:49 +00:00
super.connectedCallback();
2023-01-03 20:04:07 +00:00
this.handleBlur = this.handleBlur.bind(this);
this.handleClick = this.handleClick.bind(this);
this.handleFocus = this.handleFocus.bind(this);
this.setInitialAttributes();
this.addEventListeners();
2022-08-01 16:08:31 +00:00
}
2023-01-03 20:04:07 +00:00
disconnectedCallback() {
this.removeEventListeners();
2022-03-24 12:11:49 +00:00
}
2023-01-03 20:04:07 +00:00
private addEventListeners() {
this.addEventListener('blur', this.handleBlur);
this.addEventListener('click', this.handleClick);
this.addEventListener('focus', this.handleFocus);
}
private removeEventListeners() {
this.removeEventListener('blur', this.handleBlur);
this.removeEventListener('click', this.handleClick);
this.removeEventListener('focus', this.handleFocus);
2022-08-01 16:08:31 +00:00
}
private handleBlur() {
2022-03-24 12:11:49 +00:00
this.hasFocus = false;
2022-09-16 20:21:40 +00:00
this.emit('sl-blur');
2022-03-24 12:11:49 +00:00
}
private handleClick() {
2022-03-24 12:11:49 +00:00
if (!this.disabled) {
this.checked = true;
}
}
private handleFocus() {
2022-03-24 12:11:49 +00:00
this.hasFocus = true;
2022-09-16 20:21:40 +00:00
this.emit('sl-focus');
2022-03-24 12:11:49 +00:00
}
private setInitialAttributes() {
this.setAttribute('role', 'radio');
this.setAttribute('tabindex', '-1');
2022-03-24 12:11:49 +00:00
this.setAttribute('aria-disabled', this.disabled ? 'true' : 'false');
}
2023-01-03 20:04:07 +00:00
@watch('checked')
handleCheckedChange() {
this.setAttribute('aria-checked', this.checked ? 'true' : 'false');
this.setAttribute('tabindex', this.checked ? '0' : '-1');
}
@watch('disabled', { waitUntilFirstUpdate: true })
handleDisabledChange() {
this.setAttribute('aria-disabled', this.disabled ? 'true' : 'false');
}
2020-07-15 21:30:37 +00:00
render() {
2021-02-26 14:09:13 +00:00
return html`
<span
2020-07-15 21:30:37 +00:00
part="base"
2021-02-26 14:09:13 +00:00
class=${classMap({
2020-07-15 21:30:37 +00:00
radio: true,
'radio--checked': this.checked,
'radio--disabled': this.disabled,
2022-12-13 14:28:12 +00:00
'radio--focused': this.hasFocus,
'radio--small': this.size === 'small',
'radio--medium': this.size === 'medium',
'radio--large': this.size === 'large'
2021-02-26 14:09:13 +00:00
})}
2020-07-15 21:30:37 +00:00
>
<span part="${`control${this.checked ? ' control--checked' : ''}`}" class="radio__control">
2022-12-13 14:28:12 +00:00
${this.checked
? html` <sl-icon part="checked-icon" class="radio__checked-icon" library="system" name="radio"></sl-icon> `
: ''}
2020-07-15 21:30:37 +00:00
</span>
2022-12-02 22:03:59 +00:00
<slot part="label" class="radio__label"></slot>
</span>
2021-02-26 14:09:13 +00:00
`;
2020-07-15 21:30:37 +00:00
}
}
2021-03-12 14:09:08 +00:00
declare global {
interface HTMLElementTagNameMap {
'sl-radio': SlRadio;
}
}