/**
* @license
* Copyright 2018 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import '../../focus/md-focus-ring.js';
import '../../ripple/ripple.js';
import {html, isServer, LitElement, nothing} from 'lit';
import {property, state} from 'lit/decorators.js';
import {classMap} from 'lit/directives/class-map.js';
import {literal, html as staticHtml} from 'lit/static-html.js';
import {ARIAMixinStrict} from '../../internal/aria/aria.js';
import {mixinDelegatesAria} from '../../internal/aria/delegate.js';
import {
FormSubmitter,
setupFormSubmitter,
type FormSubmitterType,
} from '../../internal/controller/form-submitter.js';
import {isRtl} from '../../internal/controller/is-rtl.js';
import {
internals,
mixinElementInternals,
} from '../../labs/behaviors/element-internals.js';
type LinkTarget = '_blank' | '_parent' | '_self' | '_top';
// Separate variable needed for closure.
const iconButtonBaseClass = mixinDelegatesAria(
mixinElementInternals(LitElement),
);
/**
* A button for rendering icons.
*
* @fires input {InputEvent} Dispatched when a toggle button toggles --bubbles
* --composed
* @fires change {Event} Dispatched when a toggle button toggles --bubbles
*/
export class IconButton extends iconButtonBaseClass implements FormSubmitter {
static {
setupFormSubmitter(IconButton);
}
/** @nocollapse */
static readonly formAssociated = true;
/** @nocollapse */
static override shadowRootOptions: ShadowRootInit = {
mode: 'open',
delegatesFocus: true,
};
/**
* Disables the icon button and makes it non-interactive.
*/
@property({type: Boolean, reflect: true}) disabled = false;
/**
* "Soft-disables" the icon button (disabled but still focusable).
*
* Use this when an icon button needs increased visibility when disabled. See
* https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#kbd_disabled_controls
* for more guidance on when this is needed.
*/
@property({type: Boolean, attribute: 'soft-disabled', reflect: true})
softDisabled = false;
/**
* Flips the icon if it is in an RTL context at startup.
*/
@property({type: Boolean, attribute: 'flip-icon-in-rtl'})
flipIconInRtl = false;
/**
* Sets the underlying `HTMLAnchorElement`'s `href` resource attribute.
*/
@property() href = '';
/**
* The filename to use when downloading the linked resource.
* If not specified, the browser will determine a filename.
* This is only applicable when the icon button is used as a link (`href` is set).
*/
@property() download = '';
/**
* Sets the underlying `HTMLAnchorElement`'s `target` attribute.
*/
@property() target: LinkTarget | '' = '';
/**
* The `aria-label` of the button when the button is toggleable and selected.
*/
@property({attribute: 'aria-label-selected'}) ariaLabelSelected = '';
/**
* When true, the button will toggle between selected and unselected
* states
*/
@property({type: Boolean}) toggle = false;
/**
* Sets the selected state. When false, displays the default icon. When true,
* displays the selected icon, or the default icon If no `slot="selected"`
* icon is provided.
*/
@property({type: Boolean, reflect: true}) selected = false;
/**
* The default behavior of the button. May be "button", "reset", or "submit"
* (default).
*/
@property() type: FormSubmitterType = 'submit';
/**
* The value added to a form with the button's name when the button submits a
* form.
*/
@property({reflect: true}) value = '';
get name() {
return this.getAttribute('name') ?? '';
}
set name(name: string) {
this.setAttribute('name', name);
}
/**
* The associated form element with which this element's value will submit.
*/
get form() {
return this[internals].form;
}
/**
* The labels this element is associated with.
*/
get labels() {
return this[internals].labels;
}
@state() private flipIcon = isRtl(this, this.flipIconInRtl);
constructor() {
super();
if (!isServer) {
this.addEventListener('click', this.handleClick.bind(this));
}
}
protected override willUpdate() {
// Link buttons cannot be disabled or soft-disabled.
if (this.href) {
this.disabled = false;
this.softDisabled = false;
}
}
protected override render() {
const tag = this.href ? literal`div` : literal`button`;
// Needed for closure conformance
const {ariaLabel, ariaHasPopup, ariaExpanded} = this as ARIAMixinStrict;
const hasToggledAriaLabel = ariaLabel && this.ariaLabelSelected;
const ariaPressedValue = !this.toggle ? nothing : this.selected;
let ariaLabelValue: string | null | typeof nothing = nothing;
if (!this.href) {
ariaLabelValue =
hasToggledAriaLabel && this.selected
? this.ariaLabelSelected
: ariaLabel;
}
return staticHtml`<${tag}
class="icon-button ${classMap(this.getRenderClasses())}"
id="button"
aria-label="${ariaLabelValue || nothing}"
aria-haspopup="${(!this.href && ariaHasPopup) || nothing}"
aria-expanded="${(!this.href && ariaExpanded) || nothing}"
aria-pressed="${ariaPressedValue}"
aria-disabled=${(!this.href && this.softDisabled) || nothing}
?disabled="${!this.href && this.disabled}"
@click="${this.handleClickOnChild}">
${this.renderFocusRing()}
${this.renderRipple()}
${!this.selected ? this.renderIcon() : nothing}
${this.selected ? this.renderSelectedIcon() : nothing}
${this.href ? this.renderLink() : this.renderTouchTarget()}
${tag}>`;
}
private renderLink() {
// Needed for closure conformance
const {ariaLabel} = this as ARIAMixinStrict;
return html`
${this.renderTouchTarget()}
`;
}
protected getRenderClasses() {
return {
'flip-icon': this.flipIcon,
'selected': this.toggle && this.selected,
};
}
private renderIcon() {
return html`