calcite-rating.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  1. /*!
  2. * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  3. * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
  4. * v1.0.0-beta.97
  5. */
  6. import { proxyCustomElement, HTMLElement, createEvent, h, Fragment } from '@stencil/core/internal/client/index.js';
  7. import { g as guid } from './guid.js';
  8. import { c as connectLabel, d as disconnectLabel } from './label2.js';
  9. import { c as connectForm, d as disconnectForm, H as HiddenFormInputSlot } from './form.js';
  10. import { u as updateHostInteraction } from './interactive.js';
  11. import { i as isActivationKey } from './key.js';
  12. import { d as defineCustomElement$3 } from './chip.js';
  13. import { d as defineCustomElement$2 } from './icon.js';
  14. const TEXT = {
  15. rating: "Rating",
  16. stars: "Stars: ${num}"
  17. };
  18. const ratingCss = "@keyframes in{0%{opacity:0}100%{opacity:1}}@keyframes in-down{0%{opacity:0;transform:translate3D(0, -5px, 0)}100%{opacity:1;transform:translate3D(0, 0, 0)}}@keyframes in-up{0%{opacity:0;transform:translate3D(0, 5px, 0)}100%{opacity:1;transform:translate3D(0, 0, 0)}}@keyframes in-scale{0%{opacity:0;transform:scale3D(0.95, 0.95, 1)}100%{opacity:1;transform:scale3D(1, 1, 1)}}:root{--calcite-animation-timing:calc(150ms * var(--calcite-internal-duration-factor));--calcite-internal-duration-factor:var(--calcite-duration-factor, 1);--calcite-internal-animation-timing-fast:calc(100ms * var(--calcite-internal-duration-factor));--calcite-internal-animation-timing-medium:calc(200ms * var(--calcite-internal-duration-factor));--calcite-internal-animation-timing-slow:calc(300ms * var(--calcite-internal-duration-factor))}.calcite-animate{opacity:0;animation-fill-mode:both;animation-duration:var(--calcite-animation-timing)}.calcite-animate__in{animation-name:in}.calcite-animate__in-down{animation-name:in-down}.calcite-animate__in-up{animation-name:in-up}.calcite-animate__in-scale{animation-name:in-scale}@media (prefers-reduced-motion: reduce){:root{--calcite-internal-duration-factor:0.01}}:root{--calcite-floating-ui-transition:var(--calcite-animation-timing)}:host([hidden]){display:none}:host([disabled]){pointer-events:none;cursor:default;-webkit-user-select:none;user-select:none;opacity:var(--calcite-ui-opacity-disabled)}:host{position:relative;display:flex;align-items:center;inline-size:-moz-fit-content;inline-size:fit-content}:host([disabled]) ::slotted([calcite-hydrated][disabled]),:host([disabled]) [calcite-hydrated][disabled]{opacity:1}:host([scale=s]){block-size:1.5rem;--calcite-rating-spacing-unit:0.25rem}:host([scale=m]){block-size:2rem;--calcite-rating-spacing-unit:0.5rem}:host([scale=l]){block-size:2.75rem;--calcite-rating-spacing-unit:0.75rem}:host([read-only]){pointer-events:none}.fieldset{margin:0px;display:flex;border-width:0px;padding:0px}.wrapper{display:inline-block;margin-inline-end:var(--calcite-rating-spacing-unit)}.star{position:relative;display:flex;cursor:pointer;outline-color:transparent;transition:all var(--calcite-animation-timing) ease-in-out 0s, outline 0s, outline-offset 0s;color:var(--calcite-ui-border-input)}.focused{outline:2px solid var(--calcite-ui-brand);outline-offset:2px}.average,.fraction{color:var(--calcite-ui-warning)}.hovered,.selected,:host([read-only]) .average,:host([read-only]) .fraction{color:var(--calcite-ui-brand)}:host .fraction{pointer-events:none;position:absolute;inset-block-start:0px;overflow:hidden;transition:all var(--calcite-animation-timing) ease-in-out 0s, outline 0s, outline-offset 0s;inset-inline-start:0}calcite-chip{pointer-events:none;cursor:default}.number--average{font-weight:var(--calcite-font-weight-bold)}.number--count{color:var(--calcite-ui-text-2);font-style:italic}.number--count:not(:first-child){margin-inline-start:var(--calcite-rating-spacing-unit)}.visually-hidden{position:absolute;inline-size:1px;block-size:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;border-width:0}::slotted(input[slot=hidden-form-input]){margin:0 !important;opacity:0 !important;outline:none !important;padding:0 !important;position:absolute !important;inset:0 !important;transform:none !important;-webkit-appearance:none !important;z-index:-1 !important}";
  19. const Rating = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
  20. constructor() {
  21. super();
  22. this.__registerHost();
  23. this.__attachShadow();
  24. this.calciteRatingChange = createEvent(this, "calciteRatingChange", 6);
  25. // --------------------------------------------------------------------------
  26. //
  27. // Properties
  28. //
  29. // --------------------------------------------------------------------------
  30. /** Specifies the size of the component. */
  31. this.scale = "m";
  32. /** The component's value. */
  33. this.value = 0;
  34. /** When `true`, the component's value can be read, but cannot be modified. */
  35. this.readOnly = false;
  36. /** When `true`, interaction is prevented and the component is displayed with lower opacity. */
  37. this.disabled = false;
  38. /** When `true`, and if available, displays the `average` and/or `count` data summary in a `calcite-chip`. */
  39. this.showChip = false;
  40. /**
  41. * Accessible name for the component.
  42. *
  43. * @default "Rating"
  44. */
  45. this.intlRating = TEXT.rating;
  46. /**
  47. * Accessible name for each star. The `${num}` in the string will be replaced by the number.
  48. *
  49. * @default "Stars: ${num}"
  50. */
  51. this.intlStars = TEXT.stars;
  52. /**
  53. * When `true`, the component must have a value in order for the form to submit.
  54. *
  55. * @internal
  56. */
  57. this.required = false;
  58. this.onKeyboardPressed = (event) => {
  59. if (!this.required && isActivationKey(event.key)) {
  60. event.preventDefault();
  61. this.updateValue(0);
  62. }
  63. };
  64. this.onFocusChange = (selectedRatingValue) => {
  65. this.hasFocus = true;
  66. if (!this.required && this.focusValue === selectedRatingValue) {
  67. this.updateValue(0);
  68. }
  69. else {
  70. this.focusValue = selectedRatingValue;
  71. }
  72. };
  73. this.guid = `calcite-ratings-${guid()}`;
  74. }
  75. //--------------------------------------------------------------------------
  76. //
  77. // Lifecycle
  78. //
  79. //--------------------------------------------------------------------------
  80. connectedCallback() {
  81. connectLabel(this);
  82. connectForm(this);
  83. }
  84. disconnectedCallback() {
  85. disconnectLabel(this);
  86. disconnectForm(this);
  87. }
  88. componentDidRender() {
  89. updateHostInteraction(this);
  90. }
  91. //--------------------------------------------------------------------------
  92. //
  93. // Event Listeners
  94. //
  95. //--------------------------------------------------------------------------
  96. blurHandler() {
  97. this.hasFocus = false;
  98. }
  99. // --------------------------------------------------------------------------
  100. //
  101. // Render Methods
  102. //
  103. // --------------------------------------------------------------------------
  104. renderStars() {
  105. return [1, 2, 3, 4, 5].map((i) => {
  106. const selected = this.value >= i;
  107. const average = this.average && !this.value && i <= this.average;
  108. const hovered = i <= this.hoverValue;
  109. const fraction = this.average && this.average + 1 - i;
  110. const partial = !this.value && !hovered && fraction > 0 && fraction < 1;
  111. const focused = this.hasFocus && this.focusValue === i;
  112. return (h("span", { class: { wrapper: true } }, h("label", { class: { star: true, focused, selected, average, hovered, partial }, htmlFor: `${this.guid}-${i}`, onPointerOver: () => {
  113. this.hoverValue = i;
  114. } }, h("calcite-icon", { "aria-hidden": "true", class: "icon", icon: selected || average || this.readOnly ? "star-f" : "star", scale: this.scale }), partial && (h("div", { class: "fraction", style: { width: `${fraction * 100}%` } }, h("calcite-icon", { icon: "star-f", scale: this.scale }))), h("span", { class: "visually-hidden" }, this.intlStars.replace("${num}", `${i}`))), h("input", { checked: i === this.value, class: "visually-hidden", disabled: this.disabled || this.readOnly, id: `${this.guid}-${i}`, name: this.guid, onChange: () => this.updateValue(i), onClick: (event) =>
  115. // click is fired from the component's label, so we treat this as an internal event
  116. event.stopPropagation(), onFocus: () => this.onFocusChange(i), onKeyDown: this.onKeyboardPressed, ref: (el) => (i === 1 || i === this.value) && (this.inputFocusRef = el), type: "radio", value: i })));
  117. });
  118. }
  119. render() {
  120. const { disabled, intlRating, showChip, scale, count, average } = this;
  121. return (h(Fragment, null, h("fieldset", { class: "fieldset", disabled: disabled, onBlur: () => (this.hoverValue = null), onPointerLeave: () => (this.hoverValue = null), onTouchEnd: () => (this.hoverValue = null) }, h("legend", { class: "visually-hidden" }, intlRating), this.renderStars()), (count || average) && showChip ? (h("calcite-chip", { scale: scale, value: count === null || count === void 0 ? void 0 : count.toString() }, !!average && h("span", { class: "number--average" }, average.toString()), !!count && h("span", { class: "number--count" }, "(", count === null || count === void 0 ? void 0 :
  122. count.toString(), ")"))) : null, h(HiddenFormInputSlot, { component: this })));
  123. }
  124. //--------------------------------------------------------------------------
  125. //
  126. // Private Methods
  127. //
  128. //--------------------------------------------------------------------------
  129. onLabelClick() {
  130. this.setFocus();
  131. }
  132. updateValue(value) {
  133. this.value = value;
  134. this.calciteRatingChange.emit({ value });
  135. }
  136. //--------------------------------------------------------------------------
  137. //
  138. // Public Methods
  139. //
  140. //--------------------------------------------------------------------------
  141. /** Sets focus on the component. */
  142. async setFocus() {
  143. var _a;
  144. (_a = this.inputFocusRef) === null || _a === void 0 ? void 0 : _a.focus();
  145. }
  146. get el() { return this; }
  147. static get style() { return ratingCss; }
  148. }, [1, "calcite-rating", {
  149. "scale": [513],
  150. "value": [1538],
  151. "readOnly": [516, "read-only"],
  152. "disabled": [516],
  153. "showChip": [516, "show-chip"],
  154. "count": [514],
  155. "average": [514],
  156. "name": [513],
  157. "intlRating": [1, "intl-rating"],
  158. "intlStars": [1, "intl-stars"],
  159. "required": [516],
  160. "hoverValue": [32],
  161. "focusValue": [32],
  162. "hasFocus": [32],
  163. "setFocus": [64]
  164. }, [[0, "blur", "blurHandler"]]]);
  165. function defineCustomElement$1() {
  166. if (typeof customElements === "undefined") {
  167. return;
  168. }
  169. const components = ["calcite-rating", "calcite-chip", "calcite-icon"];
  170. components.forEach(tagName => { switch (tagName) {
  171. case "calcite-rating":
  172. if (!customElements.get(tagName)) {
  173. customElements.define(tagName, Rating);
  174. }
  175. break;
  176. case "calcite-chip":
  177. if (!customElements.get(tagName)) {
  178. defineCustomElement$3();
  179. }
  180. break;
  181. case "calcite-icon":
  182. if (!customElements.get(tagName)) {
  183. defineCustomElement$2();
  184. }
  185. break;
  186. } });
  187. }
  188. defineCustomElement$1();
  189. const CalciteRating = Rating;
  190. const defineCustomElement = defineCustomElement$1;
  191. export { CalciteRating, defineCustomElement };