@esri/calcite-components
Version:
Web Components for Esri's Calcite Design System.
298 lines (297 loc) • 8.62 kB
JavaScript
/*!
* All material copyright ESRI, All Rights Reserved, unless otherwise specified.
* See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
*/
import { Component, h, Prop, Event, Element, Method } from "@stencil/core";
import { getSlotted } from "../../utils/dom";
import { guid } from "../../utils/guid";
import { CSS, TEXT, SLOTS, ICONS } from "./resources";
import { connectConditionalSlotComponent, disconnectConditionalSlotComponent } from "../../utils/conditionalSlot";
/**
* @slot - A slot for adding text.
* @slot image - A slot for adding an image.
*/
export class Chip {
constructor() {
//--------------------------------------------------------------------------
//
// Public 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 = "grey";
/** Optionally show a button the user can click to dismiss the chip */
this.dismissible = false;
/** Aria label for the "x" button
* @default "Close"
*/
this.dismissLabel = TEXT.close;
/** flip the icon in rtl */
this.iconFlipRtl = false;
/** specify the scale of the chip, defaults to m */
this.scale = "m";
// --------------------------------------------------------------------------
//
// Private Methods
//
// --------------------------------------------------------------------------
this.closeClickHandler = (event) => {
event.preventDefault();
this.calciteChipDismiss.emit(this.el);
};
this.guid = guid();
}
// --------------------------------------------------------------------------
//
// Lifecycle
//
// --------------------------------------------------------------------------
connectedCallback() {
connectConditionalSlotComponent(this);
}
disconnectedCallback() {
disconnectConditionalSlotComponent(this);
}
//--------------------------------------------------------------------------
//
// Public Methods
//
//--------------------------------------------------------------------------
/** Sets focus on the component. */
async setFocus() {
var _a;
(_a = this.closeButton) === null || _a === void 0 ? void 0 : _a.focus();
}
//--------------------------------------------------------------------------
//
// Render Methods
//
//--------------------------------------------------------------------------
renderChipImage() {
const { el } = this;
const hasChipImage = getSlotted(el, SLOTS.image);
return hasChipImage ? (h("div", { class: CSS.chipImageContainer, key: "image" },
h("slot", { name: SLOTS.image }))) : null;
}
render() {
const iconEl = (h("calcite-icon", { class: CSS.calciteChipIcon, flipRtl: this.iconFlipRtl, icon: this.icon, scale: "s" }));
const closeButton = (h("button", { "aria-describedby": this.guid, "aria-label": this.dismissLabel, class: CSS.close, onClick: this.closeClickHandler, ref: (el) => (this.closeButton = el) },
h("calcite-icon", { icon: ICONS.close, scale: "s" })));
return (h("div", { class: "container" },
this.renderChipImage(),
this.icon ? iconEl : null,
h("span", { class: CSS.title, id: this.guid },
h("slot", null)),
this.dismissible ? closeButton : null));
}
static get is() { return "calcite-chip"; }
static get encapsulation() { return "shadow"; }
static get originalStyleUrls() { return {
"$": ["chip.scss"]
}; }
static get styleUrls() { return {
"$": ["chip.css"]
}; }
static get properties() { return {
"appearance": {
"type": "string",
"mutable": false,
"complexType": {
"original": "Extract<\"solid\" | \"clear\", Appearance>",
"resolved": "\"clear\" | \"solid\"",
"references": {
"Extract": {
"location": "global"
},
"Appearance": {
"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": "ChipColor",
"resolved": "\"blue\" | \"green\" | \"grey\" | \"red\" | \"yellow\"",
"references": {
"ChipColor": {
"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": "\"grey\""
},
"dismissible": {
"type": "boolean",
"mutable": false,
"complexType": {
"original": "boolean",
"resolved": "boolean",
"references": {}
},
"required": false,
"optional": false,
"docs": {
"tags": [],
"text": "Optionally show a button the user can click to dismiss the chip"
},
"attribute": "dismissible",
"reflect": true,
"defaultValue": "false"
},
"dismissLabel": {
"type": "string",
"mutable": false,
"complexType": {
"original": "string",
"resolved": "string",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [{
"name": "default",
"text": "\"Close\""
}],
"text": "Aria label for the \"x\" button"
},
"attribute": "dismiss-label",
"reflect": false,
"defaultValue": "TEXT.close"
},
"icon": {
"type": "string",
"mutable": false,
"complexType": {
"original": "string",
"resolved": "string",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [],
"text": "optionally pass an icon to display - accepts Calcite UI icon names"
},
"attribute": "icon",
"reflect": true
},
"iconFlipRtl": {
"type": "boolean",
"mutable": false,
"complexType": {
"original": "boolean",
"resolved": "boolean",
"references": {}
},
"required": false,
"optional": false,
"docs": {
"tags": [],
"text": "flip the icon in rtl"
},
"attribute": "icon-flip-rtl",
"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 chip, defaults to m"
},
"attribute": "scale",
"reflect": true,
"defaultValue": "\"m\""
},
"value": {
"type": "any",
"mutable": false,
"complexType": {
"original": "any",
"resolved": "any",
"references": {}
},
"required": true,
"optional": false,
"docs": {
"tags": [],
"text": "The assigned value for the chip"
},
"attribute": "value",
"reflect": false
}
}; }
static get events() { return [{
"method": "calciteChipDismiss",
"name": "calciteChipDismiss",
"bubbles": true,
"cancelable": true,
"composed": true,
"docs": {
"tags": [],
"text": "Emitted when the dismiss button is clicked"
},
"complexType": {
"original": "any",
"resolved": "any",
"references": {}
}
}]; }
static get methods() { return {
"setFocus": {
"complexType": {
"signature": "() => Promise<void>",
"parameters": [],
"references": {
"Promise": {
"location": "global"
}
},
"return": "Promise<void>"
},
"docs": {
"text": "Sets focus on the component.",
"tags": []
}
}
}; }
static get elementRef() { return "el"; }
}