@esri/calcite-components
Version:
Web Components for Esri's Calcite Design System.
479 lines (478 loc) • 14.3 kB
JavaScript
import { Component, Element, h, Host, Method, Prop, Build, State } from "@stencil/core";
import { CSS, TEXT } from "./resources";
import { getElementDir } from "../../utils/dom";
/** @slot default text slot for button text */
/** Any attributes placed on <calcite-button> component will propagate to the rendered child */
/** Passing a 'href' will render an anchor link, instead of a button. Role will be set to link, or button, depending on this. */
/** It is the consumers responsibility to add aria information, rel, target, for links, and any button attributes for form submission */
export class CalciteButton {
constructor() {
//--------------------------------------------------------------------------
//
// Properties
//
//--------------------------------------------------------------------------
/** specify the appearance style of the button, defaults to solid. */
this.appearance = "solid";
/** specify the color of the button, defaults to blue */
this.color = "blue";
/** string to override English loading text */
this.intlLoading = TEXT.loading;
/** optionally specify alignment of button elements. */
this.alignment = "center";
/** optionally add a calcite-loader component to the button, disabling interaction. */
this.loading = false;
/** optionally add a round style to the button */
this.round = false;
/** specify the scale of the button, defaults to m */
this.scale = "m";
/** is the button a child of a calcite-split-button */
this.splitChild = false;
/** specify the width of the button, defaults to auto */
this.width = "auto";
/** the node type of the rendered child element */
this.childElType = "button";
/** determine if there is slotted text for styling purposes */
this.hasText = false;
//--------------------------------------------------------------------------
//
// Private Methods
//
//--------------------------------------------------------------------------
// act on a requested or nearby form based on type
this.handleClick = (e) => {
// this.type refers to type attribute, not child element type
if (this.childElType === "button" && this.type !== "button") {
const requestedForm = this.el.getAttribute("form");
const targetForm = requestedForm
? document.getElementsByName(`${requestedForm}`)[0]
: this.el.closest("form");
if (targetForm) {
const targetFormSubmitFunction = targetForm.onsubmit;
switch (this.type) {
case "submit":
if (targetFormSubmitFunction)
targetFormSubmitFunction();
else if (targetForm.checkValidity())
targetForm.submit();
else
targetForm.reportValidity();
break;
case "reset":
targetForm.reset();
break;
}
}
e.preventDefault();
}
};
}
//--------------------------------------------------------------------------
//
// Lifecycle
//
//--------------------------------------------------------------------------
connectedCallback() {
this.childElType = this.href ? "a" : "button";
this.setupTextContentObserver();
}
disconnectedCallback() {
this.observer.disconnect();
}
componentWillLoad() {
if (Build.isBrowser) {
this.updateHasText();
const elType = this.el.getAttribute("type");
this.type = this.childElType === "button" && elType ? elType : "submit";
}
}
render() {
const dir = getElementDir(this.el);
const attributes = this.getAttributes();
const Tag = this.childElType;
const loader = (h("div", { class: CSS.buttonLoader },
h("calcite-loader", { active: true, inline: true, label: this.intlLoading })));
const iconScale = this.scale === "l" ? "m" : "s";
const iconStartEl = (h("calcite-icon", { class: { [CSS.icon]: true, [CSS.iconStart]: true }, dir: dir, flipRtl: this.iconFlipRtl === "start" || this.iconFlipRtl === "both", icon: this.iconStart, scale: iconScale }));
const iconEndEl = (h("calcite-icon", { class: { [CSS.icon]: true, [CSS.iconEnd]: true }, dir: dir, flipRtl: this.iconFlipRtl === "end" || this.iconFlipRtl === "both", icon: this.iconEnd, scale: iconScale }));
const contentEl = (h("span", { class: CSS.content },
h("slot", null)));
return (h(Host, { dir: dir, hasText: this.hasText },
h(Tag, Object.assign({}, attributes, { disabled: this.disabled, onClick: this.handleClick, ref: (el) => (this.childEl = el), tabIndex: this.disabled ? -1 : null }),
this.loading ? loader : null,
this.iconStart ? iconStartEl : null,
this.hasText ? contentEl : null,
this.iconEnd ? iconEndEl : null)));
}
//--------------------------------------------------------------------------
//
// Public Methods
//
//--------------------------------------------------------------------------
async setFocus() {
this.childEl.focus();
}
updateHasText() {
this.hasText = this.el.textContent.trim().length > 0;
}
setupTextContentObserver() {
if (Build.isBrowser) {
this.observer = new MutationObserver(() => {
this.updateHasText();
});
this.observer.observe(this.el, { childList: true, subtree: true });
}
}
getAttributes() {
// spread attributes from the component to rendered child, filtering out props
const props = [
"appearance",
"color",
"dir",
"hasText",
"icon-start",
"icon-end",
"id",
"splitChild",
"loading",
"scale",
"slot",
"width",
"theme"
];
return Array.from(this.el.attributes)
.filter((a) => a && !props.includes(a.name))
.reduce((acc, { name, value }) => (Object.assign(Object.assign({}, acc), { [name]: value })), {});
}
static get is() { return "calcite-button"; }
static get encapsulation() { return "shadow"; }
static get originalStyleUrls() { return {
"$": ["calcite-button.scss"]
}; }
static get styleUrls() { return {
"$": ["calcite-button.css"]
}; }
static get properties() { return {
"appearance": {
"type": "string",
"mutable": false,
"complexType": {
"original": "ButtonAppearance",
"resolved": "\"clear\" | \"outline\" | \"solid\" | \"transparent\"",
"references": {
"ButtonAppearance": {
"location": "import",
"path": "./interfaces"
}
}
},
"required": false,
"optional": false,
"docs": {
"tags": [],
"text": "specify the appearance style of the button, defaults to solid."
},
"attribute": "appearance",
"reflect": true,
"defaultValue": "\"solid\""
},
"color": {
"type": "string",
"mutable": false,
"complexType": {
"original": "ButtonColor",
"resolved": "\"blue\" | \"dark\" | \"light\" | \"red\"",
"references": {
"ButtonColor": {
"location": "import",
"path": "./interfaces"
}
}
},
"required": false,
"optional": false,
"docs": {
"tags": [],
"text": "specify the color of the button, defaults to blue"
},
"attribute": "color",
"reflect": true,
"defaultValue": "\"blue\""
},
"disabled": {
"type": "boolean",
"mutable": false,
"complexType": {
"original": "boolean",
"resolved": "boolean",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [],
"text": "is the button disabled"
},
"attribute": "disabled",
"reflect": true
},
"href": {
"type": "string",
"mutable": false,
"complexType": {
"original": "string",
"resolved": "string",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [],
"text": "optionally pass a href - used to determine if the component should render as a button or an anchor"
},
"attribute": "href",
"reflect": true
},
"iconEnd": {
"type": "string",
"mutable": false,
"complexType": {
"original": "string",
"resolved": "string",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [],
"text": "optionally pass an icon to display at the end of a button - accepts calcite ui icon names"
},
"attribute": "icon-end",
"reflect": true
},
"iconFlipRtl": {
"type": "string",
"mutable": false,
"complexType": {
"original": "FlipContext",
"resolved": "\"both\" | \"end\" | \"start\"",
"references": {
"FlipContext": {
"location": "import",
"path": "../interfaces"
}
}
},
"required": false,
"optional": true,
"docs": {
"tags": [],
"text": "flip the icon(s) in rtl"
},
"attribute": "icon-flip-rtl",
"reflect": true
},
"iconStart": {
"type": "string",
"mutable": false,
"complexType": {
"original": "string",
"resolved": "string",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [],
"text": "optionally pass an icon to display at the start of a button - accepts calcite ui icon names"
},
"attribute": "icon-start",
"reflect": true
},
"intlLoading": {
"type": "string",
"mutable": false,
"complexType": {
"original": "string",
"resolved": "string",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [],
"text": "string to override English loading text"
},
"attribute": "intl-loading",
"reflect": false,
"defaultValue": "TEXT.loading"
},
"alignment": {
"type": "string",
"mutable": false,
"complexType": {
"original": "ButtonAlignment",
"resolved": "\"center\" | \"end\" | \"icon-end-space-between\" | \"icon-start-space-between\" | \"space-between\" | \"start\"",
"references": {
"ButtonAlignment": {
"location": "import",
"path": "./interfaces"
}
}
},
"required": false,
"optional": true,
"docs": {
"tags": [],
"text": "optionally specify alignment of button elements."
},
"attribute": "alignment",
"reflect": true,
"defaultValue": "\"center\""
},
"loading": {
"type": "boolean",
"mutable": false,
"complexType": {
"original": "boolean",
"resolved": "boolean",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [],
"text": "optionally add a calcite-loader component to the button, disabling interaction."
},
"attribute": "loading",
"reflect": true,
"defaultValue": "false"
},
"round": {
"type": "boolean",
"mutable": false,
"complexType": {
"original": "boolean",
"resolved": "boolean",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [],
"text": "optionally add a round style to the button"
},
"attribute": "round",
"reflect": true,
"defaultValue": "false"
},
"scale": {
"type": "string",
"mutable": false,
"complexType": {
"original": "Scale",
"resolved": "\"l\" | \"m\" | \"s\"",
"references": {
"Scale": {
"location": "import",
"path": "../interfaces"
}
}
},
"required": false,
"optional": false,
"docs": {
"tags": [],
"text": "specify the scale of the button, defaults to m"
},
"attribute": "scale",
"reflect": true,
"defaultValue": "\"m\""
},
"splitChild": {
"type": "any",
"mutable": false,
"complexType": {
"original": "\"primary\" | \"secondary\" | false",
"resolved": "\"primary\" | \"secondary\" | boolean",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [],
"text": "is the button a child of a calcite-split-button"
},
"attribute": "split-child",
"reflect": true,
"defaultValue": "false"
},
"theme": {
"type": "string",
"mutable": false,
"complexType": {
"original": "Theme",
"resolved": "\"dark\" | \"light\"",
"references": {
"Theme": {
"location": "import",
"path": "../interfaces"
}
}
},
"required": false,
"optional": false,
"docs": {
"tags": [],
"text": "Select theme (light or dark)"
},
"attribute": "theme",
"reflect": true
},
"width": {
"type": "string",
"mutable": false,
"complexType": {
"original": "Width",
"resolved": "\"auto\" | \"full\" | \"half\"",
"references": {
"Width": {
"location": "import",
"path": "../interfaces"
}
}
},
"required": false,
"optional": false,
"docs": {
"tags": [],
"text": "specify the width of the button, defaults to auto"
},
"attribute": "width",
"reflect": true,
"defaultValue": "\"auto\""
}
}; }
static get states() { return {
"hasText": {}
}; }
static get methods() { return {
"setFocus": {
"complexType": {
"signature": "() => Promise<void>",
"parameters": [],
"references": {
"Promise": {
"location": "global"
}
},
"return": "Promise<void>"
},
"docs": {
"text": "",
"tags": []
}
}
}; }
static get elementRef() { return "el"; }
}